capacitor-plugin-zendesk-support

This page gives you the basic steps for getting up and running with the Support SDK.

Install

npm install capacitor-plugin-zendesk-support
npx cap sync

API

• initialize(...)
• setAnonymousIdentity(...)
• setIdentity(...)
• showHelpCenter(...)
• showTicketRequest(...)
• showUserTickets()
• Interfaces

initialize(...)

initialize(options: InitializeOptions) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | InitializeOptions |

setAnonymousIdentity(...)

setAnonymousIdentity(options: AnonymousOptions) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | AnonymousOptions |

setIdentity(...)

setIdentity(option: IdentityOption) => Promise<void>

| Param | Type | | ------------ | --------------------------------------------------------- | | option | IdentityOption |

showHelpCenter(...)

showHelpCenter(options?: HelpCenterOptions | undefined) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | HelpCenterOptions |

showTicketRequest(...)

showTicketRequest(options?: TicketRequestOptions | undefined) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | TicketRequestOptions |

showUserTickets()

showUserTickets() => Promise<void>

Interfaces

InitializeOptions

| Prop | Type | | ---------------- | -------------------- | | zendeskUrl | string | | appId | string | | clientId | string | | debugLog | boolean |

AnonymousOptions

| Prop | Type | | ----------- | ------------------- | | name | string | | email | string |

IdentityOption

| Prop | Type | | ----------- | ------------------- | | token | string |

HelpCenterOptions

| Prop | Type | | -------------- | --------------------- | | groupBy | string | | groupIds | number[] | | labels | string[] |

TicketRequestOptions

| Prop | Type | | ------------- | --------------------- | | subject | string | | tags | string[] | | fields | string[] |