Message

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

翻訳日: 2007/05/21

原文リビジョン: 8

いくつかのAPIメソッドはメッセージを記述するドキュメントを返します。メッセージの記述には次の要素を含みます。

■ id

メッセージにつけられたユニークID。

■ type

メッセージのタイプ。以下の値を取り得ます。

user

ユーザの発言。

private

プライベートメッセージとして送信されたユーザの発言

system:enter

これはシステムによって送信されたメッセージで、新しい人が入室した。

system:nickname_change

これはシステムによって送信されたメッセージで、入室者の一人がニックネームを変更した。

system:leave

これはシステムによって送信されたメッセージで、入室者の一人が退室した。

system:broadcast

システムによって全てのルームに対して送信されたメッセージ。

■ occupant_id

メッセージタイプがuserのメッセージについては、この値は発言者のIDです。システムメッセージの場合は、そのメッセージがどの入室者に対してかをあらわします。(訳者注: 入室メッセージの場合、入ってきた人のIDが入ります。)

■ user_id

このメッセージの発言者が持つユーザID。

この要素は発言者がログイン状態のときのみ含まれます。

■ nickname

このメッセージの発言者が持つニックネーム。

■ new_nickname

メッセージタイプがsystem:nickname_changeの場合、新しい変更後のニックネーム。ほかのメッセージタイプの場合はこの要素は省略されます。

■ source

このメッセージの発言者がこのルームに対してどのように関与しているか。

"browser"の場合、このユーザはwww.lingr.comのウェブサイトを使って発言しました。

"api"の場合は何らかのLingr API応用アプリケーションを使用しています。

システムメッセージの場合、それを引き起こした参加者の持つ値が渡ります。

■ client_type

このメッセージの発言者が使用しているクライアントアプリケーションのタイプを表します。値としては"human"か"automaton"の二つを取り得ます。

"human"の場合、そのクライアントは人間によって操作されています。"automaton"の場合、このクライアントは人間の関与なしに発言します。詳細は次のページを参照してください。→client_type

システムメッセージの場合、それを引き起こした参加者の持つ値が渡ります。

■ icon_url

このメッセージの発言者が持つ、アバターアイコンのURL。このURLの構造は次のページを参照してください。→Image URLs

■ timestamp

このメッセージが発言された時刻。YYYY-MM-DDThh:mm:ssTZDの形のISO-8601フォーマットで表記されています。

■ room_id

このメッセージが属するルームのID。この要素はexplore.searchArchivesの戻り値にのみ現れます。

■ score

同じ結果に含まれるメッセージの中でこのメッセージの確からしさを表すスコア。0から1の小数で表され、1が最大となります。この要素はexolore.searchArchivesの戻り値にのみ含まれます。

■ text

メッセージの本文。