RtmEngine | agora-rn-uikit

RtmEngine is the entry point of the react native agora rtm sdk. You can call the createClient method of RtmEngine to create an RtmEngine instance.

noinheritdoc

Hierarchy

RtmEngine

Index

Constructors

constructor

Methods

Constructors

constructor

new RtmEngine(): RtmEngine

Returns RtmEngine

Methods

acceptRemoteInvitation

acceptRemoteInvitation(remoteInvitationProps: RemoteInvitationProps): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:409
deprecated
acceptRemoteInvitationV2 supports platform: ios, android This method enables accept remote invitation with RemoteInvitationProps. NOTICE: content bytelength has MAX_SIZE 32kb limit.

Parameters
- remoteInvitationProps: RemoteInvitationProps
  
  RemoteInvitationProps
  
  RemoteInvitationProps
  
  uid | string | required | channelId | string | required |
  
  response | string | optional | 32kb limit |
Returns Promise<void>
Promise

acceptRemoteInvitationV2

acceptRemoteInvitationV2(remoteInvitation: <internal>.RemoteInvitation): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:410
Parameters
- remoteInvitation: <internal>.RemoteInvitation
Returns Promise<void>

addListener

addListener<EventType>(event: EventType, listener: <internal>.RtmClientEvents[EventType]): EmitterSubscription

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:169
Type parameters
- EventType: keyof <internal>.RtmClientEvents
Parameters
- event: EventType
- listener: <internal>.RtmClientEvents[EventType]
Returns EmitterSubscription

addOrUpdateChannelAttributes

