Class RemoteInvitation

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

No Inherit Doc

Hierarchy

EventEmitter<RemoteInvitationEvents>
- RemoteInvitation

Index

Constructors

constructor

new RemoteInvitation(): RemoteInvitation
Returns RemoteInvitation

Inherited from EventEmitter< RtmEvents.RemoteInvitationEvents >.constructor

Properties

`Readonly` 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.

Note

The maximum length is 8 KB.

response

response: string

Response to the incoming call invitation.

Note

The maximum length is 8 KB.

`Readonly` state

state: RemoteInvitationState

States of the incoming call invitation. See: RemoteInvitationState .

`Static` defaultMaxListeners

defaultMaxListeners: number

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
- Defined in node_modules/agora-rtm-sdk/index.d.ts:1075

listenerCount

listenerCount<P, T>(this: T, event: P): number
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- event: P
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/agora-rtm-sdk/index.d.ts:200

listeners

listeners<P, T>(this: T, event: P): Function[]
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- event: P
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:198

off

off<P, T>(this: T, event: P, listener: ((...args: any[]) => any)): RemoteInvitation
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- event: P
- listener: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns RemoteInvitation
Inherited from EventEmitter.off
- Defined in node_modules/agora-rtm-sdk/index.d.ts:191

on

on<EventName>(eventName: EventName, listener: ((...args: ListenerType<RemoteInvitationEvents[EventName]>) => any)): RemoteInvitation
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 extends keyof RemoteInvitationEvents
Parameters
- eventName: EventName
  
  The name of the channel event. See the property names in the RtmChannelEvents for the list of events.
- listener: ((...args: ListenerType<RemoteInvitationEvents[EventName]>) => any)
  
  The callback function of the channel event.
  - - (...args: ListenerType<RemoteInvitationEvents[EventName]>): any
    - Parameters
      
      Rest ...args: ListenerType<RemoteInvitationEvents[EventName]>
      
      Returns any
Returns RemoteInvitation
Overrides EventEmitter.on
- Defined in node_modules/agora-rtm-sdk/index.d.ts:1095

once

once<P, T>(this: T, event: P, listener: ((...args: ListenerType<RemoteInvitationEvents[P]>) => void)): RemoteInvitation
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- event: P
- listener: ((...args: ListenerType<RemoteInvitationEvents[P]>) => void)
  - - (...args: ListenerType<RemoteInvitationEvents[P]>): void
    - Parameters
      
      Rest ...args: ListenerType<RemoteInvitationEvents[P]>
      
      Returns void
Returns RemoteInvitation
Inherited from EventEmitter.once
- Defined in node_modules/agora-rtm-sdk/index.d.ts:185

rawListeners

rawListeners<P, T>(this: T, event: P): Function[]
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- event: P
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:199

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
- Defined in node_modules/agora-rtm-sdk/index.d.ts:1083

removeAllListeners

removeAllListeners<P, T>(this: T, event?: P): RemoteInvitation
Type Parameters
- P extends keyof RemoteInvitationEvents
- T
Parameters
- this: T
- Optional event: P
Returns RemoteInvitation
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/agora-rtm-sdk/index.d.ts:197

Class RemoteInvitation

No Inherit Doc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RemoteInvitation

Properties

Readonly callerId

Readonly channelId

Readonly content

Note

response

Note

Readonly state

Static defaultMaxListeners

Methods

accept

Returns void

listenerCount

Type Parameters

P extends keyof RemoteInvitationEvents

T

Parameters

this: T

event: P

Returns number

listeners

Type Parameters

P extends keyof RemoteInvitationEvents

T

Parameters

this: T

event: P

Returns Function[]

off

Type Parameters

P extends keyof RemoteInvitationEvents

T

Parameters

this: T

event: P

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns RemoteInvitation

on

Type Parameters

EventName extends keyof RemoteInvitationEvents

Parameters

eventName: EventName

listener: ((...args: ListenerType<RemoteInvitationEvents[EventName]>) => any)

Parameters

Rest ...args: ListenerType<RemoteInvitationEvents[EventName]>

Returns any

Returns RemoteInvitation

once

Type Parameters

P extends keyof RemoteInvitationEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<RemoteInvitationEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<RemoteInvitationEvents[P]>

Returns void

Returns RemoteInvitation

rawListeners

Type Parameters

P extends keyof RemoteInvitationEvents

T

Parameters

this: T

event: P

Returns Function[]

`Readonly` callerId

`Readonly` channelId

`Readonly` content

`Readonly` state

`Static` defaultMaxListeners

`Rest` ...args: any[]

`Rest` ...args: ListenerType<RemoteInvitationEvents[EventName]>

`Rest` ...args: ListenerType<RemoteInvitationEvents[P]>

`Optional` event: P