Rate this page:

Conversation

Represents a CCAI conversation instance.

Constructors

constructor

Copy URL

Parameters

Methods

addEventListener

Copy URL
addEventListener(event: 

Conversation

,
callback:

Function

):

void

Adds a handler for the specified CCAI.Events.Conversation event. Use only functions as handlers; anything except a function leads to an error and scenario termination when a handler is called

Parameters

  • Event class (i.e., CCAI.Events.Conversation.Created)

  • callback:

    Function

    Handler function. A single parameter is passed - object with event information

Returns

  • type:

    void

addParticipant

Copy URL
addParticipant(settings: 

ParticipantSettings

):

Participant

Adds a participant to the conversation.

Parameters

Returns

removeEventListener

Copy URL
removeEventListener(event: 

Conversation

,
callback:

Function

):

void

Removes a handler for the specified CCAI.Events.Conversation event

Parameters

  • Event class (i.e., CCAI.Events.Conversation.Created)

  • callback:

    Function

    Optional

    Handler function. If not specified, all event listeners are removed

Returns

  • type:

    void

removeParticipant

Copy URL
removeParticipant(participant: 

Participant

):

void

Removes a participant from the conversation.

Parameters

Returns

  • type:

    void