AbstractPubSubProvider | amplify-js

Type parameters

T: ProviderOptions

Hierarchy

AbstractPubSubProvider
- AWSAppSyncRealTimeProvider
- MqttOverWSProvider

Implements

PubSubProvider

Index

Constructors

constructor

Accessors

options

Methods

Constructors

constructor

new AbstractPubSubProvider(options: T): AbstractPubSubProvider

- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:16
Parameters
- options: T
Returns AbstractPubSubProvider

Accessors

Protected options

options:

Methods

configure

configure(config: T): T

- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:22
Parameters
- config: T
Returns T

getCategory

getCategory(): string

Implementation of PubSubProvider.getCategory
- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:30
Returns string

Abstract getProviderName

getProviderName(): string

Implementation of PubSubProvider.getProviderName
- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:34
Returns string

Abstract newClient

newClient(clientOptions: T): Promise<any>

- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:40
Parameters
- clientOptions: T
Returns Promise<any>

Abstract publish

publish(topics: string[] | string, msg: PubSubContent, options?: T): void

- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:42
Parameters
- topics: string[] | string
- msg: PubSubContent
- Optional options: T
Returns void

Abstract subscribe

subscribe(topics: string[] | string, options?: T, customUserAgentDetails?: CustomUserAgentDetails): Observable<PubSubContent>

- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:48
Parameters
- topics: string[] | string
- Optional options: T
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Observable<PubSubContent>