# 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

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

## Usage

API keys are in Zendesk Admin center on Messaging page

```bash
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

<docgen-index>

* [`initialize(...)`](#initialize)
* [`setAnonymousIdentity(...)`](#setanonymousidentity)
* [`setIdentity(...)`](#setidentity)
* [`openChat()`](#openchat)
* [`closeChat()`](#closechat)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### initialize(...)

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

| Param         | Type                                                            |
| ------------- | --------------------------------------------------------------- |
| **`options`** | <code><a href="#initializeoptions">InitializeOptions</a></code> |

--------------------


### setAnonymousIdentity(...)

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

| Param         | Type                                                          |
| ------------- | ------------------------------------------------------------- |
| **`options`** | <code><a href="#anonymousoptions">AnonymousOptions</a></code> |

--------------------


### setIdentity(...)

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

| Param        | Type                                                      |
| ------------ | --------------------------------------------------------- |
| **`option`** | <code><a href="#identityoption">IdentityOption</a></code> |

--------------------


### openChat()

```typescript
openChat() => Promise<void>
```

--------------------


### closeChat()

```typescript
closeChat() => Promise<void>
```

--------------------


### Interfaces


#### InitializeOptions

| Prop                | Type                 |
| ------------------- | -------------------- |
| **`iosChatId`**     | <code>string</code>  |
| **`androidChatId`** | <code>string</code>  |
| **`webClientId`**   | <code>string</code>  |
| **`debugLog`**      | <code>boolean</code> |


#### AnonymousOptions

| Prop        | Type                |
| ----------- | ------------------- |
| **`name`**  | <code>string</code> |
| **`email`** | <code>string</code> |


#### IdentityOption

| Prop        | Type                |
| ----------- | ------------------- |
| **`token`** | <code>string</code> |

</docgen-api>