Class RemoteInvitation

The call invitation object created by the SDK and called by the callee.

Hierarchy

EventEmitter<RemoteInvitationEvents>
- RemoteInvitation

Index

Properties

Methods

Properties

callerId

callerId: string

uid of the caller.

readonly

channelId

channelId: string

Allows the callee to get the channel ID.

readonly

content

content: string

The call invitation content set by the caller.

readonly
note: The maximum length is 8 KB.

response

response: string

Response to the incoming call invitation.

note: The maximum length is 8 KB.

state

state: RemoteInvitationState

States of the incoming call invitation. See: RemoteInvitationState .

readonly

Methods

accept

accept(): void

Allows the callee to accept an incoming call invitation. This method has no asynchronous callbacks. To listen for RemoteInvitationState changes, register the event handler in RemoteInvitationEvents via the on method.

Returns void

on

on<EventName>(eventName: EventName, listener: function): this

Adds the listener function to the channel for the event named eventName. See the EventEmitter API documentation for other event methods on the RtmChannel instance.

Type parameters
- EventName: keyof RemoteInvitationEvents
Parameters
- eventName: EventName
  
  The name of the channel event. See the property names in the RtmChannelEvents for the list of events.
- listener: function
  
  The callback function of the channel event.
  - - (...args: ListenerType<RemoteInvitationEvents[EventName]>): any
    - Parameters
      - Rest ...args: ListenerType<RemoteInvitationEvents[EventName]>
      Returns any
Returns this

refuse

refuse(): void

Allows the callee to decline an incoming call invitation. This method has no asynchronous callbacks. To listen for RemoteInvitationState changes, register the event handler in RemoteInvitationEvents via the on method.

Returns void