AgoraRtmClient class

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onConnectionStateChanged ← (dynamic Function(int state, int reason)?)

onConnectionStateChanged2

no getter

onConnectionStateChanged2 ↔ (void Function(RtmConnectionState state, RtmConnectionChangeReason reason)?)

Occurs when the connection state between the SDK and the Agora RTM system changes.

getter/setter pair

onError ↔ (void Function(dynamic error)?)

Occurs when you receive error events.

getter/setter pair

onLocalInvitationAccepted ← (dynamic Function(LocalInvitation invite, String response)?)

AgoraRtmCallManager.onLocalInvitationAccepted

no getter

onLocalInvitationCanceled ← (void Function(LocalInvitation invite)?)

AgoraRtmCallManager.onLocalInvitationCanceled

no getter

onLocalInvitationFailure ← (void Function(LocalInvitation invite, int errorCode)?)

AgoraRtmCallManager.onLocalInvitationFailure

no getter

onLocalInvitationReceivedByPeer ← (dynamic Function(LocalInvitation invite)?)

AgoraRtmCallManager.onLocalInvitationReceivedByPeer

no getter

onLocalInvitationRefused ← (void Function(LocalInvitation invite, String response)?)

AgoraRtmCallManager.onLocalInvitationRefused

no getter

onMessageReceived ↔ (void Function(RtmMessage message, String peerId)?)

Occurs when the local user receives a peer-to-peer message.

getter/setter pair

onPeersOnlineStatusChanged ↔ (void Function(Map<String, RtmPeerOnlineState> peersStatus)?)

getter/setter pair

onRemoteInvitationAccepted ← (void Function(RemoteInvitation invite)?)

AgoraRtmCallManager.onRemoteInvitationAccepted

no getter

onRemoteInvitationCanceled ← (void Function(RemoteInvitation invite)?)

AgoraRtmCallManager.onRemoteInvitationCanceled

no getter

onRemoteInvitationFailure ← (void Function(RemoteInvitation invite, int errorCode)?)

AgoraRtmCallManager.onRemoteInvitationFailure

no getter

onRemoteInvitationReceivedByPeer ← (void Function(RemoteInvitation invite)?)

AgoraRtmCallManager.onRemoteInvitationReceived

no getter

onRemoteInvitationRefused ← (void Function(RemoteInvitation invite)?)

AgoraRtmCallManager.onRemoteInvitationRefused

no getter

onTokenExpired ↔ (void Function()?)

Occurs when your token expires.

getter/setter pair

onTokenPrivilegeWillExpire ↔ (void Function()?)

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acceptRemoteInvitation(Map<String, dynamic> arguments) → Future<void>

AgoraRtmCallManager.acceptRemoteInvitation

addOrUpdateChannelAttributes(String channelId, List<RtmChannelAttribute> attributes, bool enableNotificationToChannelMembers) → Future<void>

addOrUpdateChannelAttributes2

addOrUpdateChannelAttributes2(String channelId, List<RtmChannelAttribute> attributes, [ChannelAttributeOptions? option]) → Future<void>

Adds or updates the channel's attribute(s).

addOrUpdateLocalUserAttributes(List<Map<String, String>> attributes) → Future<void>

addOrUpdateLocalUserAttributes2

addOrUpdateLocalUserAttributes2(List<RtmAttribute> attributes) → Future<void>

Adds or updates the local user’s attribute(s).

cancelLocalInvitation(Map<String, dynamic> arguments) → Future<void>

AgoraRtmCallManager.cancelLocalInvitation

clearChannelAttributes(String channelId, bool enableNotificationToChannelMembers) → Future<void>

clearChannelAttributes2

clearChannelAttributes2(String channelId, [ChannelAttributeOptions? option]) → Future<void>

Clears all attributes of the channel.

clearLocalUserAttributes() → Future<void>

Clears all attributes of the local user.

createChannel(String channelId) → Future<AgoraRtmChannel?>

Creates an AgoraRtmChannel.

createRawMessage(Uint8List raw, String? description) → RtmMessage

createTextMessage(String text) → RtmMessage

