Class RemoteControllerWindow

运行在主线程中的远程控制插件

Hierarchy

RemoteControllerBase
- RemoteControllerWindow

Implements

WindowPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RemoteControllerWindow(options: Options): RemoteControllerWindow

Inherited from RemoteControllerBase.constructor
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-base.ts:22
Parameters
- options: Options
Returns RemoteControllerWindow

Properties

Protected configBackup

configBackup: string

Private context

context: UseContext

Protected fetchConfigThrottle

fetchConfigThrottle: () => Promise<RemoteConfig>

Type declaration

- (): Promise<RemoteConfig>
- Returns Promise<RemoteConfig>

Readonly name

name: "@glacierjs/plugin-remote-controller" = PLUGIN_NAME

Protected options

options: Options = ...

Methods

beforeRegister

beforeRegister(): Promise<void>

Implementation of WindowPlugin.beforeRegister
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-window.ts:21
在主线程中注册 ServiceWorker 之前检查远程配置。该代码会在页面刷新时执行，所以会存在两种情况：
1. ServiceWorker 已注册，远程配置开关关闭：注销当前运行的 ServiceWorker
2. ServiceWorker 第一次注册，远程配置开关关闭：阻断注册流程，不下载 ServiceWorker 文件。
Returns Promise<void>

Protected getConfig

getConfig(): Promise<{ config: RemoteConfig; configUpdated: boolean }>

Inherited from RemoteControllerBase.getConfig
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-base.ts:31
获取远程配置，并且判断配置是否进行了更新，返回给外部进行对应处理。

Returns Promise<{ config: RemoteConfig; configUpdated: boolean }>
Promise<{ config: RemoteConfig, configUpdated: boolean }

onUse

onUse(context: UseContext): void

Implementation of WindowPlugin.onUse
- Defined in plugin-remote-controller/src/lib/plugin-remote-controller-window.ts:11
Parameters
- context: UseContext
Returns void

Generated using TypeDoc