AWSKinesisProvider | amplify-js

Hierarchy

AWSKinesisProvider
- AWSKinesisFirehoseProvider

Implements

AnalyticsProvider

Index

Constructors

constructor

Properties

_config

Methods

Constructors

constructor

new AWSKinesisProvider(config?: any): AWSKinesisProvider

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:26
Parameters
- Optional config: any
Returns AWSKinesisProvider

Properties

Protected _config

_config: any

Methods

Protected _init

_init(config: any, credentials: any): boolean

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:204
Parameters
- config: any
- credentials: any
Returns boolean

Protected _sendEvents

_sendEvents(group: any): boolean

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:155
Parameters
- group: any
Returns boolean

configure

configure(config: any): object

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:74
configure the plugin

Parameters
- config: any
  
  configuration
Returns object

getCategory

getCategory(): string

Implementation of AnalyticsProvider.getCategory
- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:59
get the category of the plugin

Returns string

getProviderName

getProviderName(): string

Implementation of AnalyticsProvider.getProviderName
- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:66
get provider name of the plugin

Returns string

record

record(params: any): Promise<boolean>

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:87
record an event

Parameters
- params: any
  
  the params of an event
Returns Promise<boolean>

updateEndpoint

updateEndpoint(): Promise<boolean>

- Defined in packages/analytics/src/Providers/AWSKinesisProvider.ts:102
Returns Promise<boolean>