SKWContext

Objective-C


@interface SKWContext : NSObject

Swift

class Context : NSObject

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

  • Undocumented

    Declaration

    Objective-C

    @property(class, nonatomic, readonly) NSArray<SKWPlugin*>* _Nonnull plugins

    Swift

    class var plugins: [Plugin] { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (id _Nonnull)init NS_UNAVAILABLE;

  • SkyWayの初期化をします。

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

    Declaration

    Objective-C

    + (void)setupWithToken:(NSString *_Nonnull)token
               options:(SKWContextOptions *_Nullable)options
            completion:(SKWContextSetupCompletion _Nullable)completion;

    Swift

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

    Parameters

    token

    JWT形式のSkyWayAuthToken
    options

    初期化 オプション
    completion

    完了コールバック

  • SkyWayAuthTokenを更新します。

    Declaration

    Objective-C

    + (_Bool)updateToken:(NSString *_Nonnull)token;

    Swift

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

    Parameters

    token

    新しいSkyWayAuthToken

    Return Value

    更新成功かどうか

  • [内部向けAPI]

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

    Declaration

    Objective-C

    + (void)_updateRTCConfig:(SKWContextOptionsRTCConfig *_Nonnull)config;

    Swift

    class func _update(_ config: ContextOptionsRTCConfig)

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

    Declaration

    Objective-C

    + (void)registerPlugin:(SKWPlugin *_Nonnull)plugin;

    Swift

    class func registerPlugin(_ plugin: Plugin)

    Parameters

    plugin

    プラグイン

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

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

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

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

    Declaration

    Objective-C

    + (void)disposeWithCompletion:(SKWContextDisposeCompletion _Nullable)completion;

    Swift

    class func dispose() async throws

  • イベントデリゲート

    See more

    Declaration

    Objective-C

    @property (class, nonatomic, weak) id<SKWContextDelegate> _Nullable delegate;

    Swift

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