Maintainers

| Maintainer | GitHub | Social | | -----------| -------| -------| | John Borges | johnborges | @johnborges |

Install

npm install @capacitor-community/appcenter-analytics
npx cap sync

Session and Device Info

Once you add App Center Analytics to your app and the SDK is started, it will automatically track sessions and device properties like OS Version, model, etc. You don’t need to write any additional code.

Usage

API

• setEnabled(...)
• isEnabled()
• pause()
• resume()
• trackEvent(...)
• enableManualSessionTracker()
• startSession()
• Interfaces

setEnabled(...)

setEnabled(options: { enable: boolean; }) => Promise<void>

You can enable and disable App Center Analytics at runtime. If you disable it, the SDK won't collect any more analytics information for the app.

| Param | Type | | ------------- | --------------------------------- | | options | { enable: boolean; } |

Since: 0.3.0

isEnabled()

isEnabled() => Promise<{ value: boolean; }>

Check if Analytics is enabled or not.

Returns: Promise<{ value: boolean; }>

Since: 0.0.1

pause()

pause() => Promise<void>

Pause transmission of Analytics logs. While paused, Analytics logs are saved to disk.

Since: 0.1.0

resume()

resume() => Promise<void>

Resume transmission of Analytics logs. Any Analytics logs that accumulated on disk while paused are sent to the server.

Since: 0.1.0

trackEvent(...)

trackEvent(options: AnalyticsEvent) => Promise<void>

Track an event with optional custom properties to know what's happening in your app, understand user actions, and see the aggregates in the App Center portal.

| Param | Type | | ------------- | --------------------------------------------------------- | | options | AnalyticsEvent |

Since: 0.1.0

enableManualSessionTracker()

enableManualSessionTracker() => Promise<void>

Enable manual session tracker. Call this method before Analytics starts.

Since: 2.0.0

startSession()

startSession() => Promise<void>

Start a new session if manual session tracker is enabled, otherwise do nothing.

Since: 2.0.0

Interfaces

AnalyticsEvent

| Prop | Type | Description | | ---------------- | --------------------------------------- | ------------------------------------ | | name | string | 256 character limit | | properties | { [key: string]: string; } | Only 20 properties allowed per event | | flag | 'normal' | 'critical' | |