Mulai

Instalasi

bun add @capgo/capacitor-rudderstack
bunx cap sync

Impor

import { nativePlugin } from '@capgo/capacitor-rudderstack';

API Ringkasan

initialize

Menginisialisasi klien RudderStack.

Metode ini mempertahankan tanda tangan Cordova, sehingga argumen kedua dapat berupa objek konfigurasi atau objek Rudder options.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.initialize('value');

identify

Mengirimkan panggilan identifikasi untuk ID pengguna yang diberikan.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.identify('value');

group

Mengirimkan panggilan kelompok untuk ID kelompok yang diberikan.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.group('value');

track

Mengirimkan panggilan lacak untuk nama acara yang diberikan.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.track('value');

screen

Mengirimkan panggilan layar untuk nama layar yang diberikan.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.screen('value');

alias

Mengalihkan pengguna saat ini ke identifikasi baru.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.alias('value');

reset

Mengatur ulang keadaan identitas RudderStack saat ini.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.reset();

flush

Mengosongkan acara yang ditunggu segera.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.flush();

putDeviceToken

Mengatur token push yang RudderStack kirim ke tujuan yang didukung.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putDeviceToken('value');

setAdvertisingId

Lihat definisi sumber untuk kontrak saat ini.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

Mengatur nilai ID iklan kustom.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putAdvertisingId('value');

setAnonymousId

Lihat definisi sumber untuk kontrak saat ini.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.setAnonymousId('value');

putAnonymousId

Mengatur nilai id anonim kustom.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putAnonymousId('value');

optOut

Mengaktifkan/menghentikan pengiriman data RudderStack.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.optOut(true);

Referensi Tipe

RudderConfiguration

Kunci konfigurasi yang didukung untuk SDK native RudderStack asli.

export interface RudderConfiguration {
  /**
   * RudderStack data plane URL.
   */
  dataPlaneUrl?: string;

  /**
   * Number of events to batch before a flush.
   */
  flushQueueSize?: number;

  /**
   * Database row threshold that triggers pruning on Android and iOS.
   */
  dbCountThreshold?: number;

  /**
   * Server config refresh interval in hours.
   */
  configRefreshInterval?: number;

  /**
   * RudderStack log verbosity.
   */
  logLevel?: RudderLogLevelValue;

  /**
   * Sleep timeout / sleep count used by the native SDK.
   */
  sleepTimeOut?: number;

  /**
   * Android only. Lets the native SDK collect the advertising identifier automatically.
   */
  autoCollectAdvertId?: boolean;

  /**
   * Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.
   */
  trackLifecycleEvents?: boolean;

  /**
   * RudderStack control plane URL.
   */
  controlPlaneUrl?: string;

  /**
   * Enables automatic screen tracking where supported by the native SDK.
   */
  recordScreenViews?: boolean;

  /**
   * Ignored in this Capacitor port.
   *
   * The Cordova SDK uses this field to bootstrap native destination factories from companion plugins.
   * Those extension packages are not implemented in this first Capacitor release.
   */
  factories?: any[];
}

RudderOptions

Opsi panggilan RudderStack.

export interface RudderOptions {
  /**
   * External identifiers forwarded with the event.
   */
  externalIds?: Record<string, string>;

  /**
   * Destination enablement flags keyed by integration name.
   */
  integrations?: Record<string, boolean>;
}

RudderTraits

Penerimaan payload sifat RudderTraits identify dan group.

export type RudderTraits = Record<string, any>;

RudderProperties

Penerimaan payload properti RudderProperties track dan screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Penerimaan payload versi plugin.

export interface PluginVersionResult {
  /**
   * Version identifier returned by the platform implementation.
   */
  version: string;
}

RudderLogLevelValue

Nilai tingkat log RudderStack yang ditampilkan untuk kemudahan migrasi.

export type RudderLogLevelValue = 0 | 1 | 2 | 3 | 4 | 5;

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas