Interface EvergreenManager

interface EvergreenManager {
    applyUpdate(): Promise<null | string>;
    getBundleInfo(): BundleInfo;
    getMasterVersion(): null | string;
    getUpdateStatus(): null | UpdateStatus;
    subscribe(eventType: "started", listener: ((payload: {
        updateMode: UpdateMode;
    }) => void)): Unsubscribe;
    subscribe(eventType: "failed", listener: ((payload: {
        updateMode: UpdateMode;
    }) => void)): Unsubscribe;
    subscribe(eventType: "ready", listener: ((payload: {
        version: string;
    }) => void)): Unsubscribe;
    subscribe(eventType: "progress", listener: ((payload: {
        contentLength: number;
        readLength: number;
    }) => void)): Unsubscribe;
}

Methods

applyUpdate getBundleInfo getMasterVersion getUpdateStatus subscribe

Methods

applyUpdate

  • applyUpdate(): Promise<null | string>

  • Applies the available update bundle and returns its version, or returns null if there's no update bundle.

    For changes to take effect you must reload the app.

    Returns Promise<null | string>

getBundleInfo

getMasterVersion

  • getMasterVersion(): null | string

  • The current version of the app bundle.

    Returns null | string

    Deprecated

    Use getBundleInfo instead.

getUpdateStatus

subscribe

  • subscribe(eventType, listener): Unsubscribe

  • The new update download has started.

    Parameters

    • eventType: "started"
    • listener: ((payload: {
          updateMode: UpdateMode;
      }) => void)
        • (payload): void

        • Parameters

          Returns void

    Returns Unsubscribe

  • subscribe(eventType, listener): Unsubscribe

  • Failed to download an update.

    Parameters

    • eventType: "failed"
    • listener: ((payload: {
          updateMode: UpdateMode;
      }) => void)
        • (payload): void

        • Parameters

          Returns void

    Returns Unsubscribe

  • subscribe(eventType, listener): Unsubscribe

  • An update was successfully downloaded and ready to be applied.

    Parameters

    • eventType: "ready"
    • listener: ((payload: {
          version: string;
      }) => void)
        • (payload): void

        • Parameters

          • payload: {
                version: string;
            }
            • version: string

              The version of the update bundle that is ready to be applied.

          Returns void

    Returns Unsubscribe

  • subscribe(eventType, listener): Unsubscribe

  • Progress of a pending update download.

    Parameters

    • eventType: "progress"
    • listener: ((payload: {
          contentLength: number;
          readLength: number;
      }) => void)
        • (payload): void

        • Parameters

          • payload: {
                contentLength: number;
                readLength: number;
            }
            • contentLength: number

              The length of downloaded content in bytes, or -1 if content length cannot be detected.

            • readLength: number

              The number of bytes that are already downloaded.

          Returns void

    Returns Unsubscribe

Settings

Member Visibility

On This Page

Methods