Guida
Come utilizzare Intercom in Capacitor
Utilizza @capgo/capacitor-intercom
Plugin Intercom Capacitor
Installa
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync Copia il nativo code del plugin nei tuoi progetti nativi. Esegui nuovamente dopo ogni aggiornamento del plugin.
Importa
import { CapgoIntercom } from '@capgo/capacitor-intercom';
Vedi API in un colpo d'occhio
| Metodo | Descrizione |
|---|---|
loadWithKeys |
Inizializza Intercom con API chiavi in esecuzione. Utilizza questo se preferisci non configurare le chiavi in capacitor.config. |
registerIdentifiedUser |
Registra un utente noto con Intercom. Almeno uno dei valori userId o email deve essere fornito. |
registerUnidentifiedUser |
Registra un utente anonimo con Intercom. |
updateUser |
Aggiorna gli attributi dell'utente in Intercom. |
logout |
Effettua il logout dell'utente da Intercom. |
logEvent |
Racchiuda un evento personalizzato in Intercom. |
displayMessenger |
Apri il messaggero di Intercom. |
displayMessageComposer |
Apri il compositore di messaggi con un messaggio precompilato. |
displayHelpCenter |
Apri il centro aiuto di Intercom. |
hideMessenger |
Nascondi il messaggero di Intercom. |
displayLauncher |
Mostra il pulsante di lancio di Intercom. |
hideLauncher |
Nascondi il pulsante di lancio di Intercom. |
displayInAppMessages |
Abilita messaggi in-app da Intercom. |
hideInAppMessages |
Disabilita messaggi in-app da Intercom. |
displayCarousel |
Mostra un carosello 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 JWT per l'autenticazione del messaggero sicura. |
setBottomPadding |
Imposta lo spazio inferiore per l'interfaccia utente del messaggero Intercom. |
sendPushTokenToIntercom |
Inviare un token di notifica push a Intercom. |
receivePush |
Gestisci una notifica push ricevuta da Intercom. |
getUnreadConversationCount |
Ottieni il numero di conversazioni non lette per l'utente corrente. |
Esempi
loadWithKeys()
Avvia Intercom con API chiavi in esecuzione. Utilizza questo 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 con Intercom. Almeno uno dei campi userId o email deve essere fornito.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
Registra un utente anonimo con Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
Aggiorna gli attributi dell'utente in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
Disconnetti l'utente da Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
Racconta un evento personalizzato in Intercom.
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
La tabella sopra elenca le 23 metodologie di base. Gli ascoltatori e gli aiuti di versione, e la piena contrattazione di ogni metodo, sono documentati nel GitHub repository.
Ascolta gli eventi
addListener ritorna un handle. Chiama handle.remove() quando lo schermo viene smontato, o CapgoIntercom.removeAllListeners() per cancellare tutti gli ascoltatori.
Riferimento completo
Continua da Utilizzo di @capgo/capacitor-intercom
Se stai utilizzando Utilizzo di @capgo/capacitor-intercom per pianificare il lavoro del plugin nativo, connettilo con @capgo/capacitor-intercom per i dettagli di implementazione in @capgo/capacitor-intercom Avvio rapido per i dettagli di implementazione in Avvio rapido, Capgo Directory dei Plugin per il workflow del prodotto in Capgo Directory dei Plugin Capacitor Plugin da Capgo per i dettagli di implementazione in Capacitor Plugin da Capgo, e Aggiungere o Aggiornare i Plugin per i dettagli di implementazione in Aggiungere o Aggiornare i Plugin.