Constructor
-
new TeamMember(teamService, options)
-
Constructor function for TeamMember Model
Parameters:
Name Type Description teamService
AvayaCustomerServices.Services.Team.TeamService options
Object TeamMember Model options
Members
-
address :string
-
Team Member's address.
Type:
- string
-
capabilities :Object
-
Team Member's list of capabilities. Only available to supervisors.
Type:
- Object
- Since:
-
- 3.2.2
-
channels :Array.<Object>
-
Team Member's list of channels. Only available to supervisors.
Type:
- Array.<Object>
-
data :object
-
Generic object in which to store model data
Type:
- object
- Inherited From:
-
deferredInteractions :Array.<Object>
-
Team Member's list of deferred interactions. Only available to supervisors.
Type:
- Array.<Object>
-
disconnectedTime :string
-
Team Member's disconnection time.
Type:
- string
-
displayName :string
-
Team Member's display name
Type:
- string
-
firstName :string
-
Team Member's first name
Type:
- string
-
groups :Array.<String>
-
An array of group names that the team member belongs
Type:
- Array.<String>
- Since:
-
- 3.4.0.0
-
id :string
-
Team Member's ID
Type:
- string
-
interactions :Array.<Object>
-
Team Member's list of activate interactions. Only available to supervisors.
Type:
- Array.<Object>
-
isConnected :boolean
-
Team Member's connection state.
Type:
- boolean
-
isNew :boolean
-
Flag to indicate if model instance is new
Type:
- boolean
- Inherited From:
-
isSelf :boolean
-
True if the Team Member is the current agent.
Type:
- boolean
-
lastName :string
-
Team Member's last name
Type:
- string
-
resourceAddress :string
-
Team Member's display name
Type:
- string
-
state :string
-
Team Member's current state.
Type:
- string
-
stateReason :string
-
Team Member's current state reason (if in a not ready state).
Type:
- string
-
type :string
-
Team Member's type. This is synonymous with Agent's role.
Type:
- string
-
userHandle :string
-
Team Member's user handle.
Type:
- string
Methods
-
bargeIn(interaction) → {AvayaCustomerServices.Base.Promise}
-
Stop observing team member's interaction
Parameters:
Name Type Description interaction
Object Returns:
{ AvayaCustomerServices.Base.Promise }
-
deactivate() → {AvayaCustomerServices.Base.Promise}
-
Deactivate team member, freeing up any occupied stations used by that team member.
- Since:
-
- 3.2.2
Returns:
{ AvayaCustomerServices.Base.Promise }Promise
-
getInteractions() → {Array.<AvayaCustomerServices.Services.Work.Interaction>}
-
Find all interactions attached to this Team Member
Returns:
{ Array.<AvayaCustomerServices.Services.Work.Interaction> }
-
getState() → {AvayaCustomerServices.Base.Promise}
-
Find Team Member state
Returns:
{ AvayaCustomerServices.Base.Promise }Promise
-
goNotReady(notReadyReason) → {AvayaCustomerServices.Base.Promise}
-
Set Agent's state to "Not Ready". In this state, agents are not available to be routed new work requests.
Parameters:
Name Type Argument Default Description notReadyReason
string <optional>
998 Reason for setting team member into a "Not Ready" state
- Since:
-
- 3.2.2
Returns:
{ AvayaCustomerServices.Base.Promise }Promise
-
goReady() → {AvayaCustomerServices.Base.Promise}
-
Set Agent's state to "Ready". In this state, agents are available to be routed new work requests.
- Since:
-
- 3.2.2
Returns:
{ AvayaCustomerServices.Base.Promise }Promise
-
observe(interaction) → {AvayaCustomerServices.Base.Promise}
-
Start observing team member's interaction
Parameters:
Name Type Description interaction
Object Returns:
{ AvayaCustomerServices.Base.Promise }
-
setState(logoutReason) → {AvayaCustomerServices.Base.Promise}
-
Logout Team Member
Parameters:
Name Type Argument Default Description logoutReason
string <optional>
998 Reason for logging out team member
- Since:
-
- 3.2.2
Returns:
{ AvayaCustomerServices.Base.Promise }Promise
-
stopObserving(interaction) → {AvayaCustomerServices.Base.Promise}
-
Stop observing team member's interaction
Parameters:
Name Type Description interaction
Object Returns:
{ AvayaCustomerServices.Base.Promise }