Inizia con Getting Started

Installare

bun add @capgo/capacitor-intercom
bunx cap sync

Importa

import { CapgoIntercom } from '@capgo/capacitor-intercom';

API Panoramica

loadWithKeys

Inizializza Intercom con le chiavi API in tempo di esecuzione. Usa questo se preferisci non configurare le chiavi in capacitor.config.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.loadWithKeys({} as IntercomLoadOptions);

registerIdentifiedUser

Registra un utente noto con Intercom.\nDeve essere fornito almeno uno dei valori userId o email.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerIdentifiedUser({} as IntercomIdentifiedUserOptions);

registerUnidentifiedUser

Registra un utente anonimo con Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Aggiorna le proprietà dell'utente in Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.updateUser({} as IntercomUserUpdateOptions);

logout

Esegui il logout dell'utente da Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logout();

logEvent

Registra un evento personalizzato in Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.logEvent({} as IntercomLogEventOptions);

displayMessenger

Apri il messaggero Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessenger();

displayMessageComposer

Apri il compositore di messaggi con un messaggio precompilato.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayMessageComposer({} as IntercomMessageComposerOptions);

displayHelpCenter

Apri il centro aiuti Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayHelpCenter();

hideMessenger

Nascondi il messaggero Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideMessenger();

displayLauncher

Mostra il pulsante di lancio di Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayLauncher();

hideLauncher

Nascondi il pulsante di lancio di Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideLauncher();

displayInAppMessages

Abilita le notifiche in-app di Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

Disabilita le notifiche in-app di Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.hideInAppMessages();

displayCarousel

Visualizza un carosello Intercom specifico.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayCarousel({} as IntercomCarouselOptions);

displayArticle

Visualizza un articolo Intercom specifico.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displayArticle({} as IntercomArticleOptions);

displaySurvey

Visualizza un sondaggio Intercom specifico.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.displaySurvey({} as IntercomSurveyOptions);

setUserHash

Imposta l'HMAC per la verifica dell'identità.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserHash({} as IntercomUserHashOptions);

setUserJwt

Imposta JWT per l'autenticazione sicura del messaggero.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setUserJwt({} as IntercomUserJwtOptions);

setBottomPadding

Imposta il padding inferiore per l'interfaccia utente del messaggero Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.setBottomPadding({} as IntercomBottomPaddingOptions);

sendPushTokenToIntercom

Invia un token di notifica push a Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.sendPushTokenToIntercom({} as IntercomPushTokenOptions);

receivePush

Gestisci una notifica push ricevuta da Intercom.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.receivePush({} as IntercomPushNotificationData);

getUnreadConversationCount

Ottieni il numero di conversazioni non lette per l'utente corrente.

import { CapgoIntercom } from '@capgo/capacitor-intercom';

await CapgoIntercom.getUnreadConversationCount();

Riferimento di tipo

IntercomLoadOptions

export interface IntercomLoadOptions {
  appId?: string;
  apiKeyIOS?: string;
  apiKeyAndroid?: string;
}

IntercomIdentifiedUserOptions

export interface IntercomIdentifiedUserOptions {
  userId?: string;
  email?: string;
}

IntercomUserUpdateOptions

export interface IntercomUserUpdateOptions {
  userId?: string;
  email?: string;
  name?: string;
  phone?: string;
  languageOverride?: string;
  customAttributes?: { [key: string]: any };
  companies?: IntercomCompany[];
}

IntercomLogEventOptions

export interface IntercomLogEventOptions {
  name: string;
  data?: { [key: string]: any };
}

IntercomMessageComposerOptions

export interface IntercomMessageComposerOptions {
  message: string;
}

IntercomCarouselOptions

export interface IntercomCarouselOptions {
  carouselId: string;
}

IntercomArticleOptions

export interface IntercomArticleOptions {
  articleId: string;
}

IntercomSurveyOptions

export interface IntercomSurveyOptions {
  surveyId: string;
}

IntercomUserHashOptions

export interface IntercomUserHashOptions {
  hmac: string;
}

IntercomUserJwtOptions

export interface IntercomUserJwtOptions {
  jwt: string;
}

IntercomBottomPaddingOptions

export interface IntercomBottomPaddingOptions {
  value: number;
}

IntercomPushTokenOptions

export interface IntercomPushTokenOptions {
  value: string;
}

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRiepiloga quando le modifiche pubbliche API sono state apportate in fase di sincronizzazione upstream.

Continua da Iniziare

Se stai utilizzando Avvio rapido per pianificare il dashboard e le API operazioni, connettilo con Utilizzo di @capgo/capacitor-intercom per la capacità nativa in Utilizzo di @capgo/capacitor-intercom, API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in dispositivi.