room.changeSettings

room.changeSettings

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

翻訳日: 2007/04/15

原文リビジョン: 1


既存のチャットルームの設定を変更します。

HTTPメソッド

POST

パラメータ

session(必須)

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

id(必須)

設定を変更したいチャットルームのID

new_id(オプション)

IDを変更したい場合、新しいIDを指定します。

name(オプション)

チャットルームの新しい名前

description(オプション)

チャットルームの新しい説明文

password(オプション)

チャットルームの新しいパスワード。空文字列を渡した場合、現在設定されているパスワードクリアされます。

listed_in_directory(オプション)

trueの場合、

新しく生成されたチャットルームは公開ディレクトリに載ります。そうでない場合、一覧には載りません。何も指定しない場合は現在の状態が維持されます。

timezone(オプション)

このチャットルームのタイムゾーン

tags(オプション)

チャットルームに付ける新しいタグ。スペース区切りで指定します。スペースを単語の一部にしたい場合、ダブルクォーテーションでくくってください。

image(オプション)

新しいチャットルームに付ける画像。指定する場合、画像アップロード用件に従ってください。

format(オプション)

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

callback(オプション)

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


認証

このメソッドを呼び出すセッションではあらかじめ認証にパスしておく必要があります。

応答の例

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <room>
    <id>myawesomeroom</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>0</counter>
    <max_user_message_id>0</max_user_message_id>
    <tags/>
  </room>
</response>

応答の詳細

room

設定が変更されたルームを表す情報。構造は次のページを参照してください。→Room

エラーコード

100: 不正HTTPメソッド

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

102: 無効なセッション

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

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

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

106: ログインしていない

与えられたセッションログインしていないユーザの物です。

108: ルームID不正

与えられたルームIDの中に、IDとして使えない文字が含まれています。

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

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

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

126: IDが利用できない

指定されたルームIDは使用できない

127: 画像が大きすぎる

指定された画像が大きすぎる。