deleteChannelAttributesByKeys(String channelId, List<String> keys, bool enableNotificationToChannelMembers) → Future<void>

deleteChannelAttributesByKeys2

deleteChannelAttributesByKeys2(String channelId, List<String> attributeKeys, [ChannelAttributeOptions? option]) → Future<void>

Deletes the channel's attributes using attribute keys.

deleteLocalUserAttributesByKeys(List<String> attributeKeys) → Future<void>

Deletes the local user’s attributes using attribute keys.

destroy() → Future<void>

getChannelAttributes(String channelId) → Future<List<RtmChannelAttribute>>

Gets all attributes of a specified channel.

getChannelAttributesByKeys(String channelId, List<String> attributeKeys) → Future<List<RtmChannelAttribute>>

Gets the attributes of a specified channel using attribute keys.

getChannelMemberCount(List<String> channelIds) → Future<List<RtmChannelMemberCount>>

getRtmCallManager() → AgoraRtmCallManager

getUserAttributes(String userId) → Future<Map<String, dynamic>>

getUserAttributes2

getUserAttributes2(String userId) → Future<List<RtmAttribute>>

Gets all attributes of a specified user.

getUserAttributesByKeys(String userId, List<String> keys) → Future<Map<String, dynamic>>

getUserAttributesByKeys2

getUserAttributesByKeys2(String userId, List<String> attributeKeys) → Future<List<RtmAttribute>>

Gets the attributes of a specified user using attribute keys.

login(String? token, String userId) → Future<void>

Allows a user to log in the Agora RTM system.

logout() → Future<void>

Allows a user to log out of the Agora RTM system.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

queryPeersBySubscriptionOption(RtmPeerSubscriptionOption option) → Future<List<String>>

queryPeersOnlineStatus(List<String> peerIds) → Future<Map<String, RtmPeerOnlineState>>

Queries the online status of the specified user(s).

refuseRemoteInvitation(Map<String, dynamic> arguments) → Future<void>

AgoraRtmCallManager.refuseRemoteInvitation

release() → Future<void>

Destroy and stop event to the client with related channels.

releaseChannel(String channelId) → Future<void>

AgoraRtmChannel.release

renewToken(String token) → Future<void>

Renews the token.

sendLocalInvitation(Map<String, dynamic> arguments) → Future<void>

AgoraRtmCallManager.sendLocalInvitation

sendMessageToPeer(String peerId, RtmMessage message, [bool? offline, bool? historical]) → Future<void>

sendMessageToPeer2

sendMessageToPeer2(String peerId, RtmMessage message, [SendMessageOptions? options]) → Future<void>

Allows a user to send a peer-to-peer message to a specific peer user.

setChannelAttributes(String channelId, List<RtmChannelAttribute> attributes, bool enableNotificationToChannelMembers) → Future<void>

setChannelAttributes2

setChannelAttributes2(String channelId, List<RtmChannelAttribute> attributes, [ChannelAttributeOptions? option]) → Future<void>

Substitutes the channel attributes with new ones.

setLocalUserAttributes(List<Map<String, String>> attributes) → Future<void>

setLocalUserAttributes2

setLocalUserAttributes2(List<RtmAttribute> attributes) → Future<void>

Substitutes the local user’s attributes with new ones.

setLog(int level, int size, String path) → Future<void>

setLogFile setLogFilter setLogFileSize

setLogFile(String filePath) → Future<void>

setLogFileSize(int fileSizeInKBytes) → Future<void>

setLogFilter(RtmLogFilter filter) → Future<void>

setParameters(String parameters) → Future<void>

subscribePeersOnlineStatus(List<String> peerIds) → Future<void>

toString() → String

A string representation of this object.

inherited

unsubscribePeersOnlineStatus(List<String> peerIds) → Future<void>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

createInstance(String appId) → Future<AgoraRtmClient>

Initializes an AgoraRtmClient instance

getChannels(int clientIndex) → Map<String, AgoraRtmChannel>?

getSdkVersion() → Future<String>

get the agora native sdk version

setRtmServiceContext(RtmServiceContext context) → Future<void>