Getting Started

Instalar

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice la siguiente solicitud:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-intercom` plugin in my project.

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-intercom
bunx cap sync

Importar

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

API Resumen

loadWithKeys

Inicie Intercom con las claves API en tiempo de ejecución. Use esto si prefiere no configurar claves en 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 a un usuario conocido con Intercom. Se debe proporcionar al menos uno de los campos userId o email.

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

await CapgoIntercom.registerIdentifiedUser({
  userId: 'user-id-123',
  email: 'user@example.com',
});

registerUnidentifiedUser

Registra a un usuario anónimo con Intercom.

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

await CapgoIntercom.registerUnidentifiedUser();

updateUser

Actualiza los atributos del usuario en Intercom.

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

await CapgoIntercom.updateUser({ userId: 'user-id-123' });

logout

Desconecta al usuario de Intercom.

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

await CapgoIntercom.logout();

logEvent

Registra un evento personalizado en Intercom.

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

await CapgoIntercom.logEvent({ name: 'example' });

displayMessenger

Abre el mensajero de Intercom.

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

await CapgoIntercom.displayMessenger();

displayMessageComposer

Abre el compositor de mensajes con un mensaje prellenado.

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

await CapgoIntercom.displayMessageComposer({ message: 'Hello from Capacitor' });

displayHelpCenter

Abre el centro de ayuda de Intercom.

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

await CapgoIntercom.displayHelpCenter();

hideMessenger

Ocultar el mensajero de Intercom.

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

await CapgoIntercom.hideMessenger();

displayLauncher

Mostrar el botón de lanzador de Intercom.

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

await CapgoIntercom.displayLauncher();

hideLauncher

Ocultar el botón de lanzador de Intercom.

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

await CapgoIntercom.hideLauncher();

displayInAppMessages

Habilitar mensajes en la aplicación de Intercom.

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

await CapgoIntercom.displayInAppMessages();

hideInAppMessages

Deshabilitar mensajes en la aplicación de Intercom.

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

await CapgoIntercom.hideInAppMessages();

displayCarousel

Mostrar un carrousel específico de Intercom.

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

await CapgoIntercom.displayCarousel({ carouselId: 'carousel-id-123' });

displayArticle

Mostrar un artículo específico de Intercom.

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

await CapgoIntercom.displayArticle({ articleId: 'article-id-123' });

displaySurvey

Mostrar una encuesta específica de Intercom.

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

await CapgoIntercom.displaySurvey({ surveyId: 'survey-id-123' });

setUserHash

Establecer el HMAC para la verificación de identidad.

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

await CapgoIntercom.setUserHash({ hmac: 'hmac' });

setUserJwt

Establecer JWT para la autenticación de mensajero seguro.

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

await CapgoIntercom.setUserJwt({ jwt: 'jwt' });

setBottomPadding

Set the bottom padding for the Intercom messenger UI.

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

await CapgoIntercom.setBottomPadding({ value: 1 });

sendPushTokenToIntercom

Enviar un token de notificación push a Intercom.

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

await CapgoIntercom.sendPushTokenToIntercom({ value: 'value' });

receivePush

Gestionar una notificación de empuje recibida de Intercom.

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

await CapgoIntercom.receivePush({});

getUnreadConversationCount

Obtener el número de conversaciones no leídas para el usuario actual.

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

const result = await CapgoIntercom.getUnreadConversationCount();
console.log(result);

Referencia de tipos

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;
}

Fuente de Verdad

Esta página se genera a partir de la extensión. src/definitions.ts. Re-ejecuta la sincronización cuando los datos públicos API cambian en la fuente.

Sigue adelante desde Inicio

Si estás utilizando Getting Started planificar la consola de dashboard y operaciones API, conecte con Usando @capgo/capacitor-intercom para la capacidad nativa en Usando @capgo/capacitor-intercom, Resumen de API para el detalle de implementación en API Overview, Introducción para el detalle de implementación en Introducción, API Claves para los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en dispositivos.