@capgo/capacitor-rudderstack

Overview

Capacitor API that mirrors the public surface of rudder-sdk-cordova.

Core Capabilities

• initialize - Initializes the RudderStack client.
• identify - Sends an identify call for the provided user id.
• group - Sends a group call for the provided group id.
• track - Sends a track call for the provided event name.

Public API

Method	Description
initialize	Initializes the RudderStack client.
identify	Sends an identify call for the provided user id.
group	Sends a group call for the provided group id.
track	Sends a track call for the provided event name.
screen	Sends a screen call for the provided screen name.
alias	Aliases the current user to a new identifier.
reset	Resets the current RudderStack identity state.
flush	Flushes queued events immediately.
putDeviceToken	Sets the push token that RudderStack forwards to supported destinations.
setAdvertisingId	See the source definitions for current behavior.
putAdvertisingId	Sets a custom advertising id value.
setAnonymousId	See the source definitions for current behavior.
putAnonymousId	Sets a custom anonymous id value.
optOut	Toggles RudderStack tracking opt-out.
getPluginVersion	Returns the plugin version marker from the native implementation.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-rudderstack.