Documentation

Class: SentInvitation

SentInvitation

SentInvitation

Defines an invitation sent by this client

new SentInvitation(contact, conversation, options)

SentInvitation

Parameters:
Name Type Description
contact Contact
conversation Conversation
options JSON
Fires:

Extends

Methods

<static> getAvailableEvents()

Returns available events for this class

Returns:
Type
Array.<string>

cancel()

Cancel the ongoing invitation

Returns:
Type
Void

getId()

Returns Invitation's id

Returns:

Invitation id

Type
string

getStatus()

Returns invitation status

Inherited From:
Overrides:
Returns:

invitation status

Type
Symbol

onResponse()

Adds a listener called when the Sent invitation has been answered or has expired

Returns:
Type
Void

send(messageData)

Send Message to remote access contact

Parameters:
Name Type Description
messageData JSON
Returns:
Type
Promise.<void>

Events

receive

When the invitation has been received by the contact

Type: Void

response

When the invitation status changed

Type: symbol
Deprecated:
  • Please note that this event is now deprecated as we have added a statusChange event

statusChange

Emitted invitation status change

Type: StatusChangeInfo