Interface ICfgSyncPlugin

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

Implemented by

Methods

getCfg pause resume setCfg sync updateEventListenerName

Methods

getCfg

pause

resume

setCfg

  • setCfg(config?): boolean

  • Manually set configs of current instance.

    Parameters

    • Optionalconfig: IConfiguration & IConfig

      new configs

    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