AWS Amplify API
AWS Amplify Home
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Hub
Class
constructor
name
protected
Channels
dispatch
listen
remove
Hierarchy
HubClass
Index
Constructors
constructor
Properties
name
protected
Channels
Methods
dispatch
listen
remove
Constructors
constructor
new
Hub
Class
(
name
:
string
)
:
HubClass
Parameters
name:
string
Returns
HubClass
Properties
name
name
:
string
protected
Channels
protected
Channels
:
string
[]
= ['core','auth','api','analytics','interactions','pubsub','storage','xr',]
Methods
dispatch
dispatch
(
channel
:
string
, payload
:
HubPayload
, source
?:
string
, ampSymbol
?:
Symbol
)
:
void
Parameters
channel:
string
payload:
HubPayload
Default value
source:
string
= ""
Optional
ampSymbol:
Symbol
Returns
void
listen
listen
(
channel
:
string
|
RegExp
, callback
?:
HubCallback
|
LegacyCallback
, listenerName
?:
string
)
:
void
Parameters
channel:
string
|
RegExp
Optional
callback:
HubCallback
|
LegacyCallback
Default value
listenerName:
string
= "noname"
Returns
void
remove
remove
(
channel
:
string
|
RegExp
, listener
:
HubCallback
)
:
void
Parameters
channel:
string
|
RegExp
listener:
HubCallback
Returns
void