AWSPinpointProvider | amplify-js

Hierarchy

AWSPinpointProviderCommon
AWSPinpointProviderCommon
- AWSPinpointProvider

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AWSPinpointProvider(config?: any): AWSPinpointProvider

Overrides AWSPinpointProviderCommon.constructor
- Defined in packages/analytics/src/Providers/AWSPinpointProvider.ts:79
Parameters
- Optional config: any
Returns AWSPinpointProvider

Properties

Protected clientInfo

clientInfo: any

Protected config

config: Record<string, any>

Protected endpointInitialized

endpointInitialized: boolean = false

Protected initialized

initialized: boolean = false

Protected logger

logger: ConsoleLogger

Static category

category: string = "Analytics"

Static providerName

providerName: string = "AWSPinpoint"

Static subCategory

subCategory: NotificationsSubCategory = "PushNotification"

Methods

configure

configure(config: any): object
configure(config?: object): Record<string, any>
configure(config?: object): Record<string, any>

Overrides AWSPinpointProviderCommon.configure
- Defined in packages/analytics/src/Providers/AWSPinpointProvider.ts:110
configure the plugin

Parameters
- config: any
  
  configuration
Returns object
Overrides AWSPinpointProviderCommon.configure
- Defined in packages/notifications/src/InAppMessaging/Providers/AWSPinpointProvider/index.ts:69
Parameters
- Default value config: object = {}
Returns Record<string, any>
- Defined in packages/notifications/src/PushNotification/Providers/AWSPinpointProvider/index.ts:40
Parameters
- Default value config: object = {}
Returns Record<string, any>

getCategory

getCategory(): string

Implementation of PushNotificationProvider.getCategory

Overrides AWSPinpointProviderCommon.getCategory
- Defined in packages/analytics/src/Providers/AWSPinpointProvider.ts:95
get the category of the plugin

Returns string

getInAppMessages

getInAppMessages(userAgentValue?: string): Promise<InAppMessageCampaign[]>

Implementation of InAppMessagingProvider.getInAppMessages
- Defined in packages/notifications/src/InAppMessaging/Providers/AWSPinpointProvider/index.ts:114
Parameters
- Optional userAgentValue: string
Returns Promise<InAppMessageCampaign[]>

getProviderName

getProviderName(): string

Implementation of PushNotificationProvider.getProviderName

Overrides AWSPinpointProviderCommon.getProviderName
- Defined in packages/analytics/src/Providers/AWSPinpointProvider.ts:102
get provider name of the plugin

Returns string

getSubCategory

getSubCategory(): "InAppMessaging"

Implementation of PushNotificationProvider.getSubCategory

Overrides AWSPinpointProviderCommon.getSubCategory
- Defined in packages/notifications/src/InAppMessaging/Providers/AWSPinpointProvider/index.ts:65
get the sub-category of the plugin

Returns "InAppMessaging"

identifyUser

identifyUser(userId: string, userInfo: UserInfo, userAgentValue?: string): Promise<void>

Implementation of PushNotificationProvider.identifyUser

Inherited from AWSPinpointProviderCommon.identifyUser

Overrides AWSPinpointProviderCommon.identifyUser
- Defined in packages/notifications/src/common/AWSPinpointProviderCommon/index.ts:80
Parameters
- userId: string
- userInfo: UserInfo
- Optional userAgentValue: string
Returns Promise<void>

Protected init

init(): Promise<void>

Inherited from AWSPinpointProviderCommon.init

Overrides AWSPinpointProviderCommon.init
- Defined in packages/notifications/src/common/AWSPinpointProviderCommon/index.ts:96
Returns Promise<void>

processInAppMessages

processInAppMessages(messages: any[], event: InAppMessagingEvent): Promise<InAppMessage[]>

- Defined in packages/notifications/src/InAppMessaging/Providers/AWSPinpointProvider/index.ts:145
Parameters
- messages: any[]
- event: InAppMessagingEvent
Returns Promise<InAppMessage[]>

record

record(params: EventParams, handlers: PromiseHandlers): Promise<any>

- Defined in packages/analytics/src/Providers/AWSPinpointProvider.ts:144
record an event

Parameters
- params: EventParams
  
  the params of an event
- handlers: PromiseHandlers
Returns Promise<any>

Protected recordAnalyticsEvent

recordAnalyticsEvent(event: AWSPinpointAnalyticsEvent): Promise<void>

Inherited from AWSPinpointProviderCommon.recordAnalyticsEvent

Overrides AWSPinpointProviderCommon.recordAnalyticsEvent
- Defined in packages/notifications/src/common/AWSPinpointProviderCommon/index.ts:131
Parameters
- event: AWSPinpointAnalyticsEvent
Returns Promise<void>

registerDevice

registerDevice(address: string): Promise<void>

Implementation of PushNotificationProvider.registerDevice
- Defined in packages/notifications/src/PushNotification/Providers/AWSPinpointProvider/index.ts:91
Parameters
- address: string
Returns Promise<void>

Protected updateEndpoint

updateEndpoint(userId?: string, userInfo?: AWSPinpointUserInfo, userAgentValue?: string): Promise<void>

Inherited from AWSPinpointProviderCommon.updateEndpoint

Overrides AWSPinpointProviderCommon.updateEndpoint
- Defined in packages/notifications/src/common/AWSPinpointProviderCommon/index.ts:166
Parameters
- Default value userId: string = null
- Default value userInfo: AWSPinpointUserInfo = null
- Optional userAgentValue: string
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: any

Returns AWSPinpointProvider

Properties

Protected clientInfo

Protected config

Protected endpointInitialized

Protected initialized

Protected logger

Static category

Static providerName

Static subCategory

Methods

configure

Parameters

config: any

Returns object

Parameters

Default value config: object = {}

Returns Record<string, any>

Parameters

Default value config: object = {}

Returns Record<string, any>

getCategory

Returns string

getInAppMessages

Parameters

Optional userAgentValue: string

Returns Promise<InAppMessageCampaign[]>

getProviderName

Returns string

getSubCategory

Returns "InAppMessaging"

identifyUser

Parameters

userId: string

userInfo: UserInfo

Optional userAgentValue: string

Returns Promise<void>

Protected init

Returns Promise<void>

processInAppMessages

Parameters

messages: any[]

event: InAppMessagingEvent

Returns Promise<InAppMessage[]>

record

Parameters

params: EventParams

handlers: PromiseHandlers

Returns Promise<any>

Protected recordAnalyticsEvent

Parameters

event: AWSPinpointAnalyticsEvent

Returns Promise<void>

registerDevice

Parameters

address: string

Returns Promise<void>

Protected updateEndpoint

Parameters

Default value userId: string = null

Default value userInfo: AWSPinpointUserInfo = null

Optional userAgentValue: string

Returns Promise<void>