例外処理｜Web SDK

プログラミングのベストプラクティスは、物事がうまくいかないことを想定し、それを予期してコードを書くことである。例えば、セッションに接続しようとするとき、クライアントはインターネットに接続していないかもしれません。

について ウェブSDK には、実行時に例外を明らかにする完了ハンドラと例外イベントが含まれている。

完了ハンドラ

非同期に完了する多くのメソッドでは、最後に渡すパラメーターは完了ハンドラー関数です。この関数は、メソッドが完了するか失敗したときに呼び出されます。失敗した場合、関数にはエラー・オブジェクトがパラメータとして渡されます。

例えば、次のコードは Session.connect() メソッドに、完了ハンドラーを渡す：

var session = OT.initSession(apiKey, session);
session.connect(token, function (error) {
    if (error) {
    console.log("Failed to connect: ", error.message);
    if (error.name === "OT_NOT_CONNECTED") {
        alert("You are not connected to the internet. Check your network connection.");
    }
    } else {
    console.log("Connected");
    }
});

メソッドの成功や失敗を確認するためには、完了ハンドラを実装することが重要である。場合によっては、エラーの原因となったクライアントの条件があれば、ユーザーにプロンプトを出すことができる。例えば error.name プロパティを呼び出すときに "OT_NOT_CONNECTED "に設定される。 Session.connect() メソッドが失敗すると、クライアントがネットワークに接続されていないことを示す。

クライアントの責任ではないその他のエラー状態については、エラーコードとメッセージを調べて、エラーの性質を確認することができます。例えば Session.connect() メソッドが失敗した場合、エラーコード1004は無効なトークンで接続しようとしたことを示します。これは、有効期限が切れたトークンか、接続先のセッションと一致しないトークンである可能性があります。詳細については、エラー・オブジェクトのメッセージ・プロパティを確認してください。

完了ハンドラを持つメソッド

Web SDK の以下のメソッドには completionHandler パラメータで指定します。このオプション・パラメーターには、メソッドが成功または失敗したときに呼び出される関数を渡すことができる：

• Session.forceDisconnect()
• Session.forceUnpublish()
• Session.connect()
• Session.publish()
• Session.signal()
• Session.subscribe()
• OT.initPublisher()

チェック message プロパティを参照してください。

エラーが発生した場合 code の値である。 error パラメータには以下のいずれかの値を指定する：

例外イベントのリスニング

すべての例外イベントを検出するには、次のようにイベントリスナーを追加します。 exception イベントで、OTオブジェクトによってディスパッチされる。しかし、特定のメソッドの完了ハンドラでエラーに反応する方が簡単だ。