room.getInfo

room.getInfo

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

翻訳日: 2007/03/07

原文リビジョン: 16


ルームについての情報を取得します。1分に1回以上ポーリングしてはいけません。


HTTPメソッド

GET

パラメータ

api_key(必須)

あなたのAPIキー

id(必須)

対象のルームのID

counter(オプション)

ここで指定した番号以上のIDを持つイベントメッセージが返されます。指定しない場合、メッセージは何も返ってきません。負の値を指定した場合、直近のイベントを返します。(例: -5を指定した場合、「直近の5イベント」を指します) なお、50件以上のメッセージは返りません。

user_messages_only(オプション)

trueを指定した場合、ユーザによるメッセージのみを返します。つまり、システムメッセージは返されません。trueが指定されない場合はユーザメッセージシステムメッセージの両方を返します。デフォルト値はfalseです。

password(オプション)

ルームのパスワードを指定します。

format(オプション)

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

callback(オプション)

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


認証

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

応答の例

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <room>
    <id>gcnZ3vAcZDA</id>
    <name>My awesome room</name>
    <description>A really GREAT room</description>
    <url>http://www.lingr.com/room/myawesomeroom</url>
    <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
    <counter>356</counter>
    <max_user_message_id>346</max_user_message_id>
    <tags/>
  </room>
  <messages>
    <message>
      <id>235</id>
      <type>user</type>
      <occupant_id>3tUud4Upiev</occupant_id>
      <nickname>safari</nickname>
      <source>browser</source>
      <client_type>human</client_type>
      <icon_url>http://images.lingr.com/user/0/26x26.gif</icon_url>
      <timestamp>2007-01-11T07:17:04-08:00</timestamp>
      <text>hello</text>
    </message>
  </messages>
  <occupants>
    <occupant>
      <id>3tUud4Upiev</id>
      <nickname>safari</nickname>
      <description>I really like Lingr!</description>
      <icon_url>http://images.lingr.com/user/0/26x26.gif</icon_url>
      <source>browser</source>
      <client_type>human</client_type>
    </occupant>
    <occupant>
      <id>47WRTE5MYtc</id>
      <nickname></nickname>
      <description></description>
      <icon_url></icon_url>
      <source>api</source>
      <client_type>automaton</client_type>
    </occupant>
  </occupants>
</response>

応答の詳細

成功したメソッド呼び出しの応答は以下のような要素を持ちます。

room

このルームの情報です。構造は次のページを参照してください。→Room

messages

counterを指定した場合、ルーム中のメッセージを格納した配列が返ります。それぞれの構造は次のページを参照してください。→Message

occupants

ルームの現在の入室者を格納した配列です。それぞれの構造は次のページを参照してください。→Occupant


エラーコード

100: 不正HTTPメソッド

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

101: 無効なAPIキー

指定されたAPIキーが不正です。

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

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

108: 無効なルームID

与えられたルームIDは無効です。

112: 回数制限に達した

ポーリングの頻度が制限以上です。

116: 無効なパスワード

与えられたルームのパスワードは無効です。

117: パスワードが必要です

このルームにはパスワードがかかっていますが、passwordパラメータが与えられませんでした。

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

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

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