Interface LocalInvitationEvents

Event types of the LocalInvitation instance.

Hierarchy

LocalInvitationEvents

Index

Methods

Methods

LocalInvitationAccepted

LocalInvitationAccepted(response: string): void

- Defined in node_modules/agora-rtm-sdk/index.d.ts:764
Callback to the caller: occurs when the callee accepts the call invitation.

Parameters
- response: string
  
  The response from the callee.
Returns void

LocalInvitationCanceled

LocalInvitationCanceled(): void

- Defined in node_modules/agora-rtm-sdk/index.d.ts:790
Callback to the caller: occurs when the caller cancels a call invitation. This callback notifies the caller that he/she has canceled a call invitation.

Returns void

LocalInvitationFailure

LocalInvitationFailure(reason: RtmStatusCode.LocalInvitationFailureReason): void

- Defined in node_modules/agora-rtm-sdk/index.d.ts:801
Callback to the caller: occurs when the outgoing call invitation ends in failure.

Parameters
- reason: RtmStatusCode.LocalInvitationFailureReason
  
  See: LocalInvitationFailureReason.
Returns void

LocalInvitationReceivedByPeer

LocalInvitationReceivedByPeer(): void

- Defined in node_modules/agora-rtm-sdk/index.d.ts:782
Callback to the caller: occurs when the callee receives the call invitation.

This callback notifies the caller that the callee receives the call invitation.

Returns void

LocalInvitationRefused

LocalInvitationRefused(response: string): void

- Defined in node_modules/agora-rtm-sdk/index.d.ts:773
Callback to the caller: occurs when the callee refuses the call invitation.

Parameters
- response: string
  
  The response from the callee.
Returns void

Generated using TypeDoc