addOrUpdateChannelAttributes(channelId: string, attributes: <internal>.RtmChannelAttribute[], option: ChannelAttributeOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:293
Parameters
- channelId: string
- attributes: <internal>.RtmChannelAttribute[]
- option: ChannelAttributeOptions
Returns Promise<void>

addOrUpdateLocalUserAttributes

addOrUpdateLocalUserAttributes(attributes: <internal>.RtmAttribute[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:264
Parameters
- attributes: <internal>.RtmAttribute[]
Returns Promise<void>

cancelLocalInvitation

cancelLocalInvitation(invitationProps: LocalInvitationProps): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:445
deprecated
cancelLocalInvitationV2 supports platform: ios, android This method enables cancel local invitation with invitationProps. NOTICE: content bytelength has MAX_SIZE 32kb limit.

Parameters
- invitationProps: LocalInvitationProps
  
  LocalInvitationProps
  
  LocalInvitationProps
  
  uid | string | required | channelId | string | required |
  
  content | string | optional | 32kb limit |
Returns Promise<void>
Promies

cancelLocalInvitationV2

cancelLocalInvitationV2(localInvitation: <internal>.LocalInvitation): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:446
Parameters
- localInvitation: <internal>.LocalInvitation
Returns Promise<void>

clearChannelAttributes

clearChannelAttributes(channelId: string, option: ChannelAttributeOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:295
Parameters
- channelId: string
- option: ChannelAttributeOptions
Returns Promise<void>

clearLocalUserAttributes

clearLocalUserAttributes(): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:281
Returns Promise<void>

createClient

createClient(appId: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:320
deprecated
createInstance supports platform: ios, android This method creates AgoraRTM instance and begin event observing, collect all both remote and local invitations and channels resources. method: createClient

Parameters
- appId: string
  
  string
Returns Promise<void>
void

createInstance

createInstance(appId: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:321
Parameters
- appId: string
Returns Promise<void>

createLocalInvitation

createLocalInvitation(calleeId: string, content?: string, channelId?: string): Promise<<internal>.LocalInvitation>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:374
Parameters
- calleeId: string
- Optional content: string
- Optional channelId: string
Returns Promise<<internal>.LocalInvitation>

deleteChannelAttributesByKeys

deleteChannelAttributesByKeys(channelId: string, attributeKeys: string[], option: ChannelAttributeOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:294
Parameters
- channelId: string
- attributeKeys: string[]
- option: ChannelAttributeOptions
Returns Promise<void>

deleteLocalUserAttributesByKeys

deleteLocalUserAttributesByKeys(attributeKeys: string[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:273
Parameters
- attributeKeys: string[]
Returns Promise<void>

destroyClient

destroyClient(): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:178
deprecated
release supports platform: ios, android This method destroy AgoraRTM instance, stop event observing, release all both remote and local invitaitons and channels resources.

Returns Promise<void>
void

getChannelAttributes

getChannelAttributes(channelId: string): Promise<<internal>.RtmChannelAttribute[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:296
Parameters
- channelId: string
Returns Promise<<internal>.RtmChannelAttribute[]>

getChannelAttributesByKeys

getChannelAttributesByKeys(channelId: string, attributeKeys: string[]): Promise<<internal>.RtmChannelAttribute[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:297
Parameters
- channelId: string
- attributeKeys: string[]
Returns Promise<<internal>.RtmChannelAttribute[]>

getChannelMembersBychannelId

getChannelMembersBychannelId(channelId: string): Promise<Members>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:371
deprecated
getMembers supports platform: ios, android This method enables you get members by channel id.

Parameters
- channelId: string
  
  string.
Returns Promise<Members>
Promise Members}

members | MemberInfo |

MemberInfo

uid | string | user id|

channelId | string | channel id|

getMembers

getMembers(channelId: string): Promise<<internal>.RtmChannelMember[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:372
Parameters
- channelId: string
Returns Promise<<internal>.RtmChannelMember[]>

getSdkVersion

getSdkVersion(callback: Callback): void

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:327
deprecated
get the version of rtm sdk

Parameters
- callback: Callback
  
  (version) => {} required
Returns void

getUserAttributes

getUserAttributes(userId: string): Promise<<internal>.RtmAttribute[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:290
Parameters
- userId: string
Returns Promise<<internal>.RtmAttribute[]>

getUserAttributesByKeys

getUserAttributesByKeys(userId: string, attributeKeys: string[]): Promise<<internal>.RtmAttribute[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:291
Parameters
- userId: string
- attributeKeys: string[]
Returns Promise<<internal>.RtmAttribute[]>

getUserAttributesByUid

getUserAttributesByUid(uid: string): Promise<UserProfile>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:289
deprecated
getUserAttributes supports platform: ios, android This method enables you get user attributes by uid.

Parameters
- uid: string
  
  string. user id
Returns Promise<UserProfile>
Promise UserProfile

joinChannel

joinChannel(channelId: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:335
supports platform: ios, android This method do join channel with channelId

Parameters
- channelId: string
  
  string
Returns Promise<void>
Promise

leaveChannel

leaveChannel(channelId: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:342
supports platform: ios, android This method do leave channel with channelId

Parameters
- channelId: string
  
  string
Returns Promise<void>
Promise

login

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:191
deprecated
loginV2 supports platform: ios, android This method do login with UserInfo

Parameters
- params: UserInfo
  
  UserInfo
  
  token | string | optional |
  
  uid | string | required |
Returns Promise<void>
Promise

loginV2

loginV2(userId: string, token?: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:192
Parameters
- userId: string
- Optional token: string
Returns Promise<void>

logout

logout(): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:198
supports platform: ios, android This method do logout.

Returns Promise<void>
Promise

on

on<EventName>(eventName: EventName, callback: RtmEngineEvents[EventName]): void

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:164
deprecated
addListener supports platform: ios, android

events
RtmEngineEvents

Type parameters
- EventName: keyof RtmEngineEvents
Parameters
- eventName: EventName
  
  string required
- callback: RtmEngineEvents[EventName]
  
  (evt) => {} required
Returns void

queryPeersBySubscriptionOption

queryPeersBySubscriptionOption(option: ONLINE): Promise<string[]>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:233
Parameters
- option: ONLINE
Returns Promise<string[]>

queryPeersOnlineStatus

queryPeersOnlineStatus(ids: string[]): Promise<ListPeerStatus>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:229
deprecated
queryPeersOnlineStatusV2 supports platform: ios, android This method enables query peer online user by id array.

Parameters
- ids: string[]
  
  string array
Returns Promise<ListPeerStatus>

Promise ListPeerStatus

items | MemberStatus |

MemberStatus

uid | string | user id|

online | boolean | online state|

queryPeersOnlineStatusV2

queryPeersOnlineStatusV2(peerIds: string[]): Promise<<internal>.PeersOnlineStatus>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:230
Parameters
- peerIds: string[]
Returns Promise<<internal>.PeersOnlineStatus>

refuseRemoteInvitation

refuseRemoteInvitation(remoteInvitationProps: RemoteInvitationProps): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:427
deprecated
refuseRemoteInvitationV2 supports platform: ios, android This method enables refuse remote invitation with RemoteInvitationProps. NOTICE: content bytelength has MAX_SIZE 32kb limit.

Parameters
- remoteInvitationProps: RemoteInvitationProps
  
  RemoteInvitationProps
  
  RemoteInvitationProps
  
  uid | string | required | channelId | string | required |
  
  response | string | optional | 32kb limit |
Returns Promise<void>
Promise

refuseRemoteInvitationV2

refuseRemoteInvitationV2(remoteInvitation: <internal>.RemoteInvitation): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:428
Parameters
- remoteInvitation: <internal>.RemoteInvitation
Returns Promise<void>

release

release(): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:179
Returns Promise<void>

releaseChannel

releaseChannel(channelId: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:373
Parameters
- channelId: string
Returns Promise<void>

removeAllListeners

removeAllListeners<EventType>(event?: EventType): void

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:171
Type parameters
- EventType: keyof <internal>.RtmClientEvents
Parameters
- Optional event: EventType
Returns void

removeAllLocalUserAttributes

removeAllLocalUserAttributes(): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:280
deprecated
clearLocalUserAttributes supports platform: ios, android This method enables you to remove all of local user attributes;

Returns Promise<void>
Promise

removeEvents

removeEvents(): void

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:168
deprecated
removeAllListeners

Returns void

removeListener

removeListener<EventType>(event: EventType, listener: <internal>.RtmClientEvents[EventType]): void

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:170
Type parameters
- EventType: keyof <internal>.RtmClientEvents
Parameters
- event: EventType
- listener: <internal>.RtmClientEvents[EventType]
Returns void

removeLocalUserAttributesByKeys

removeLocalUserAttributesByKeys(keys: string[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:272
deprecated
deleteLocalUserAttributesByKeys supports platform: ios, android This method enables you to remove exists attribute for local user.

Parameters
- keys: string[]
  
  string []
Returns Promise<void>
Promise

renewToken

renewToken(token: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:240
supports platform: ios, android This method do renewToken when got tokenExpired event.

Parameters
- token: string
  
  string
Returns Promise<void>
Promise

replaceLocalUserAttributes

replaceLocalUserAttributes(attributes: UserAttribute[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:263
deprecated
addOrUpdateLocalUserAttributes supports platform: ios, android This method enables you to replace attribute already exists or add attribute wasn't set for local user attributes;

Parameters
- attributes: UserAttribute[]
  
  []
Returns Promise<void>
Promise

sendLocalInvitation

sendLocalInvitation(invitationProps: LocalInvitationProps): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:391
deprecated
sendLocalInvitationV2 supports platform: ios, android This method enables send local invitation with invitationProps. NOTICE: content bytelength has MAX_SIZE 32kb limit.

Parameters
- invitationProps: LocalInvitationProps
  
  LocalInvitationProps
  
  LocalInvitationProps
  
  uid | string | required | channelId | string | required |
  
  content | string | optional | 32kb limit |
Returns Promise<void>
Promise

sendLocalInvitationV2

sendLocalInvitationV2(localInvitation: <internal>.LocalInvitation): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:392
Parameters
- localInvitation: <internal>.LocalInvitation
Returns Promise<void>

sendMessage

sendMessage(channelId: string, message: <internal>.RtmMessage, options: SendMessageOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:353
Parameters
- channelId: string
- message: <internal>.RtmMessage
- options: SendMessageOptions
Returns Promise<void>

sendMessageByChannelId

sendMessageByChannelId(channelId: string, text: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:352
deprecated
sendMessage supports platform: ios, android This method enables send message by channel id. NOTICE: text bytelength has MAX_SIZE 32kb limit.

Parameters
- channelId: string
  
  string.
- text: string
  
  string (bytesize shouldn't >= 32kb)
Returns Promise<void>
Promise

sendMessageToPeer

sendMessageToPeer(params: AgoraPeerMessage): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:211
deprecated
sendMessageToPeerV2 supports platform: ios, android This method do send p2p message with AgoraPeerMessage

Parameters
- params: AgoraPeerMessage
  
  AgoraPeerMessage
  
  peerId | string | required | offline | boolean | requried |
  
  text | string | required |
Returns Promise<void>
Promise

sendMessageToPeerV2

sendMessageToPeerV2(peerId: string, message: <internal>.RtmMessage, options: SendMessageOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:212
Parameters
- peerId: string
- message: <internal>.RtmMessage
- options: SendMessageOptions
Returns Promise<void>

setChannelAttributes

setChannelAttributes(channelId: string, attributes: <internal>.RtmChannelAttribute[], option: ChannelAttributeOptions): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:292
Parameters
- channelId: string
- attributes: <internal>.RtmChannelAttribute[]
- option: ChannelAttributeOptions
Returns Promise<void>

setLocalUserAttributes

setLocalUserAttributes(attributes: UserAttribute[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:254
deprecated
setLocalUserAttributesV2 supports platform: ios, android This method enables set local user attributes with attributes UserAttribute

Parameters
- attributes: UserAttribute[]
  
  []
Returns Promise<void>
Promise

UserAttribute

key | string | required |

value | string | required |

setLocalUserAttributesV2

setLocalUserAttributesV2(attributes: <internal>.RtmAttribute[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:255
Parameters
- attributes: <internal>.RtmAttribute[]
Returns Promise<void>

setLogFile

setLogFile(filePath: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:309
Parameters
- filePath: string
Returns Promise<void>

setLogFileSize

setLogFileSize(fileSizeInKBytes: number): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:311
Parameters
- fileSizeInKBytes: number
Returns Promise<void>

setLogFilter

setLogFilter(filter: LogLevel): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:310
Parameters
- filter: LogLevel
Returns Promise<void>

setParameters

setParameters(parameters: string): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:298
Parameters
- parameters: string
Returns Promise<void>

setSdkLog

setSdkLog(path: string, level: LogLevel, size: number): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:308
deprecated
setLogFile setLogFilter setLogFileSize set sdk log file

Parameters
- path: string
  
  string: specified the generated log path
- level: LogLevel
  
  LogLevel: sdk log level (0: "OFF", 0b1111: "INFO", 0b1110: "WARN", 0b1100: "ERROR", 0b1000: "CRITICAL")
- size: number
  
  number: file size in kbytes Note File size settings of less than 512 KB or greater than 10 MB will not take effect.
Returns Promise<void>
Promise This method will return {path: boolean, level: boolean, size: boolean}

subscribePeersOnlineStatus

subscribePeersOnlineStatus(peerIds: string[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:231
Parameters
- peerIds: string[]
Returns Promise<void>

unsubscribePeersOnlineStatus

unsubscribePeersOnlineStatus(peerIds: string[]): Promise<void>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:232
Parameters
- peerIds: string[]
Returns Promise<void>

Static getSdkVersion

getSdkVersion(): Promise<string>

- Defined in node_modules/agora-react-native-rtm/lib/typescript/RtmEngine.d.ts:328
Returns Promise<string>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns RtmEngine

Methods

acceptRemoteInvitation

Parameters

remoteInvitationProps: RemoteInvitationProps

RemoteInvitationProps

response | string | optional | 32kb limit |

Returns Promise<void>

acceptRemoteInvitationV2

Parameters

remoteInvitation: <internal>.RemoteInvitation

Returns Promise<void>

addListener

Type parameters

EventType: keyof <internal>.RtmClientEvents

Parameters

event: EventType

listener: <internal>.RtmClientEvents[EventType]

Returns EmitterSubscription

addOrUpdateChannelAttributes

Parameters

channelId: string

attributes: <internal>.RtmChannelAttribute[]

option: ChannelAttributeOptions

Returns Promise<void>

addOrUpdateLocalUserAttributes

Parameters

attributes: <internal>.RtmAttribute[]

Returns Promise<void>

cancelLocalInvitation

Parameters

invitationProps: LocalInvitationProps

LocalInvitationProps

content | string | optional | 32kb limit |

Returns Promise<void>

cancelLocalInvitationV2

Parameters

localInvitation: <internal>.LocalInvitation

Returns Promise<void>

clearChannelAttributes

Parameters

channelId: string

option: ChannelAttributeOptions

Returns Promise<void>

clearLocalUserAttributes

Returns Promise<void>

createClient

Parameters

appId: string

Returns Promise<void>

createInstance

Parameters

appId: string

Returns Promise<void>

createLocalInvitation

Parameters

calleeId: string

Optional content: string

Optional channelId: string

Returns Promise<<internal>.LocalInvitation>

deleteChannelAttributesByKeys

Parameters

channelId: string

attributeKeys: string[]

option: ChannelAttributeOptions

Returns Promise<void>

deleteLocalUserAttributesByKeys

Parameters

attributeKeys: string[]

Returns Promise<void>

destroyClient

Returns Promise<void>

getChannelAttributes

Parameters