@aws-amplify/analytics
- Version 6.5.5
- Published
- 593 kB
- 9 dependencies
- Apache-2.0 license
Install
npm i @aws-amplify/analytics
yarn add @aws-amplify/analytics
pnpm add @aws-amplify/analytics
Overview
Analytics category of aws-amplify
Index
Variables
Classes
Interfaces
Variables
variable Analytics
const Analytics: AnalyticsClass;
Classes
class AmazonPersonalizeProvider
class AmazonPersonalizeProvider implements AnalyticsProvider {}
constructor
constructor(config?: any);
method configure
configure: (config: any) => object;
configure the plugin
Parameter config
configuration
method getCategory
getCategory: () => string;
get the category of the plugin
method getProviderName
getProviderName: () => string;
get provider name of the plugin
method record
record: (params: any) => Promise<boolean>;
Record event
Parameter eventType
type of the event action. e.g. "Click"
Parameter properties
properties of the event Promise
class AWSKinesisFirehoseProvider
class AWSKinesisFirehoseProvider extends AWSKinesisProvider {}
constructor
constructor(config?: any);
method getProviderName
getProviderName: () => string;
get provider name of the plugin
class AWSKinesisProvider
class AWSKinesisProvider implements AnalyticsProvider {}
constructor
constructor(config?: any);
method configure
configure: (config: any) => object;
configure the plugin
Parameter config
configuration
method getCategory
getCategory: () => string;
get the category of the plugin
method getProviderName
getProviderName: () => string;
get provider name of the plugin
method record
record: (params: any) => Promise<boolean>;
record an event
Parameter params
the params of an event
method updateEndpoint
updateEndpoint: () => Promise<boolean>;
class AWSPinpointProvider
class AWSPinpointProvider implements AnalyticsProvider {}
constructor
constructor(config?: any);
property category
static category: string;
property providerName
static providerName: string;
method configure
configure: (config: any) => object;
configure the plugin
Parameter config
configuration
method getCategory
getCategory: () => string;
get the category of the plugin
method getProviderName
getProviderName: () => string;
get provider name of the plugin
method record
record: (params: EventParams, handlers: PromiseHandlers) => Promise<any>;
record an event
Parameter params
the params of an event
Interfaces
interface AnalyticsProvider
interface AnalyticsProvider {}
method configure
configure: (config: object) => object;
method getCategory
getCategory: () => string;
method getProviderName
getProviderName: () => string;
method record
record: (params: object, handlers?: PromiseHandlers) => Promise<boolean>;
Package Files (7)
Dependencies (9)
Dev Dependencies (1)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/analytics
.
- Markdown[](https://www.jsdocs.io/package/@aws-amplify/analytics)
- HTML<a href="https://www.jsdocs.io/package/@aws-amplify/analytics"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 4027 ms. - Missing or incorrect documentation? Open an issue for this package.