Context

class Context : NSObject

SkyWay全体の設定、取得を行うStaticなコンテキスト

  • Undocumented

    Declaration

    Swift

    class var authToken: String? { get }

  • Undocumented

    Declaration

    Swift

    class var appID: String? { get }

  • Undocumented

    Declaration

    Swift

    class var isSetup: Bool { get }

  • Undocumented

    Declaration

    Swift

    class var plugins: [Plugin] { get }

  • Unavailable

    Undocumented

  • イベントデリゲート

    Declaration

    Swift

    weak class var delegate: (any ContextDelegate)? { get set }

  • SkyWayの初期化をします。

    SkyWayを利用するためには必ずこのAPIをコールする必要があります。

    Declaration

    Swift

    class func setup(withToken token: String, options: ContextOptions?) async throws

    Parameters

    token

    JWT形式のSkyWayAuthToken
    options

    初期化オプション
    completion

    完了コールバック

  • SkyWayの初期化をします。

    Warning

    このメソッドは、クイックスタートなどアプリの動作を確認する際に利用するためのものです。 認証情報の漏洩を防ぐため、このメソッドをリリース版アプリで利用することは控えてください。

    Declaration

    Swift

    class func setupForDev(withAppId appId: String, secretKey: String, options: ContextOptions?) async throws

    Parameters

    appId

    アプリケーションID
    secretKey

    シークレットキー
    options

    初期化オプション
    completion

    完了コールバック

  • SkyWayAuthTokenを更新します。

    Declaration

    Swift

    class func updateToken(_ token: String) -> Bool

    Parameters

    token

    新しいSkyWayAuthToken

    Return Value

    更新成功かどうか

  • [内部向けAPI]

    このAPIは内部向けのものであり、サポート対象外です。

    Declaration

    Swift

    class func _update(_ config: ContextOptionsRTCConfig)

  • プラグインを登録します。

    Declaration

    Swift

    class func registerPlugin(_ plugin: Plugin)

    Parameters

    plugin

    プラグイン

  • コンテキストを破棄し、全ての接続を切断します。

    SkyWayの利用が不要になった時にコールしてください。

    Dispose完了後にSDKで生成されたリソースにアクセスしないでください。

    setup(withToken:options:completion)を再度コールすることで利用可能になります。

    Declaration

    Swift

    class func dispose() async throws

    Parameters

    completion

    完了コールバック