AWSAppSyncRealTimeProvider | amplify-js

Hierarchy

AbstractPubSubProvider<AWSAppSyncRealTimeProviderOptions>
- AWSAppSyncRealTimeProvider

Implements

PubSubProvider

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new AWSAppSyncRealTimeProvider(options?: ProviderOptions): AWSAppSyncRealTimeProvider

Overrides AbstractPubSubProvider.constructor
- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:130
Parameters
- Default value options: ProviderOptions = {}
Returns AWSAppSyncRealTimeProvider

Accessors

Protected isSSLEnabled

isSSLEnabled:

Protected options

options:

Methods

close

close(): void

- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:174
Mark the socket closed and release all active listeners

Returns void

configure

configure(config: AWSAppSyncRealTimeProviderOptions): AWSAppSyncRealTimeProviderOptions

Inherited from AbstractPubSubProvider.configure
- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:22
Parameters
- config: AWSAppSyncRealTimeProviderOptions
Returns AWSAppSyncRealTimeProviderOptions

getCategory

getCategory(): string

Implementation of PubSubProvider.getCategory

Inherited from AbstractPubSubProvider.getCategory
- Defined in packages/pubsub/src/Providers/PubSubProvider.ts:30
Returns string

getNewWebSocket

getNewWebSocket(url: string, protocol: string): WebSocket

- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:185
Parameters
- url: string
- protocol: string
Returns WebSocket

getProviderName

getProviderName(): string

Implementation of PubSubProvider.getProviderName

Overrides AbstractPubSubProvider.getProviderName
- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:189
Returns string

newClient

newClient(): Promise<any>

Overrides AbstractPubSubProvider.newClient
- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:193
Returns Promise<any>

publish

publish(_topics: string[] | string, _msg: PubSubContent, _options?: AWSAppSyncRealTimeProviderOptions): Promise<void>

Implementation of PubSubProvider.publish

Overrides AbstractPubSubProvider.publish
- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:197
Parameters
- _topics: string[] | string
- _msg: PubSubContent
- Optional _options: AWSAppSyncRealTimeProviderOptions
Returns Promise<void>

subscribe

subscribe(_topics: string[] | string, options?: AWSAppSyncRealTimeProviderOptions, customUserAgentDetails?: CustomUserAgentDetails): Observable<Record<string, unknown>>

Overrides AbstractPubSubProvider.subscribe
- Defined in packages/pubsub/src/Providers/AWSAppSyncRealTimeProvider/index.ts:210
Parameters
- _topics: string[] | string
- Optional options: AWSAppSyncRealTimeProviderOptions
- Optional customUserAgentDetails: CustomUserAgentDetails
Returns Observable<Record<string, unknown>>