6.2.3 • Published 1 year ago

@kevinfav/capacitor-intercom v6.2.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@kevinfav/capacitor-intercom

Fork from @sencrop/capacitor-intercom

Intercom Plugin for Capacitor 6+

Install

npm install @kevinfav/capacitor-intercom
npx cap sync

API

initialize(...)

initialize(config: IntercomSettings) => void
ParamType
configIntercomSettings

loginIdentifiedUser(...)

loginIdentifiedUser(identity: IntercomIdentity) => Promise<void>
ParamType
identityIntercomIdentity

loginUnidentifiedUser()

loginUnidentifiedUser() => Promise<void>

updateUser(...)

updateUser(user: IntercomUser) => Promise<void>
ParamType
userIntercomUser

logout()

logout() => Promise<void>

logEvent(...)

logEvent(event: IntercomEvent) => Promise<void>
ParamType
eventIntercomEvent

displayMessenger()

displayMessenger() => Promise<void>

displayMessageComposer(...)

displayMessageComposer(message: IntercomMessage) => Promise<void>
ParamType
messageIntercomMessage

displayHelpCenter()

displayHelpCenter() => Promise<void>

displayArticle(...)

displayArticle(article: IntercomArticle) => Promise<void>
ParamType
articleIntercomArticle

hideMessenger()

hideMessenger() => Promise<void>

displayLauncher()

displayLauncher() => Promise<void>

hideLauncher()

hideLauncher() => Promise<void>

setCustomAttributes(...)

setCustomAttributes(payload: IntercomCustomAttributes) => Promise<void>
ParamType
payloadIntercomCustomAttributes

displaySurvey(...)

displaySurvey(survey: IntercomSurvey) => Promise<void>
ParamType
surveyIntercomSurvey

Interfaces

IntercomSettings

PropType
app_idstring
api_basestring
alignmentstring
custom_launcher_selectorstring
hide_default_launcherboolean
horizontal_paddingnumber
session_durationnumber
vertical_paddingnumber
action_colorstring
background_colorstring
emailstring
phonestring
created_atnumber
namestring
user_idstring
user_hashstring
unsubscribed_from_emailsboolean
language_overridestring
utm_campaignstring
utm_contentstring
utm_mediumstring
utm_sourcestring
utm_termstring
companyIntercomCompany
companiesIntercomCompany[]
avatarIntercomAvatar

IntercomCompany

PropType
namestring
idstring | number
company_idstring | number
created_atnumber
remote_created_atnumber
planstring
monthly_spendnumber
user_countnumber
sizenumber
websitestring
industrystring

IntercomAvatar

PropType
type'avatar'
image_urlstring

IntercomIdentity

PropType
userIdstring
emailstring
userHashstring

IntercomUser

PropType
emailstring
phonestring
namestring
languagestring

IntercomEvent

PropType
namestring
dataany

IntercomMessage

PropType
contentstring

IntercomArticle

PropType
idnumber

IntercomCustomAttributes

PropType
attributesRecord<string, number | string | boolean>

IntercomSurvey

PropType
idnumber

Type Aliases

Record

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

{

}

6.2.3

1 year ago

6.2.2

1 year ago

6.2.1

1 year ago

6.2.0

1 year ago