Constructor
-
new Team(teamService, teamCollection)
-
Parameters:
Name Type Description teamService
AvayaCustomerServices.Services.Team.TeamService teamCollection
AvayaCustomerServices.Services.Team.TeamCollection
Methods
-
addOnTeamGroupsAddedCallback(callback)
-
Adds a callback that is executed when team groups exist when members have been updated
Parameters:
Name Type Description callback
AvayaCustomerServices.Services.Team.Team~onTeamGroupsAddedCallback Function that handles on team members updated event response
-
addOnTeamMembersAddedCallback(callback)
-
Adds a callback that is executed when team members have been updated
Parameters:
Name Type Description callback
AvayaCustomerServices.Services.Team.Team~onTeamMembersUpdatedCallback Function that handles on team members updated event response
-
bargeIn(interaction)
-
Barge in on a members interaction
Parameters:
Name Type Description interaction
object - Since:
-
- 3.2.2
-
broadcast(message)
-
Supervisor broadcast
Parameters:
Name Type Description message
object to broadcast
- Since:
-
- 3.4.0.0
-
coach(interaction)
-
Coach on a members interaction
Parameters:
Name Type Description interaction
object - Since:
-
- 3.2.2
-
endObserveMemberInteraction(interaction)
-
Ends the observe of an interaction
Parameters:
Name Type Description interaction
object - Since:
-
- 3.2.2
-
forceEndMemberInteraction(interaction)
-
Requests an force end of an interaction.
Parameters:
Name Type Description interaction
object - Since:
-
- 3.7.0
-
getAgents()
-
Returns all Team Members that have an agent role and belong to their Team Collection.
-
getMember(userHandle) → {AvayaCustomerServices.Services.Team.TeamMember}
-
Search Team Collection for a Team Member. Attempts to find a Team Member using their user handle.
Parameters:
Name Type Description userHandle
string User Handle of team member to find
Returns:
-
getMembers() → {Array.<AvayaCustomerServices.Services.Team.TeamMember>}
-
Returns all Team Members that belong to their Team Collection.
Returns:
{ Array.<AvayaCustomerServices.Services.Team.TeamMember> }
-
getSupervisors()
-
Returns all Team Members that have a supervisor role and belong to their Team Collection.
-
getTeamState(role)
-
Fetches a summary of each Team Member's state from backend service.
Parameters:
Name Type Description role
string Get team state based on provided role
-
observeMemberInteraction(interaction)
-
Requests an observe of an interaction.
Parameters:
Name Type Description interaction
object - Since:
-
- 3.2.2
-
removeCallbacks() → {AvayaCustomerServices.Base.Promise}
-
Remove callbacks and stop team service
Returns:
{ AvayaCustomerServices.Base.Promise }
-
setTeamMonitoring(role, teamMemberUserHandle, monitor)
-
Sets the monitor flag for team member details updates
Parameters:
Name Type Description role
string Get team member updates based on provided role
teamMemberUserHandle
string user handle of team member to be monitored
monitor
boolean boolean for monitoring team member details updates
-
setTeamMonitoring(role, monitor)
-
Sets the monitor flag for team member details updates
Parameters:
Name Type Description role
string Get team member updates based on provided role
monitor
boolean boolean for monitoring team member updates
Type Definitions
-
onTeamGroupsAddedCallback(message)
-
This callback handles the TeamStateUpdatedEvent response
Parameters:
Name Type Description message
TeamStateUpdatedEvent The event that is fired when team members have been updated and groups exist
-
onTeamMembersUpdatedCallback(message)
-
This callback handles the TeamStateUpdatedEvent response
Parameters:
Name Type Description message
TeamStateUpdatedEvent The event that is fired when team members have been updated