Class Zendesk

Index

Constructors

Methods

changeTheme healthCheck initializeChat listTickets openArticle openHelpCenter openNewTicket openTicket setAnonymousIdentity setHelpCenterLocaleOverride setIdentity startAnswerBot startChat

Constructors

constructor

new Zendesk(config): Zendesk
Parameters
- config: ZendeskConfig
Returns Zendesk
- Defined in index.tsx:19

Methods

changeTheme

changeTheme(color): Promise<void>
iOS only: Changes the color theme of the Zendesk Help Center.
Parameters
- color: string
  The color to change the theme to.
Returns Promise<void>
- Defined in index.tsx:100

healthCheck

healthCheck(): Promise<string>
Indicates whether the module is working correctly. This method is useful for testing the module after initialization. If the module is not working correctly, an error will be returned.

Returns Promise<string>
- Defined in index.tsx:28

initializeChat

initializeChat(accountKey): Promise<void>
Initializes the Zendesk Chat SDK.
Parameters
- accountKey: string
  The Zendesk account key.
Returns Promise<void>
- Defined in index.tsx:108

listTickets

listTickets(): Promise<void>
Lets you show a list of the user's tickets. The user can review and update their tickets.

Returns Promise<void>
- Defined in index.tsx:74

openArticle

openArticle(articleId): Promise<void>
Opens an article with the given ID.
Parameters
- articleId: number
  The ID of the article to open.
Returns Promise<void>
- Defined in index.tsx:82

openHelpCenter

openHelpCenter(options): Promise<void>
Opens the Zendesk Help Center.
Parameters
- options: OpenHelpCenterOptions
Returns Promise<void>
- Defined in index.tsx:52

openNewTicket

openNewTicket(options): Promise<void>
Opens the ticket creation screen.
Parameters
- options: OpenNewTicketOptions
Returns Promise<void>
- Defined in index.tsx:67

openTicket

openTicket(ticketId): Promise<void>
Opens a ticket with the given ID.
Parameters
- ticketId: string
  The ID of the ticket to open.
Returns Promise<void>
- Defined in index.tsx:60

setAnonymousIdentity

setAnonymousIdentity(options): Promise<boolean>
Sets an anonymous identity for the user using an email and/or name.
Parameters
- options: SetAnonymousIdentityOptions
Returns Promise<boolean>
- Defined in index.tsx:35

setHelpCenterLocaleOverride

setHelpCenterLocaleOverride(locale): Promise<void>
Overrides the device locale and forces the Help Center to a specific language.
Parameters
- locale: string
Returns Promise<void>
- Defined in index.tsx:92

setIdentity

setIdentity(jwt): Promise<boolean>
Sets the identity of the user using a JWT.
Parameters
- jwt: string
  The JWT to use for the identity.
Returns Promise<boolean>
- Defined in index.tsx:45

startAnswerBot

startAnswerBot(): Promise<void>
Opens the Zendesk Answer Bot screen.

Returns Promise<void>
- Defined in index.tsx:123

startChat

startChat(options?): Promise<void>
Opens the Zendesk Chat screen.
Parameters
- Optional options: StartChatOptions
  The StartChatOptions to use to start the chat.
Returns Promise<void>
- Defined in index.tsx:116

Generated using TypeDoc