ConversationClient class

Inheritance

Constructors

ConversationClient.new()

Properties

connectionState ↔ ConnectionState
getter/setter pair
conversations ↔ Map<String, Conversation>
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
isReachabilityEnabled → bool
no setter
myIdentity ↔ String?
getter/setter pair
onAddedToConversationNotification ↔ Stream<String>
Called when client receives a push notification for added to Conversation event.
getter/setter pair
onClientSynchronization ↔ Stream<ClientSynchronizationStatus>
Called when client synchronization status changes.
getter/setter pair
onConnectionState ↔ Stream<ConnectionState>
Called when client connnection state has changed.
getter/setter pair
onConversationAdded ↔ Stream<Conversation>
Called when the current user has a conversation added to their conversation list, conversation status is not specified.
getter/setter pair
onConversationDeleted ↔ Stream<Conversation>
Called when one of the conversation of the current user is deleted.
getter/setter pair
onConversationSynchronizationChange ↔ Stream<Conversation>
Called when conversation synchronization status changed.
getter/setter pair
onConversationUpdated ↔ Stream<ConversationUpdatedEvent>
Called when the conversation is updated.
getter/setter pair
onError ↔ Stream<ErrorInfo>
Called when an error condition occurs.
getter/setter pair
onNewMessageNotification ↔ Stream<NewMessageNotificationEvent>
Called when client receives a push notification for new message.
getter/setter pair
onNotificationDeregistered ↔ Stream<NotificationRegistrationEvent>
Called when attempt to register device for notifications has completed.
getter/setter pair
onNotificationFailed ↔ Stream<ErrorInfo>
Called when registering for push notifications fails.
getter/setter pair
onNotificationRegistered ↔ Stream<NotificationRegistrationEvent>
Called when attempt to register device for notifications has completed.
getter/setter pair
onRemovedFromConversationNotification ↔ Stream<String>
Called when client receives a push notification for removed from conversation event.
getter/setter pair
onTokenAboutToExpire ↔ Stream<void>
Called when token is about to expire soon.
getter/setter pair
onTokenExpired ↔ Stream<void>
Called when token has expired.
getter/setter pair
onUserSubscribed ↔ Stream<User>
Called when a user is subscribed to and will receive realtime state updates.
getter/setter pair
onUserUnsubscribed ↔ Stream<User>
Called when a user is unsubscribed from and will not receive realtime state updates anymore.
getter/setter pair
onUserUpdated ↔ Stream<UserUpdatedEvent>
Called when user info is updated for currently loaded users.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addedToConversationNotification(String conversationSid) → void
override
clientSynchronization(String synchronizationStatus) → void
override
connectionStateChange(String connectionState) → void
override
conversationAdded(ConversationData conversationData) → void
override
conversationDeleted(ConversationData conversationData) → void
override
conversationSynchronizationChange(ConversationData conversationData) → void
override
conversationUpdated(ConversationUpdatedData event) → void
override
createConversation({required String friendlyName}) → Future<Conversation?>
deregistered() → void
override
deregistrationFailed(ErrorInfoData errorInfoData) → void
override
error(ErrorInfoData errorInfoData) → void
override
getConversation(String conversationSidOrUniqueName) → Future<Conversation?>
getMyConversations() → Future<List<Conversation>>
getMyUser() → Future<User?>
messageAdded(String conversationSid, MessageData messageData) → void
override
messageDeleted(String conversationSid, MessageData messageData) → void
override
messageUpdated(String conversationSid, MessageData messageData, String reason) → void
override
newMessageNotification(String conversationSid, int messageIndex) → void
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notificationFailed(ErrorInfoData errorInfoData) → void
override
notificationSubscribed() → void
override
participantAdded(String conversationSid, ParticipantData participantData) → void
override
participantDeleted(String conversationSid, ParticipantData participantData) → void
override
participantUpdated(String conversationSid, ParticipantData participantData, String reason) → void
override
registered() → void
override
registerForNotification(String? token) → Future<void>
Registers for push notifications. Uses APNs on iOS and FCM on Android.
registrationFailed(ErrorInfoData errorInfoData) → void
override
removedFromConversationNotification(String conversationSid) → void
override
shutdown() → Future<void>
Shuts down the conversation client.
synchronizationChanged(String conversationSid, ConversationData conversationData) → void
override
tokenAboutToExpire() → void
override
tokenExpired() → void
override
toString() → String
A string representation of this object.
inherited
typingEnded(String conversationSid, ConversationData conversationData, ParticipantData participantData) → void
override
typingStarted(String conversationSid, ConversationData conversationData, ParticipantData participantData) → void
override
unregisterForNotification(String? token) → Future<void>
Unregisters for push notifications. Uses APNs on iOS and FCM on Android.
updateConversationFromMap(Map<String, dynamic> map) → void
updateFromMap(Map<String, dynamic> json) → void
updateToken(String token) → Future<void>
Updates the authentication token for this client.
userSubscribed(UserData userData) → void
override
userUnsubscribed(UserData userData) → void
override
userUpdated(UserData userData, String reason) → void
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited