LingrJS

LingrJS

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

翻訳日: 2007/06/01

原文リビジョン: 1


lingr.jsJavaScriptで書かれたフル機能を備えたLingr APIクライアントです。Lingrサーバと通信するために動的scriptタグ生成手法を使っており、イベントハンドラを設定することで受け取りたいイベントに対して処理を行うことが出来ます。(例: 参加者の変化、何らかの発言、etc)


lingrtest.htmlが使い方のサンプルです。Lingr構造体へのオプションパラメータは以下の通り。


オプション設定

オプション必須/任意意味デフォルト
apiKey*1APIキーなし
session*1既存のセッションIDなし
ticket*1既存のチケットなし
roomId必須入室するルームのIDなし
dsrTimeout任意動的scriptタグ生成手法でのAPIコールのタイムアウト時間。ミリセカンドで指定。90000
clientType任意client_typeの指定human
nickname任意この参加者ニックネーム。指定しない場合は匿名として扱われます。なし
email任意passwordと同時に指定された場合、このセッションでまず認証を行った上で入室します。なし
password任意emailと同時に指定した場合、このセッションでまず認証を行った上で入室します。なし
contextLines任意指定した場合、その数だけ過去メッセージをonMessageReceivedイベントハンドラに渡して呼び出します。なし
userMessagesOnly任意trueの場合、ユーザメッセージプライベートメッセージのみをonMessagesReceivedイベントハンドラに渡して呼び出します。なし

*1: apiKey、sessionもしくはticketのいずれかが必要です


イベントハンドラ

イベントハンドラ発動タイミング
onSessionCreatedAPIセッションが生成されたあと
onSessionDestroyedAPIセッションが破棄されたあと
onSessionAuthenticatedAPIセッション内で、認証が終わったあと
onRoomEnteredルームに入室したあと
onRosterUpdated参加者リスト更新されたあと
onMessagesReceivedメッセージが受信されたあと
onRoomExitedルームから退室したあと
onApiFailure何らかのAPIコールに失敗したあと

もしlingr.jsを使ってサイトやツールを開発したら、ショーケースに追加して私たちに知らせてください!