Class CoreConversation

conversationId

createdAt

• get createdAt(): Readonly<Date>

  Date when the conversation was created.

  Returns Readonly<Date>

participants

• get participants(): readonly Participant[]

  The list of participants currently involved in the conversation.

  Returns readonly Participant[]

state

• get state(): ConversationState

  Current state of the conversation.

  Returns ConversationState

addConversationEndedListener

• addConversationEndedListener(handler: EventHandler<ConversationEnded>): string

  Attach event handler callback that needs to be invoked when the conversation ends.

  Parameters

  • handler: EventHandler<ConversationEnded>

    The event handler callback.

  Returns string

  A unique event handler id that was generated by Omni SDK when the event handler was attached.

addParticipantAddedListener

• addParticipantAddedListener(handler: EventHandler<ParticipantAdded>): string

  Attach event handler callback that needs to be invoked when a participant is added to the conversation.

  Parameters

  • handler: EventHandler<ParticipantAdded>

    The event handler function.

  Returns string

  string Unique event handler id that was generated by Omni SDK when the event handler was attached.

  Example

  const participantAddedHandlerId = conversation.addParticipantAddedListener((eventPayload) => {
       console.log("Participant added: ", eventPayload);
  });
  Copy

addParticipantDisconnectedListener

• addParticipantDisconnectedListener(
      handler: EventHandler<ParticipantDisconnected>,
  ): string

  Attach event handler callback that needs to be invoked when a participant is disconnected from the conversation.

  Parameters

  • handler: EventHandler<ParticipantDisconnected>

  Returns string

  string Unique EventHandlerId that was generated by Omni SDK when the event handler was attached.

  Example

  const participantDisconnectedHandlerId = conversation.addParticipantDisconnectedListener((eventPayload) => {
       console.log("Participant disconnected: ", eventPayload);
  });
  Copy

end

• end(): Promise<void>

  End this conversation. This will end the conversation between the User and Avaya Infinity contact center and close all its associated channels.

  Returns Promise<void>

  A promise that resolves when the conversation has been successfully ended.

removeConversationEndedListener

• removeConversationEndedListener(eventHandlerId: string): void

  Remove the event handler callback that was attached to the conversation ended event.

  Parameters

  • eventHandlerId: string

    Event handler id that was received at the time of attaching the event handler.

  Returns void

removeParticipantAddedListener

• removeParticipantAddedListener(eventHandlerId: string): void

  Remove the event handler callback that was attached to the participant added event.

  Parameters

  • eventHandlerId: string

  Returns void

removeParticipantDisconnectedListener

• removeParticipantDisconnectedListener(eventHandlerId: string): void

  Remove the event handler callback that was attached to the participant disconnected event.

  Parameters

  • eventHandlerId: string

  Returns void

setContextParameters

• setContextParameters(parameters: Record<string, string>): void

  The key value pairs that are passed as context parameters for the conversation to Avaya Infinity. Avaya Infinity uses this information to make business decisions on how the engagement is treated. For example, the client application might want to send hints about customer's interest based on the customer's searches or FAQ browsing.

  Parameters

  • parameters: Record<string, string>

    The context parameters to set.

  Returns void

  Example

  conversation.setContextParameters({"availableBalance": "1000"});
  Copy