AWS Amplify JS API
AWS Amplify JS Dev Center
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Mqtt
OverWSProvider
constructor
_client
IdObservers
_topic
Observers
client
Id
clients
Queue
endpoint
isSSLEnabled
options
configure
connect
disconnect
get
Category
get
Provider
Name
new
Client
on
Disconnect
publish
subscribe
Hierarchy
AbstractPubSubProvider
<
MqttProviderOptions
>
MqttOverWSProvider
AWSIoTProvider
Implements
PubSubProvider
Index
Constructors
constructor
Properties
_client
IdObservers
_topic
Observers
Accessors
client
Id
clients
Queue
endpoint
isSSLEnabled
options
Methods
configure
connect
disconnect
get
Category
get
Provider
Name
new
Client
on
Disconnect
publish
subscribe
Constructors
constructor
new
Mqtt
OverWSProvider
(
options
?:
MqttProviderOptions
)
:
MqttOverWSProvider
Parameters
Default value
options:
MqttProviderOptions
= {}
Returns
MqttOverWSProvider
Properties
Protected
_client
IdObservers
_client
IdObservers
:
Map
<
string
,
Set
<
PubSubContentObserver
>
>
= new Map()
Protected
_topic
Observers
_topic
Observers
:
Map
<
string
,
Set
<
PubSubContentObserver
>
>
= new Map()
Accessors
Protected
client
Id
client
Id
:
Protected
clients
Queue
clients
Queue
:
Protected
endpoint
endpoint
:
Protected
isSSLEnabled
isSSLEnabled
:
Protected
options
options
:
Methods
configure
configure
(
config
:
MqttProviderOptions
)
:
MqttProviderOptions
Parameters
config:
MqttProviderOptions
Returns
MqttProviderOptions
Protected
connect
connect
(
clientId
:
string
, options
?:
MqttProviderOptions
)
:
Promise
<
PahoClient
|
undefined
>
Parameters
clientId:
string
Default value
options:
MqttProviderOptions
= {}
Returns
Promise
<
PahoClient
|
undefined
>
Protected
disconnect
disconnect
(
clientId
:
string
)
:
Promise
<
void
>
Parameters
clientId:
string
Returns
Promise
<
void
>
get
Category
get
Category
(
)
:
string
Returns
string
get
Provider
Name
get
Provider
Name
(
)
:
string
Returns
string
new
Client
new
Client
(
__namedParameters
:
object
)
:
Promise
<
PahoClient
>
Parameters
__namedParameters:
object
client
Id
:
string
url
:
string
Returns
Promise
<
PahoClient
>
on
Disconnect
on
Disconnect
(
__namedParameters
:
object
)
:
void
Parameters
__namedParameters:
object
args
:
args
client
Id
:
string
error
Code
:
number
Returns
void
publish
publish
(
topics
:
string
[]
|
string
, msg
:
PubSubContent
)
:
Promise
<
void
>
Parameters
topics:
string
[]
|
string
msg:
PubSubContent
Returns
Promise
<
void
>
subscribe
subscribe
(
topics
:
string
[]
|
string
, options
?:
MqttProviderOptions
)
:
Observable
<
PubSubContent
>
Parameters
topics:
string
[]
|
string
Default value
options:
MqttProviderOptions
= {}
Returns
Observable
<
PubSubContent
>