Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
@aws-amplify/pubsub
index
PubSub
Class PubSub
Hierarchy (
view full
)
PubSub
PubSub
Index
Constructors
constructor
Properties
_client
Id
Observers
_topic
Observers
Accessors
client
Id
clients
Queue
endpoint
isSSLEnabled
options
region
Methods
configure
connect
disconnect
new
Client
on
Disconnect
publish
subscribe
Constructors
constructor
new
Pub
Sub
(
options
?
)
:
PubSub
Parameters
options
:
PubSubOptions
= {}
Returns
PubSub
Properties
Protected
_client
Id
Observers
_client
Id
Observers
:
Map
<
string
,
Set
<
PubSubContentObserver
>
>
= ...
Protected
_topic
Observers
_topic
Observers
:
Map
<
string
,
Set
<
PubSubContentObserver
>
>
= ...
Accessors
Protected
client
Id
get
clientId
(
)
:
string
Returns
string
Protected
clients
Queue
get
clientsQueue
(
)
:
ClientsQueue
Returns
ClientsQueue
Protected
endpoint
get
endpoint
(
)
:
Promise
<
string
>
Returns
Promise
<
string
>
Protected
isSSLEnabled
get
isSSLEnabled
(
)
:
boolean
Returns
boolean
Protected
options
get
options
(
)
:
T
Returns
T
Protected
region
get
region
(
)
:
undefined
|
string
Returns
undefined
|
string
Methods
configure
configure
(
config
)
:
PubSubOptions
Parameters
config
:
PubSubOptions
Returns
PubSubOptions
Protected
connect
connect
(
clientId
,
options
?
)
:
Promise
<
undefined
|
PahoClient
>
Parameters
clientId
:
string
options
:
PubSubOptions
= {}
Returns
Promise
<
undefined
|
PahoClient
>
Protected
disconnect
disconnect
(
clientId
)
:
Promise
<
void
>
Parameters
clientId
:
string
Returns
Promise
<
void
>
new
Client
new
Client
(
__namedParameters
)
:
Promise
<
PahoClient
>
Parameters
__namedParameters
:
PubSubOptions
Returns
Promise
<
PahoClient
>
on
Disconnect
on
Disconnect
(
__namedParameters
)
:
void
Parameters
__namedParameters
:
{
clientId
?:
string
;
errorCode
?:
number
;
}
Optional
client
Id
?:
string
Optional
error
Code
?:
number
Returns
void
publish
publish
(
__namedParameters
)
:
Promise
<
void
>
Parameters
__namedParameters
:
PublishInput
Returns
Promise
<
void
>
subscribe
subscribe
(
__namedParameters
)
:
Observable
<
PubSubContent
>
Parameters
__namedParameters
:
SubscribeInput
&
{
options
?:
PubSubOptions
;
}
Returns
Observable
<
PubSubContent
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
_client
Id
Observers
_topic
Observers
client
Id
clients
Queue
endpoint
isSSLEnabled
options
region
configure
connect
disconnect
new
Client
on
Disconnect
publish
subscribe
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter