PEC-Developer/Current/SCAPI/AgentNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:13Z

Jumunn: Published

2022-03-02T14:02:22Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:31:50Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:44:51Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

2020-06-08T18:58:43Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Agent namespace
|TocName=Agent namespace
|Context=Learn about the Agent namespace methods and type definitions in the Service Client API.
|ComingSoon=No
|Platform=PureEngage
|Prereq=
|Section={{Section
|sectionHeading=Methods
|anchor=Methods
|alignment=Vertical
|Media=
|image=
|structuredtext=The Agent namespace includes the following methods:

*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=get|display text=get}}
*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=getState|display text=getState}}
*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=getStateList|display text=getStateList}}
*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=setState|display text=setState}}

===get===
{{{!}}
!Signature
{{!}}<static> get() → {{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}}
{{!}}-
!Description
{{!}}Gets the agent's attributes.
{{!}}-
!Returns
{{!}}{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}
{{!}}}

===getState===
{{{!}}
!Signature
{{!}}<static> getState() → {{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}}
{{!}}-
!Description
{{!}}Gets the agent's state.
{{!}}-
!Returns
{{!}}{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}
{{!}}}

===getStateList===
{{{!}}
!Signature
{{!}}<static> getStateList() → {Array.<{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}>}
{{!}}-
!Description
{{!}}Gets the list of possible agent states.
{{!}}-
!Returns
{{!}}Array.<{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}>
{{!}}}

===setState===
{{{!}}
!Signature
{{!}}<static> setState(''stateOperationName'')
{{!}}-
!Description
{{!}}Sets the agent's state.
{{!}}-
!Parameters
{{!}}
{{{!}}
!Name
!Type
!Description
{{!}}-
{{!}}stateOperationName
{{!}}string
{{!}}An <tt>operationName</tt> from the agent states list. See {{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=State}}.
{{!}}}
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Type definitions
|anchor=TypeDefinitions
|alignment=Vertical
|Media=
|image=
|structuredtext=The agent namespace includes the following object types:

*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=Agent}}

===Agent===
{{{!}}
!Description
{{!}}Represents the JSON structure of the agent.
{{!}}-
!Type
{{!}}Object
{{!}}-
!Properties
{{!}}
{{{!}}
!Name
!Type
!Description
{{!}}-
{{!}}employeeId
{{!}}string
{{!}}The agent's unique identifier used for routing purposes.
{{!}}-
{{!}}firstname
{{!}}string
{{!}}The agent's first name.
{{!}}-
{{!}}lastname
{{!}}string
{{!}}The agent's last name.
{{!}}-
{{!}}username
{{!}}string
{{!}}The agent's username. This is a global unique ID.
{{!}}}
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 20: / Line 20: @@
 {{{!}}
 !Signature
-{{!}}<static> get() → &#123;{{Link-SomewhereInThisVersion|manual=SCAPI|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}&#125;
+{{!}}<static> get(''succeeded, failed'') → &#123;{{Link-SomewhereInThisVersion|manual=SCAPI|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}&#125;
 {{!}}-
 !Description
 {{!}}Gets the agent's attributes.
 {{!}}-
 !Returns
@@ Line 32: / Line 48: @@
 {{{!}}
 !Signature
-{{!}}<static> getState() → &#123;{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}&#125;
+{{!}}<static> getState(''succeeded, failed'') → &#123;{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}&#125;
 {{!}}-
 !Description
 {{!}}Gets the agent's state.
 {{!}}-
 !Returns
@@ Line 44: / Line 76: @@
 {{{!}}
 !Signature
-{{!}}<static> getStateList() → {Array.<{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}>}
+{{!}}<static> getStateList(''succeeded, failed'') → {Array.<{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}>}
 {{!}}-
 !Description
 {{!}}Gets the list of possible agent states.
 {{!}}-
 !Returns
@@ Line 56: / Line 104: @@
 {{{!}}
 !Signature
-{{!}}<static> setState(''stateOperationName'')
+{{!}}<static> setState(''stateOperationName, succeeded, failed'')
 {{!}}-
 !Description
@@ Line 71: / Line 119: @@
 {{!}}string
 {{!}}An <tt>operationName</tt> from the agent states list. See {{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=State}}.
 {{!}}}
 {{!}}}

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Methods
 |anchor=Methods
 |alignment=Vertical
 |structuredtext=The Agent namespace includes the following methods:
@@ Line 23: / Line 20: @@
 {{{!}}
 !Signature
-{{!}}<static> get() → {{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}}
+{{!}}<static> get() → &#123;{{Link-SomewhereInThisVersion|manual=SCAPI|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}&#125;
 {{!}}-
 !Description
@@ Line 35: / Line 32: @@
 {{{!}}
 !Signature
-{{!}}<static> getState() → {{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}}
+{{!}}<static> getState() → &#123;{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}&#125;
 {{!}}-
 !Description
@@ Line 76: / Line 73: @@
 {{!}}}
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 83: / Line 78: @@
 |anchor=TypeDefinitions
 |alignment=Vertical
 |structuredtext=The agent namespace includes the following object types:
 *{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=Agent}}
+{{AnchorDiv|Agent}}
 ===Agent===
 {{{!}}
@@ Line 121: / Line 114: @@
 {{!}}}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn about the Agent namespace methods and type definitions in the Service Client API.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

PEC-Developer/Current/SCAPI/AgentNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

Jumunn: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"