Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SimpleGatewayBuilder<E>

Specialization of AbstractGatewayBuilder for the SimpleGateway gateway.

Type parameters

  • E: HTMLElement

Hierarchy

  • AbstractGatewayBuilder<E>
    • SimpleGatewayBuilder

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new SimpleGatewayBuilder<E>(_gatewayProvider: GatewayProvider, _propName?: string, _subscriptionsByType?: Map<string, [ElementSubscriptionListener<HTMLElement, Event<any, MessageHeaders>>, undefined | SubscribeOptions][]>): SimpleGatewayBuilder<E>
  • internal

    Type parameters

    • E: HTMLElement

    Parameters

    • _gatewayProvider: GatewayProvider
    • Optional _propName: string
    • Optional _subscriptionsByType: Map<string, [ElementSubscriptionListener<HTMLElement, Event<any, MessageHeaders>>, undefined | SubscribeOptions][]>

    Returns SimpleGatewayBuilder<E>

Properties

Protected _gatewayProvider

_gatewayProvider: GatewayProvider

_propName

_propName: string
internal

Protected _subscriptionsByType

_subscriptionsByType: Map<string, [ElementSubscriptionListener<HTMLElement, Event<any, MessageHeaders>>, undefined | SubscribeOptions][]>

Methods

Protected build

  • build(Constructor: CustomElementConstructor<E>, hooks: HooksRegistration<E & { __ceb_gateway_subscriptions: Set<Removable> }>): void

  • This API is dedicated for developer of Builders.

    Parameters

    • Constructor: CustomElementConstructor<E>
    • hooks: HooksRegistration<E & { __ceb_gateway_subscriptions: Set<Removable> }>

    Returns void

decorate

  • decorate(): PropertyDecorator

  • Decorates the property of the gateway.

    Returns PropertyDecorator

subscribe

  • subscribe<M>(EventType: string, listener: ElementSubscriptionListener<E, M>, options?: SubscribeOptions): AbstractGatewayBuilder<E>
  • subscribe<M>(): GatewaySubscriptionBuilder<E, M>

  • Subscribe to a Message Event.

    Type parameters

    • M: Event<any, MessageHeaders, M>

    Parameters

    • EventType: string

      the type of the event

    • listener: ElementSubscriptionListener<E, M>

      the listener

    • Optional options: SubscribeOptions

      the options

    Returns AbstractGatewayBuilder<E>

  • When used as a decorator, returns a fresh Subscription builder to decorate a method.

    Type parameters

    • M: Event<any, MessageHeaders, M>

    Returns GatewaySubscriptionBuilder<E, M>

Static get

Generated using TypeDoc