Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data UserData = UserData' {
- activeSlotsByChannel :: Maybe (HashMap Channel Natural)
- availableSlotsByChannel :: Maybe (HashMap Channel Natural)
- contacts :: Maybe [AgentContactReference]
- hierarchyPath :: Maybe HierarchyPathReference
- maxSlotsByChannel :: Maybe (HashMap Channel Natural)
- nextStatus :: Maybe Text
- routingProfile :: Maybe RoutingProfileReference
- status :: Maybe AgentStatusReference
- user :: Maybe UserReference
- newUserData :: UserData
- userData_activeSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
- userData_availableSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
- userData_contacts :: Lens' UserData (Maybe [AgentContactReference])
- userData_hierarchyPath :: Lens' UserData (Maybe HierarchyPathReference)
- userData_maxSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural))
- userData_nextStatus :: Lens' UserData (Maybe Text)
- userData_routingProfile :: Lens' UserData (Maybe RoutingProfileReference)
- userData_status :: Lens' UserData (Maybe AgentStatusReference)
- userData_user :: Lens' UserData (Maybe UserReference)
Documentation
Data for a user.
See: newUserData
smart constructor.
UserData' | |
|
Instances
newUserData :: UserData Source #
Create a value of UserData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeSlotsByChannel:UserData'
, userData_activeSlotsByChannel
- A map of active slots by channel. The key is a channel name. The value
is an integer: the number of active slots.
$sel:availableSlotsByChannel:UserData'
, userData_availableSlotsByChannel
- A map of available slots by channel. The key is a channel name. The
value is an integer: the available number of slots.
$sel:contacts:UserData'
, userData_contacts
- A list of contact reference information.
$sel:hierarchyPath:UserData'
, userData_hierarchyPath
- Contains information about the levels of a hierarchy group assigned to a
user.
$sel:maxSlotsByChannel:UserData'
, userData_maxSlotsByChannel
- A map of maximum slots by channel. The key is a channel name. The value
is an integer: the maximum number of slots. This is calculated from
MediaConcurrency
of the RoutingProfile
assigned to the agent.
$sel:nextStatus:UserData'
, userData_nextStatus
- The Next status of the agent.
$sel:routingProfile:UserData'
, userData_routingProfile
- Information about the routing profile that is assigned to the user.
$sel:status:UserData'
, userData_status
- The status of the agent that they manually set in their Contact Control
Panel (CCP), or that the supervisor manually changes in the real-time
metrics report.
$sel:user:UserData'
, userData_user
- Information about the user for the data that is returned. It contains
the resourceId
and ARN of the user.
userData_activeSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
userData_availableSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #
A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
userData_contacts :: Lens' UserData (Maybe [AgentContactReference]) Source #
A list of contact reference information.
userData_hierarchyPath :: Lens' UserData (Maybe HierarchyPathReference) Source #
Contains information about the levels of a hierarchy group assigned to a user.
userData_maxSlotsByChannel :: Lens' UserData (Maybe (HashMap Channel Natural)) Source #
A map of maximum slots by channel. The key is a channel name. The value
is an integer: the maximum number of slots. This is calculated from
MediaConcurrency
of the RoutingProfile
assigned to the agent.
userData_routingProfile :: Lens' UserData (Maybe RoutingProfileReference) Source #
Information about the routing profile that is assigned to the user.
userData_status :: Lens' UserData (Maybe AgentStatusReference) Source #
The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
userData_user :: Lens' UserData (Maybe UserReference) Source #
Information about the user for the data that is returned. It contains
the resourceId
and ARN of the user.