1.0.10 • Published 4 years ago

capacitor-segment-plugin v1.0.10

Weekly downloads
-
License
MIT
Repository
bitbucket
Last release
4 years ago

Capacitor Segment Plugin

The plugin enables segment analytics tracking for ionic apps

Install

npm install capacitor-segment-plugin
npx cap sync

API

initialize(...)

initialize(args: InitializeArguments) => any

Configures and initializes the segment plugin

ParamType
argsInitializeArguments

Returns: any


identify(...)

identify(args: IdentifyArguments) => any

Identify a user.

ParamType
argsIdentifyArguments

Returns: any


track(...)

track(args: TrackArguments) => any

Track an event.

ParamType
argsTrackArguments

Returns: any


screen(...)

screen(args: ScreenArguments) => any

Trigger screen view.

ParamType
argsScreenArguments

Returns: any


page(...)

page(args: PageArguments) => any

Trigger page view.

ParamType
argsPageArguments

Returns: any


group(...)

group(options: GroupArguments) => any

Clear all information about the visitor & reset analytic state.

ParamType
optionsGroupArguments

Returns: any


alias(...)

alias(options: AliasArguments) => any

Clear all information about the visitor & reset analytic state.

ParamType
optionsAliasArguments

Returns: any


reset()

reset() => any

clears the SDK’s internal stores for the current user and group.

Returns: any


Interfaces

InitializeArguments

PropType
writeKeystring
trackLifecycleEventsboolean
recordScreenViewsboolean

IdentifyArguments

PropType
userIdstring
traitsany
optionsany

TrackArguments

PropType
eventNamestring
propertiesany
optionsany

ScreenArguments

PropType
screenNamestring
categorystring
propertiesany
optionsany

PageArguments

PropType
pageNamestring
categorystring
propertiesany
optionsany

GroupArguments

PropType
userIdstring
groupIdstring
traitsany
optionsany

AliasArguments

PropType
newIdstring
optionsany
1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago