0.0.6 • Published 2 years ago

capacitor-plugin-zendesk-chat v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

capacitor-plugin-zendesk-chat

This capacitor plugin implement Zendesk messaging into IOS, Android and web platforms.

Zendesk documentation here https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/

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

Usage

API keys are in Zendesk Admin center on Messaging page

import { ZendeskSupport } from "capacitor-plugin-zendesk-support";

await ZendeskSupport.initialize({
      iosChatId: 'ios chat id',
      androidChatId: 'android chat id',
      webClientId: 'web widget key',
      debugLog: false
});

await ZendeskSupport.openChat();

API

initialize(...)

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

setAnonymousIdentity(...)

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

setIdentity(...)

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

openChat()

openChat() => Promise<void>

closeChat()

closeChat() => Promise<void>

Interfaces

InitializeOptions

PropType
iosChatIdstring
androidChatIdstring
webClientIdstring
debugLogboolean

AnonymousOptions

PropType
namestring
emailstring

IdentityOption

PropType
tokenstring