Skip to content

@capgo/capacitor-rudderstack

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

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

  • 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.
MethodDescription
initializeInitializes the RudderStack client.
identifySends an identify call for the provided user id.
groupSends a group call for the provided group id.
trackSends a track call for the provided event name.
screenSends a screen call for the provided screen name.
aliasAliases the current user to a new identifier.
resetResets the current RudderStack identity state.
flushFlushes queued events immediately.
putDeviceTokenSets the push token that RudderStack forwards to supported destinations.
setAdvertisingIdSee the source definitions for current behavior.
putAdvertisingIdSets a custom advertising id value.
setAnonymousIdSee the source definitions for current behavior.
putAnonymousIdSets a custom anonymous id value.
optOutToggles RudderStack tracking opt-out.
getPluginVersionReturns the plugin version marker from the native implementation.

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

Keep going from @capgo/capacitor-rudderstack

Section titled “Keep going from @capgo/capacitor-rudderstack”

If you are using @capgo/capacitor-rudderstack to plan native plugin work, connect it with Using @capgo/capacitor-rudderstack for the native capability in Using @capgo/capacitor-rudderstack, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.