RuutCallbacks class FlutterClientSdk

Ruut callback are specified for each created client instance. Methods are triggered when a method satisfying their respective conditions occur.

Constructors

RuutCallbacks({void onWelcome()?, void onPing()?, void onConfirmedSubscription()?, void onMessageReceived(RuutMessage)?, void onMessageSent(RuutMessage, String)?, void onMessageDelivered(RuutMessage, String)?, void onMessageUpdated(RuutMessage)?, void onPersistedMessagesRetrieved(List<RuutMessage>)?, void onMessagesRetrieved(List<RuutMessage>)?, void onConversationStartedTyping()?, void onConversationStoppedTyping()?, void onConversationIsOnline()?, void onConversationIsOffline()?, void onConversationResolved()?, void onError(RuutClientException)?})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onConfirmedSubscription ↔ void Function()?

Triggered when a subscription confirmation event/message is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onConversationIsOffline ↔ void Function()?

Triggered when a presence update event/message RuutEventMessageType.presence_update is received after connecting to the ruut websocket and conversation is offline. See RuutRepository.listenForEvents

getter/setter pair

onConversationIsOnline ↔ void Function()?

Triggered when a presence update event/message RuutEventMessageType.presence_update is received after connecting to the ruut websocket and conversation is online. See RuutRepository.listenForEvents

getter/setter pair

onConversationResolved ↔ void Function()?

Triggered when an agent resolves the current conversation

getter/setter pair

onConversationStartedTyping ↔ void Function()?

Triggered when a conversation typing on event/message RuutEventMessageType.conversation_typing_on is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onConversationStoppedTyping ↔ void Function()?

Triggered when a conversation typing off event/message RuutEventMessageType.conversation_typing_off is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onError ↔ void Function(RuutClientException)?

Triggered when any error occurs in ruut client's operations with the error

getter/setter pair

onMessageDelivered ↔ void Function(RuutMessage, String)?

Triggered when a message created event/message RuutEventMessageType.message_created is received and message belongs to current user after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onMessageReceived ↔ void Function(RuutMessage)?

Triggered when a message created event/message RuutEventMessageType.message_created is received and message doesn't belong to current user after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onMessageSent ↔ void Function(RuutMessage, String)?

getter/setter pair

onMessagesRetrieved ↔ void Function(List<RuutMessage>)?

Triggered when a conversation's messages is successfully retrieved from remote server

getter/setter pair

onMessageUpdated ↔ void Function(RuutMessage)?

Triggered when a message created event/message RuutEventMessageType.message_updated is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onPersistedMessagesRetrieved ↔ void Function(List<RuutMessage>)?

Triggered when a conversation's messages persisted on device are successfully retrieved

getter/setter pair

onPing ↔ void Function()?

Triggered when a ping event/message is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

onWelcome ↔ void Function()?

Triggered when a welcome event/message is received after connecting to the ruut websocket. See RuutRepository.listenForEvents

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited