Interface ICfgSyncPlugin

interface ICfgSyncPlugin {
    getCfg(): IConfiguration & IConfig;
    pause(): void;
    resume(): void;
    setCfg(config?: IConfiguration & IConfig): boolean;
    sync(customDetails?: any): boolean;
    updateEventListenerName(eventName?: string): boolean;
}

Methods

getCfg pause resume setCfg sync updateEventListenerName

Methods

getCfg

  • getCfg(): IConfiguration & IConfig

  • Get current configs of current instance.

    Returns IConfiguration & IConfig

pause

  • pause(): void

  • Pause the sending/receiving of events

    Returns void

resume

  • resume(): void

  • Resume the sending/receiving of events

    Returns void

setCfg

  • setCfg(config?): boolean

  • Manually set configs of current instance.

    Parameters

    Returns boolean

sync

  • sync(customDetails?): boolean

  • Manually broadcast configs of current instance to all other instances.

    Parameters

    • OptionalcustomDetails: any

      additional details should also be sent out to other instances

    Returns boolean

updateEventListenerName

  • updateEventListenerName(eventName?): boolean

  • Manually update event name. If current instance is the main instance, then following config changes will be sent out under this new event name. If current instance is listener instances, it will listen to event details under this new name.

    Parameters

    • OptionaleventName: string

      new event name

    Returns boolean

Settings

Member Visibility

On This Page

Methods