AnalyticsClass | amplify-js

Provide mobile analytics client functions

Hierarchy

AnalyticsClass

Index

Constructors

constructor

Methods

Constructors

constructor

new AnalyticsClass(): AnalyticsClass

- Defined in packages/analytics/src/Analytics.ts:59
Initialize Analtyics

Returns AnalyticsClass

Methods

addPluggable

addPluggable(pluggable: AnalyticsProvider): any

- Defined in packages/analytics/src/Analytics.ts:138
add plugin into Analytics category

Parameters
- pluggable: AnalyticsProvider
  
  an instance of the plugin
Returns any

autoTrack

autoTrack(trackerType: "session", opts: AutoTrackSessionOpts): any
autoTrack(trackerType: "pageView", opts: AutoTrackPageViewOpts): any
autoTrack(trackerType: "event", opts: AutoTrackEventOpts): any
autoTrack(trackerType: TrackerTypes, opts: object): any

- Defined in packages/analytics/src/Analytics.ts:290
Enable or disable auto tracking

Parameters
- trackerType: "session"
  
  The type of tracker to activate.
- opts: AutoTrackSessionOpts
Returns any
- Defined in packages/analytics/src/Analytics.ts:291
Parameters
- trackerType: "pageView"
- opts: AutoTrackPageViewOpts
Returns any
- Defined in packages/analytics/src/Analytics.ts:292
Parameters
- trackerType: "event"
- opts: AutoTrackEventOpts
Returns any
- Defined in packages/analytics/src/Analytics.ts:294
Parameters
- trackerType: TrackerTypes
- opts: object
  - [key: string]: any
  - provider: string
Returns any

configure

configure(config?: any): any

- Defined in packages/analytics/src/Analytics.ts:86
configure Analytics

Parameters
- Optional config: any
  
  Configuration of the Analytics
Returns any

disable

disable(): void

- Defined in packages/analytics/src/Analytics.ts:194
stop sending events

Returns void

enable

enable(): void

- Defined in packages/analytics/src/Analytics.ts:201
start sending events

Returns void

getModuleName

getModuleName(): string

- Defined in packages/analytics/src/Analytics.ts:79
Returns string

getPluggable

getPluggable(providerName: string): AnalyticsProvider

- Defined in packages/analytics/src/Analytics.ts:157
Get the plugin object

Parameters
- providerName: string
  
  the name of the provider to be removed
Returns AnalyticsProvider

record

record(event: AnalyticsEvent | PersonalizeAnalyticsEvent | KinesisAnalyticsEvent, provider?: string): Promise<unknown>

- Defined in packages/analytics/src/Analytics.ts:246
Record one analytic event and send it to Pinpoint

Parameters
- event: AnalyticsEvent | PersonalizeAnalyticsEvent | KinesisAnalyticsEvent
  
  An object with the name of the event, attributes of the event and event metrics.
- Optional provider: string
Returns Promise<unknown>

removePluggable

removePluggable(providerName: string): void

- Defined in packages/analytics/src/Analytics.ts:173
Remove the plugin object

Parameters
- providerName: string
  
  the name of the provider to be removed
Returns void

startSession

startSession(provider?: string): Promise<unknown>

- Defined in packages/analytics/src/Analytics.ts:210
Record Session start

Parameters
- Optional provider: string
Returns Promise<unknown>
- A promise which resolves if buffer doesn't overflow

stopSession

stopSession(provider?: string): Promise<unknown>

- Defined in packages/analytics/src/Analytics.ts:228
Record Session stop

Parameters
- Optional provider: string
Returns Promise<unknown>
- A promise which resolves if buffer doesn't overflow

updateEndpoint

updateEndpoint(attrs: object, provider?: string): Promise<unknown>

- Defined in packages/analytics/src/Analytics.ts:257
Parameters
- attrs: object
  - [key: string]: any
- Optional provider: string
Returns Promise<unknown>