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:54
Initialize Analtyics

Returns AnalyticsClass

Methods

addPluggable

addPluggable(pluggable: AnalyticsProvider): any

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

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

autoTrack

autoTrack(trackerType: any, opts: any): void

- Defined in packages/analytics/src/Analytics.ts:277
Parameters
- trackerType: any
- opts: any
Returns void

configure

configure(config?: any): any

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

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

disable

disable(): void

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

Returns void

enable

enable(): void

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

Returns void

getModuleName

getModuleName(): string

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

getPluggable

getPluggable(providerName: any): AnalyticsProvider

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

Parameters
- providerName: any
  
  the name of the plugin
Returns AnalyticsProvider

record

record(event: string | object, provider?: any, metrics?: EventMetrics): Promise<unknown>

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

Parameters
- event: string | object
- Optional provider: any
- Optional metrics: EventMetrics
Returns Promise<unknown>
- A promise which resolves if buffer doesn't overflow

removePluggable

removePluggable(providerName: any): void

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

Parameters
- providerName: any
  
  the name of the plugin
Returns void

startSession

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

- Defined in packages/analytics/src/Analytics.ts:199
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:208
Record Session stop

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

updateEndpoint

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

- Defined in packages/analytics/src/Analytics.ts:248
Parameters
- attrs: any
- Optional provider: any
Returns Promise<unknown>