dev:api:chat
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
dev:api:chat [2014/05/27 17:43] vikki |
dev:api:chat [2015/01/16 15:24] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== AOS Chat API commands - RFC ===== | + | [[: |
| + | ====== AOS Chat API commands - RFC ====== | ||
| + | |||
| + | \\ | ||
| Date: 5 Jun 2001\\ | Date: 5 Jun 2001\\ | ||
| Available: 11 Jun 2001\\ | Available: 11 Jun 2001\\ | ||
| Line 47: | Line 50: | ||
| **Parameters: | **Parameters: | ||
| - | ^Key ^Mandatory ^Description ^Sample | + | ^Key ^Mandatory ^Description ^Sample |
| - | |api |Yes |Indicate the http query is for API, only 1 argument accepted: " | + | |api |Yes |Indicate the http query is for API, only 1 argument accepted: " |
| - | |l |No |Number of messages to retrieve from the topic |10 | + | |l |No |Number of messages to retrieve from the topic |10 |
| - | |t |Yes |The topic name |Lobby | + | |t |Yes |The topic name |Lobby |
| **Result: | **Result: | ||
| Line 56: | Line 59: | ||
| **Record structure: | **Record structure: | ||
| - | ^Field No. ^Type ^Description ^Sample | + | ^Field No. ^Type ^Description ^Sample |
| - | |1 |Integer |Message posted time stamp |99055055 | + | |1 |Integer |Message posted time stamp |99055055 |
| - | |2 |DataStruct |User information data structure | | + | |2 |DataStruct |User information data structure |
| - | |3 |String |Message |Hi there! | + | |3 |String |Message |Hi there! |
| **User information data structure**\\ | **User information data structure**\\ | ||
| User data is at field 2 of the chat message record, using DEL (ASC 8) as field separator. | User data is at field 2 of the chat message record, using DEL (ASC 8) as field separator. | ||
| - | ^Field No. ^Type ^Description ^Sample | + | ^Field No. ^Type ^Description ^Sample |
| - | |1 |String |User name |john | + | |1 |String |User name |john |
| - | |2 |String |User host |acme.com | + | |2 |String |User host |acme.com |
| - | |3 |String |User full name |KC John | + | |3 |String |User full name |KC John | |
| - | |4 |String |User color |blue | + | |4 |String |User color |blue |
| - | |5 |String |User icon (face) |FirstAid.gif | + | |5 |String |User icon (face) |FirstAid.gif |
| **URL Sample:**\\ | **URL Sample:**\\ | ||
| Line 85: | Line 88: | ||
| **Parameters: | **Parameters: | ||
| - | ^Key ^Mandatory ^Description ^Sample | + | ^Key ^Mandatory ^Description ^Sample |
| - | |api |Yes |Indicate the http query is for API, only 1 argument accepted: " | + | |api |Yes |Indicate the http query is for API, only 1 argument accepted: " |
| - | |t |Yes |The topic to post the message into |Lobby | + | |t |Yes |The topic to post the message into |Lobby |
| - | |txt |Yes |The message Hi there! | + | |txt |Yes |The message |Hi there! |
| - | |f |No |Message font size N, deploy on <font size=N> | + | |f |No |Message font size N, deploy on <font size=N> |
| - | |s1 |No |Message style (1). " | + | |s1 |No |Message style (1). " |
| - | |s2 |No |Message style (2). " | + | |s2 |No |Message style (2). " |
| **URL Sample:**\\ | **URL Sample:**\\ | ||
| http:// | http:// | ||
dev/api/chat.1401183791.txt.gz · Last modified: 2015/01/16 15:24 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
