room.observe

room.observe

オリジナル: http://wiki.lingr.com/dev/show/RoomObserve

翻訳日: 2007/03/07

原文リビジョン: 14


ルーム内でイベントが発生したら通知を受け取ります。room.enterで入室したら、room.exitで退室するまでの間このメソッドかroom.getMessagesのどちらかを2分に1回以上実行しなければいけません。

HTTPメソッド

GET

パラメータ

session(必須)

session.createで得たセッションID

ticket(必須)

room.enterで得たチケット

counter(必須)

room.enterか前のroom.observe、もしくはroom.getMessagesで得たカウンタ

format(オプション)

希望の応答フォーマット。指定する場合はxmljsonを指定します。デフォルトxmlです。

callback(オプション)

応答フォーマットjsonを指定した場合、コールバック関数名を指定します。


認証

このメソッドは認証を必要としません。

応答の例

何らかのイベントがあった場合、このメソッドの応答はroom.getMessagesと同様です。何も起こらなかった場合は<status>ok</status>と言う要素のみが返ります。

エラーコード

100: 不正HTTPメソッド

HTTPメソッドが間違っています。

102: 無効なセッション

渡されたセッションIDは無効です。

104: 不正な応答フォーマット

要求された応答フォーマットサポートされていません。

109: 無効なチケット

与えられたチケットは無効です。

114: counterが無い

counterパラメータが与えられていない

120: 不正文字コードエンコーディング

あなたが入力したデータUTF-8として不正エンコーディングを含んでいます。

詳細は「APIの基礎について学ぶ」を参照してください。

122: 繰り返されたカウンタ

以前と同じcounterを指定して、room.observeの呼び出しが繰り返された。カウンタ値の更新が正常に行われているか確認してください。