Interface SkyWayContextInterface

interface SkyWayContextInterface {
    appId: string;
    authTokenString: string;
    config: SkyWayContextConfig;
    disposed: boolean;
    onDisposed: EventInterface<void>;
    onFatalError: EventInterface<SkyWayErrorInterface>;
    onTokenExpired: EventInterface<void>;
    onTokenUpdated: EventInterface<string>;
    onTokenUpdateReminder: EventInterface<void>;
    dispose(): void;
    registerPlugin(plugin: SkyWayPluginInterface): void;
    updateAuthToken(token: string): Promise<void>;
}

Implemented by

Properties

appId authTokenString config disposed onDisposed onFatalError onTokenExpired onTokenUpdated onTokenUpdateReminder

Methods

dispose registerPlugin updateAuthToken

Properties

ReadonlyappId

appId: string

Description

[japanese] SkyWayのアプリケーションID

ReadonlyauthTokenString

authTokenString: string

Description

[japanese] トークンのエンコード済み文字列

config

config: SkyWayContextConfig

Description

[japanese] コンテキストの設定

Readonlydisposed

disposed: boolean

Description

[japanese] コンテキストが破棄済みかどうかを示すフラグ

ReadonlyonDisposed

onDisposed: EventInterface<void>

Description

[japanese] コンテキストが破棄されたことを通知するイベント

ReadonlyonFatalError

onFatalError: EventInterface<SkyWayErrorInterface>

Description

[japanese] 回復不能なエラーが発生したことを通知するイベント。インターネット接続状況を確認した上で別のインスタンスを作り直す必要がある

ReadonlyonTokenExpired

onTokenExpired: EventInterface<void>

Description

[japanese] トークンの期限切れを通知するイベント。このイベントが発火された場合、トークンを更新するまでサービスを利用できない

ReadonlyonTokenUpdated

onTokenUpdated: EventInterface<string>

Description

[japanese] トークンが更新されたことを通知するイベント

ReadonlyonTokenUpdateReminder

onTokenUpdateReminder: EventInterface<void>

Description

[japanese] トークンの期限がまもなく切れることを通知するイベント

Methods

dispose

  • dispose(): void

  • Returns void

    Description

    [japanese] コンテキストの利用を終了し次のリソースを解放する

    • イベントリスナー
    • バックエンドサーバとの通信
    • コンテキストを参照する全Channelインスタンス

registerPlugin

  • registerPlugin(plugin): void

  • Parameters

    • plugin: SkyWayPluginInterface

    Returns void

    Description

    [japanese] プラグインの登録

updateAuthToken

  • updateAuthToken(token): Promise<void>

  • Parameters

    • token: string

    Returns Promise<void>

    Description

    [japanese] トークンの更新

Settings

Member Visibility

On This Page

Properties
Methods