@capgo/capacitor-crisp
v6.0.53
Published
Crisp native SDK for capacitor
Downloads
2,020
Maintainers
Readme
capacitor-crisp
Install
npm install @capgo/capacitor-crisp
npx cap sync
Init
Call configure in your code Before any other method :
import { CapacitorCrisp } from '@capgo/capacitor-crisp';
CapacitorCrisp.configure({websiteID: '******-****-****-****-********'})
iOS
To enable your users to take and upload photos to the chat as well as download photos to their photo library, add :
Privacy - Camera Usage Description (NSCameraUsageDescription)
Privacy - Photo Library Additions Usage Description (NSPhotoLibraryAddUsageDescription)
to your app's Info.plist.
Android Integration
Nothing special to do.
Open chatbox
import { CapacitorCrisp } from '@capgo/capacitor-crisp';
CapacitorCrisp.openMessenger()
API
configure(...)
openMessenger()
setTokenID(...)
setUser(...)
pushEvent(...)
setCompany(...)
setInt(...)
setString(...)
sendMessage(...)
setSegment(...)
reset()
- Type Aliases
configure(...)
configure(data: { websiteID: string; }) => any
| Param | Type |
| ---------- | ----------------------------------- |
| data
| { websiteID: string; } |
Returns: any
openMessenger()
openMessenger() => any
Returns: any
setTokenID(...)
setTokenID(data: { tokenID: string; }) => any
| Param | Type |
| ---------- | --------------------------------- |
| data
| { tokenID: string; } |
Returns: any
setUser(...)
setUser(data: { nickname?: string; phone?: string; email?: string; avatar?: string; }) => any
| Param | Type |
| ---------- | ------------------------------------------------------------------------------------ |
| data
| { nickname?: string; phone?: string; email?: string; avatar?: string; } |
Returns: any
pushEvent(...)
pushEvent(data: { name: string; color: eventColor; }) => any
| Param | Type |
| ---------- | --------------------------------------------------------------------------- |
| data
| { name: string; color: eventColor; } |
Returns: any
setCompany(...)
setCompany(data: { name: string; url?: string; description?: string; employment?: [title: string, role: string]; geolocation?: [country: string, city: string]; }) => any
| Param | Type |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| data
| { name: string; url?: string; description?: string; employment?: [title: string, role: string]; geolocation?: [country: string, city: string]; } |
Returns: any
setInt(...)
setInt(data: { key: string; value: number; }) => any
| Param | Type |
| ---------- | -------------------------------------------- |
| data
| { key: string; value: number; } |
Returns: any
setString(...)
setString(data: { key: string; value: string; }) => any
| Param | Type |
| ---------- | -------------------------------------------- |
| data
| { key: string; value: string; } |
Returns: any
sendMessage(...)
sendMessage(data: { value: string; }) => any
| Param | Type |
| ---------- | ------------------------------- |
| data
| { value: string; } |
Returns: any
setSegment(...)
setSegment(data: { segment: string; }) => any
| Param | Type |
| ---------- | --------------------------------- |
| data
| { segment: string; } |
Returns: any
reset()
reset() => any
Returns: any
Type Aliases
eventColor
"red" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "brown" | "grey" | "black"