Class HubClass

constructor

• new HubClass(name): HubClass

• Parameters

  • name: string

  Returns HubClass

name

protectedChannels

dispatch

• dispatch<Channel>(channel, payload, source?, ampSymbol?): void

• Used to send a Hub event.

  Type Parameters

  • Channel extends "auth"

  Parameters

  • channel: Channel

    The channel on which the event will be broadcast

  • payload: HubPayload<AmplifyEventData[Channel]>

    The HubPayload

  • Optional source: string

    The source of the event; defaults to ''

  • Optional ampSymbol: symbol

    Symbol used to determine if the event is dispatched internally on a protected channel

  Returns void
• dispatch(channel, payload, source?, ampSymbol?): void

• Parameters

  • channel: string

  • payload: HubPayload

  • Optional source: string

  • Optional ampSymbol: symbol

  Returns void

listen

• listen<Channel>(channel, callback, listenerName?): StopListenerCallback

• Used to listen for Hub events.

  Type Parameters

  • Channel extends "auth"

  Parameters

  • channel: Channel

    The channel on which to listen

  • callback: HubCallback<Channel, AmplifyEventData[Channel]>

    The callback to execute when an event is received on the specified channel

  • Optional listenerName: string

    The name of the listener; defaults to 'noname'

  Returns StopListenerCallback

  A function which can be called to cancel the listener.
• listen<EventData>(channel, callback, listenerName?): StopListenerCallback

• Type Parameters

  • EventData extends EventDataMap

  Parameters

  • channel: string

  • callback: HubCallback<string, EventData>

  • Optional listenerName: string

  Returns StopListenerCallback