SakaiのポータルチャットシステムにHTTPのインターフェースを提供する
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)
Sample Entity URLs (_id=':ID:') [may not be valid]:
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
URLのフォーマットは，"/direct/portal-chat/new"にあります．
他のユーザーにメッセージを送ってください．2つのパラメータを，宛先(SakaiユーザーID)とメッセージに入れてください．
Custom Actions
ping :
show (GET) :
[/portal-chat/:ID:/ping] (
txt) (
json)
URLのフォーマットは "/direct/portal-chat/USERTOPING/ping" であり， USERTOPING はSakaiのユーザIDです．is a Sakai user id. メールが正しくユーザーに送信できた場合は， "success" の文字列を返してください．
latestData :
show (GET) :
[/portal-chat/:ID:/latestData] (
txt) (
json)
URLのフォーマットは "/direct/portal-chat/ANYTHING/latestData.json?online=true&siteId=SITEID".
です．現在ログインしているユーザーのためのすべての最新のデータを取得します．この操作は，カレントユーザーのためのハートビートをセットするオプションでもあります．
もしチャット可能なユーザーリストを表示したくないのであれば，オンライン状態をオフにすることで，他のユーザーから見えないようにすることができます．最新のデータ操作によって接続，メッセージを取得でき，もし場所情報を特定するならば，ユーザーの現在のサイトのリストも取得できます．
Entity class : org.sakaiproject.portal.chat.entity.PCServiceEntityProvider$UserMessage
Type :: bean
|
Name |
Type |
Status |
| 1) | clear | boolean | Read/Write |
| 2) | content | string | Read/Write |
| 3) | from | string | Read/Write |
| 4) | fromConnection | boolean | Read/Write |
| 5) | siteId | string | Read/Write |
| 6) | timestamp | long | Read/Write |
| 7) | to | string | Read/Write |
| 8) | video | boolean | Read/Write |
Data and Request Handling
Output formats : txt, json
Input formats : html
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
|---|
| 1 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
| 2 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
| 3 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
| 4 | Createable | org.sakaiproject.entitybroker.entityprovider.capabilities.Createable | |
| 5 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 6 | Inputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable | |
| 7 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 8 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$