PubSubClass | amplify-js

Hierarchy

InternalPubSubClass
- PubSubClass

Index

Constructors

constructor

Methods

Constructors

constructor

new PubSubClass(options?: PubSubOptions): PubSubClass

Inherited from InternalPubSubClass.constructor
- Defined in packages/pubsub/src/internals/InternalPubSub.ts:45
Initialize PubSub with AWS configurations

Parameters
- Optional options: PubSubOptions
  
  Configuration object for PubSub
Returns PubSubClass

Methods

addPluggable

addPluggable(pluggable: PubSubProvider): Promise<object>

Inherited from InternalPubSubClass.addPluggable
- Defined in packages/pubsub/src/internals/InternalPubSub.ts:86
add plugin into Analytics category

Parameters
- pluggable: PubSubProvider
  
  an instance of the plugin
Returns Promise<object>

configure

configure(options: PubSubOptions): PubSubOptions

Inherited from InternalPubSubClass.configure
- Defined in packages/pubsub/src/internals/InternalPubSub.ts:69
Configure PubSub part with configurations

Parameters
- options: PubSubOptions
Returns PubSubOptions
- The current configuration

getModuleName

getModuleName(): string

Overrides InternalPubSubClass.getModuleName
- Defined in packages/pubsub/src/PubSub.ts:20
Returns string

publish

publish(topics: string[] | string, msg: PubSubContent, options?: ProviderOptions): Promise<void[]>

Inherited from InternalPubSubClass.publish
- Defined in packages/pubsub/src/internals/InternalPubSub.ts:130
Parameters
- topics: string[] | string
- msg: PubSubContent
- Optional options: ProviderOptions
Returns Promise<void[]>

removePluggable

removePluggable(providerName: string): void

Inherited from InternalPubSubClass.removePluggable
- Defined in packages/pubsub/src/internals/InternalPubSub.ts:100
remove plugin from PubSub category

Parameters
- providerName: string
  
  the name of the plugin
Returns void

subscribe

subscribe(topics: string[] | string, options?: ProviderOptions): Observable<PubSubObservable>

Overrides InternalPubSubClass.subscribe
- Defined in packages/pubsub/src/PubSub.ts:24
Parameters
- topics: string[] | string
- Optional options: ProviderOptions
Returns Observable<PubSubObservable>