Interface AgentInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AgentInfo.Builder,AgentInfo>, SdkBuilder<AgentInfo.Builder,AgentInfo>, SdkPojo
Enclosing class:
AgentInfo
@Mutable @NotThreadSafe public static interface AgentInfo.Builder extends SdkPojo, CopyableBuilder<AgentInfo.Builder,AgentInfo>

  • Method Details

    • id

      AgentInfo.Builder id(String id)

      The identifier of the agent who accepted the contact.

      Parameters:
      id - The identifier of the agent who accepted the contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptedByAgentTimestamp

      AgentInfo.Builder acceptedByAgentTimestamp(Instant acceptedByAgentTimestamp)

      The timestamp when the contact was accepted by the agent.

      Parameters:
      acceptedByAgentTimestamp - The timestamp when the contact was accepted by the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • previewEndTimestamp

      AgentInfo.Builder previewEndTimestamp(Instant previewEndTimestamp)

      The timestamp when the agent finished previewing the contact.

      Parameters:
      previewEndTimestamp - The timestamp when the agent finished previewing the contact.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectedToAgentTimestamp

      AgentInfo.Builder connectedToAgentTimestamp(Instant connectedToAgentTimestamp)

      The timestamp when the contact was connected to the agent.

      Parameters:
      connectedToAgentTimestamp - The timestamp when the contact was connected to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentPauseDurationInSeconds

      AgentInfo.Builder agentPauseDurationInSeconds(Integer agentPauseDurationInSeconds)

      Agent pause duration for a contact in seconds.

      Parameters:
      agentPauseDurationInSeconds - Agent pause duration for a contact in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hierarchyGroups

      AgentInfo.Builder hierarchyGroups(HierarchyGroups hierarchyGroups)

      The agent hierarchy groups for the agent.

      Parameters:
      hierarchyGroups - The agent hierarchy groups for the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hierarchyGroups

      default AgentInfo.Builder hierarchyGroups(Consumer<HierarchyGroups.Builder> hierarchyGroups)

      The agent hierarchy groups for the agent.

      This is a convenience method that creates an instance of the HierarchyGroups.Builder avoiding the need to create one manually via HierarchyGroups.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hierarchyGroups(HierarchyGroups).

      Parameters:
      hierarchyGroups - a consumer that will call methods on HierarchyGroups.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceInfo

      AgentInfo.Builder deviceInfo(DeviceInfo deviceInfo)

      Information regarding Agent’s device.

      Parameters:
      deviceInfo - Information regarding Agent’s device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceInfo

      default AgentInfo.Builder deviceInfo(Consumer<DeviceInfo.Builder> deviceInfo)

      Information regarding Agent’s device.

      This is a convenience method that creates an instance of the DeviceInfo.Builder avoiding the need to create one manually via DeviceInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceInfo(DeviceInfo).

      Parameters:
      deviceInfo - a consumer that will call methods on DeviceInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilities

      AgentInfo.Builder capabilities(ParticipantCapabilities capabilities)
      Sets the value of the Capabilities property for this object.
      Parameters:
      capabilities - The new value for the Capabilities property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      default AgentInfo.Builder capabilities(Consumer<ParticipantCapabilities.Builder> capabilities)
      Sets the value of the Capabilities property for this object. This is a convenience method that creates an instance of the ParticipantCapabilities.Builder avoiding the need to create one manually via ParticipantCapabilities.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilities(ParticipantCapabilities).

      Parameters:
      capabilities - a consumer that will call methods on ParticipantCapabilities.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • afterContactWorkDuration

      AgentInfo.Builder afterContactWorkDuration(Integer afterContactWorkDuration)

      The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.

      Parameters:
      afterContactWorkDuration - The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • afterContactWorkStartTimestamp

      AgentInfo.Builder afterContactWorkStartTimestamp(Instant afterContactWorkStartTimestamp)

      The date and time when the agent started doing After Contact Work for the contact, in UTC time.

      Parameters:
      afterContactWorkStartTimestamp - The date and time when the agent started doing After Contact Work for the contact, in UTC time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • afterContactWorkEndTimestamp

      AgentInfo.Builder afterContactWorkEndTimestamp(Instant afterContactWorkEndTimestamp)

      The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.

      Parameters:
      afterContactWorkEndTimestamp - The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentInitiatedHoldDuration

      AgentInfo.Builder agentInitiatedHoldDuration(Integer agentInitiatedHoldDuration)

      The total hold duration in seconds initiated by the agent.

      Parameters:
      agentInitiatedHoldDuration - The total hold duration in seconds initiated by the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTransitions

      AgentInfo.Builder stateTransitions(Collection<StateTransition> stateTransitions)

      List of StateTransition for a supervisor.

      Parameters:
      stateTransitions - List of StateTransition for a supervisor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTransitions

      AgentInfo.Builder stateTransitions(StateTransition... stateTransitions)

      List of StateTransition for a supervisor.

      Parameters:
      stateTransitions - List of StateTransition for a supervisor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTransitions

      AgentInfo.Builder stateTransitions(Consumer<StateTransition.Builder>... stateTransitions)

      List of StateTransition for a supervisor.

      This is a convenience method that creates an instance of the StateTransition.Builder avoiding the need to create one manually via StateTransition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateTransitions(List<StateTransition>).

      Parameters:
      stateTransitions - a consumer that will call methods on StateTransition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: