zendesk
Version: stable
Functions
zendesk.initialize()
zendesk.initialize()
Initialize the Zendesk SDK
PARAMETERS
None
zendesk.set_callback()
zendesk.set_callback()
Set a callback for events from the Zendesk SDK
PARAMETERS
None
zendesk.show_messaging()
zendesk.show_messaging()
Show the conversation screen.
PARAMETERS
None
zendesk.set_conversation_fields()
zendesk.set_conversation_fields()
Set conversation fields in the SDK to add contextual data about the conversation.
PARAMETERS
None
zendesk.clear_conversation_fields()
zendesk.clear_conversation_fields()
Clear conversation fields from the SDK storage when the client side context changes.
PARAMETERS
None
zendesk.set_conversation_tags()
Set custom conversation tags in the SDK to add contextual data about the conversation.
PARAMETERS
None
zendesk.clear_conversation_tags()
Clear conversation tags from SDK storage when the client side context changes.
PARAMETERS
None
zendesk.login()
zendesk.login()
Authenticate a user.
PARAMETERS
None
zendesk.logout()
zendesk.logout()
Unauthenticate a user.
PARAMETERS
None
Constants
MSG_INIT_ERROR
An error was detected while initializing the Zendesk SDK
MSG_INIT_SUCCESS
The Zendesk SDK has been initialized successfully
MSG_INTERNAL_ERROR
An internal error occured
MSG_ERROR
An generic error occured
MSG_UNREAD_MESSAGE_COUNT_CHANGED
The number of unread messages has changed
MSG_AUTHENTICATION_FAILED
A REST call failed for authentication reasons
MSG_FIELD_VALIDATION_FAILED
Validation checks failed for conversation fields
MSG_LOGIN_SUCCESS
Login was successful
MSG_LOGIN_FAILED
Login failed
MSG_LOGOUT_SUCCESS
Logout was successful
MSG_LOGOUT_FAILED
Logout failed