ZendeskMessaging class

Constructors

ZendeskMessaging()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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

Static Methods

clearConversationFields() Future<void>
Remove all the fields on the current support ticket
clearConversationTags() Future<void>
Remove all the tags on the current support ticket
getUnreadMessageCount() Future<int>
Retrieve unread messages count from the Zendesk SDK
initialize({required String androidChannelKey, required String iosChannelKey}) Future<void>
Initialize the Zendesk SDK for Android and iOS
invalidate() Future<void>
Invalidates the current instance of ZendeskMessaging. After calling this method you will have to call ZendeskMessaging.initialize again if you would like to use ZendeskMessaging.
isInitialized() Future<bool>
Check if the Zendesk SDK for Android and iOS is already initialized
isLoggedIn() Future<bool>
Check if the user is already logged in
loginUser({required String jwt}) Future<ZendeskLoginResponse>
Helper function to login waiting for future to complete
loginUserCallbacks({required String jwt, dynamic onSuccess(String? id, String? externalId)?, dynamic onFailure()?}) Future<void>
Authenticate the current session with a JWT
logoutUser() Future<void>
Helper function to logout waiting for future to complete
logoutUserCallbacks({dynamic onSuccess()?, dynamic onFailure()?}) Future<void>
Logout the currently authenticated user
setConversationFields(Map<String, String> fields) Future<void>
Set values for conversation fields in the SDK to add contextual data about the conversation.
setConversationTags(List<String> tags) Future<void>
Add a list of tags to a support ticket
setMessageHandler(dynamic handler(ZendeskMessagingMessageType type, Map? arguments)?) → void
Attach a global observer for incoming messages
show() Future<void>
Start the Zendesk Messaging UI