@sencrop/capacitor-intercom

Intercom Plugin for Capacitor

Install

``bash
npm install @sencrop/capacitor-intercom
npx cap sync
`

API

* initialize(...)
* loginIdentifiedUser(...)
* loginUnidentifiedUser()
* updateUser(...)
* logout()
* logEvent(...)
* displayMessenger()
* displayMessageComposer(...)
* displayHelpCenter()
* displayArticle(...)
* hideMessenger()
* displayLauncher()
* hideLauncher()
* setCustomAttributes(...)
* displaySurvey(...)
* Interfaces
* Type Aliases

$3

`typescript
initialize(config: IntercomSettings) => void
`

| Param | Type |
| ------------ | ------------------------------------------------------------- |
| config | IntercomSettings |

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

$3

`typescript
loginIdentifiedUser(identity: IntercomIdentity) => Promise
`

| Param | Type |
| -------------- | ------------------------------------------------------------- |
| identity | IntercomIdentity |

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

$3

`typescript
loginUnidentifiedUser() => Promise
`

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

$3

`typescript
updateUser(user: IntercomUser) => Promise
`

| Param | Type |
| ---------- | ----------------------------------------------------- |
| user | IntercomUser |

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

$3

`typescript
logout() => Promise
`

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

$3

`typescript
logEvent(event: IntercomEvent) => Promise
`

| Param | Type |
| ----------- | ------------------------------------------------------- |
| event | IntercomEvent |

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

$3

`typescript
displayMessenger() => Promise
`

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

$3

`typescript
displayMessageComposer(message: IntercomMessage) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| message | IntercomMessage |

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

$3

`typescript
displayHelpCenter() => Promise
`

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

$3

`typescript
displayArticle(article: IntercomArticle) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| article | IntercomArticle |

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

$3

`typescript
hideMessenger() => Promise
`

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

$3

`typescript
displayLauncher() => Promise
`

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

$3

`typescript
hideLauncher() => Promise
`

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

$3

`typescript
setCustomAttributes(payload: IntercomCustomAttributes) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------------------------- |
| payload | IntercomCustomAttributes |

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

$3

`typescript
displaySurvey(survey: IntercomSurvey) => Promise
`

| Param | Type |
| ------------ | --------------------------------------------------------- |
| survey | IntercomSurvey |

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

$3


#### IntercomSettings

| Prop | Type |
| ------------------------------ | ----------------------------------------------------------- |
| app_id | string |
| api_base | string |
| alignment | string |
| custom_launcher_selector | string |
| hide_default_launcher | boolean |
| horizontal_padding | number |
| session_duration | number |
| vertical_padding | number |
| action_color | string |
| background_color | string |
| email | string |
| phone | string |
| created_at | number |
| name | string |
| user_id | string |
| user_hash | string |
| unsubscribed_from_emails | boolean |
| language_override | string |
| utm_campaign | string |
| utm_content | string |
| utm_medium | string |
| utm_source | string |
| utm_term | string |
| company | IntercomCompany |
| companies | IntercomCompany[] |
| avatar | IntercomAvatar |


#### IntercomCompany

| Prop | Type |
| ----------------------- | ----------------------------- |
| name | string |
| id | string \| number |
| company_id | string \| number |
| created_at | number |
| remote_created_at | number |
| plan | string |
| monthly_spend | number |
| user_count | number |
| size | number |
| website | string |
| industry | string |


#### IntercomAvatar

| Prop | Type |
| --------------- | --------------------- |
| type | 'avatar' |
| image_url | string |


#### IntercomIdentity

| Prop | Type |
| -------------- | ------------------- |
| userId | string |
| email | string |
| userHash | string |


#### IntercomUser

| Prop | Type |
| -------------- | ------------------- |
| email | string |
| phone | string |
| name | string |
| language | string |


#### IntercomEvent

| Prop | Type |
| ---------- | ------------------- |
| name | string |
| data | any |


#### IntercomMessage

| Prop | Type |
| ------------- | ------------------- |
| content | string |


#### IntercomArticle

| Prop | Type |
| -------- | ------------------- |
| id | number |


#### IntercomCustomAttributes

| Prop | Type |
| ---------------- | ------------------------------------------------------------------------------------ |
| attributes | Record<string, number \| string \| boolean> |


#### IntercomSurvey

| Prop | Type |
| -------- | ------------------- |
| id` | number |

$3

#### Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }