Guida
Come usare Intercom in Capacitor
Utilizzo di @capgo/capacitor-intercom
Plugin Intercom Capacitor.
Installa
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.
Importa
import { CapgoIntercom } from '@capgo/capacitor-intercom';
API in breve
| Metodo | Descrizione |
|---|---|
loadWithKeys |
Inizializza Intercom con le chiavi API a runtime. Usalo se preferisci non configurare le chiavi in capacitor.config. |
registerIdentifiedUser |
Registra un utente noto su Intercom. Va fornito almeno uno tra userId ed email. |
registerUnidentifiedUser |
Registra un utente anonimo su Intercom. |
updateUser |
Aggiorna gli attributi dell'utente su Intercom. |
logout |
Effettua il logout dell'utente da Intercom. |
logEvent |
Registra un evento personalizzato in Intercom. |
displayMessenger |
Apri il messenger di Intercom. |
displayMessageComposer |
Apri il compositore con un messaggio precompilato. |
displayHelpCenter |
Apri il centro assistenza di Intercom. |
hideMessenger |
Nascondi il messenger di Intercom. |
displayLauncher |
Mostra il pulsante launcher di Intercom. |
hideLauncher |
Nascondi il pulsante launcher di Intercom. |
displayInAppMessages |
Abilita i messaggi in-app di Intercom. |
hideInAppMessages |
Disabilita i messaggi in-app di Intercom. |
displayCarousel |
Mostra un carousel Intercom specifico. |
displayArticle |
Mostra un articolo Intercom specifico. |
displaySurvey |
Mostra un sondaggio Intercom specifico. |
setUserHash |
Imposta l'HMAC per la verifica dell'identità. |
setUserJwt |
Imposta il JWT per l'autenticazione sicura del messenger. |
setBottomPadding |
Imposta il padding inferiore per l'interfaccia del messenger Intercom. |
sendPushTokenToIntercom |
Invia un token di notifica push a Intercom. |
receivePush |
Gestisci una notifica push Intercom ricevuta. |
getUnreadConversationCount |
Ottieni il numero di conversazioni non lette per l'utente corrente. |
Esempi
loadWithKeys()
Inizializza Intercom con le chiavi API a runtime. Usalo se preferisci non configurare le chiavi in capacitor.config.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
Registra un utente noto su Intercom. Va fornito almeno uno tra userId ed email.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registra un utente anonimo su Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Aggiorna gli attributi dell'utente su Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Effettua 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({ name: 'example' });
La tabella sopra elenca i 23 metodi core. I listener e gli helper di versione, e il contratto completo di ogni metodo, sono documentati in repository GitHub.
Ascolta gli eventi
addListener restituisce un handle. Chiama handle.remove() quando la schermata viene smontata, o CapgoIntercom.removeAllListeners() per rimuovere tutti i listener.
Riferimento completo
Continua da Usare @capgo/capacitor-intercom
Se stai usando Utilizzo di @capgo/capacitor-intercom per pianificare il lavoro sui plugin nativi, collegalo a @capgo/capacitor-intercom per i dettagli di implementazione in @capgo/capacitor-intercom, Per iniziare per i dettagli di implementazione nella guida introduttiva, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Plugin Capacitor di Capgo, e Aggiunta o aggiornamento dei plugin per i dettagli di implementazione in Aggiunta o aggiornamento dei plugin.