Protocol RAW

Louis Charette edited this page Apr 19, 2014 · 1 revision

The APE Client is controllable via RAWs sent by the APE server. The RAW's are sent via an HTTP request from as a responce to the connection that was made earlier via GET or POST methods. A command refers to data sent from the client to the server. A command is a JSON object with the following mandatory keys:

  • raw: Name of the raw
  • time: Time of the server when the raw as sent
  • data: A JSON object
[
    {
        "raw":"<raw name>",
        "time":"<Send time of the raw>",
        "data":{}
    }
]

#Multiple RAW sending APE can also send multiple RAW at once :

[
	{"raw":"LOGIN","time":"1241917853","datas":{"sessid":"fe9f5ee27889b8d67ff99d35b77aa12f"}},
	{"raw":"IDENT","time":"1241917853","datas":{"user":{"properties":{"name":"oozoy"},"casttype":"uni","pubid":"5150599277195552aa2aeb5f82f997e4"}}}
]

Here, APE sent the RAW "LOGIN" following by the RAW "IDENT".

#Extend commands APE is shipped out of the box with a large pannel of predefined RAW's, allowing lots of different actions such as :

  • DATA
  • IDENT
  • LOGIN
  • JOIN
  • LEFT
  • USER
  • ERR
  • CHANNEL
  • QUIT
  • SESSIONS
  • PROXY_EVENT

The following RAW's apear to be abandoned:

  • SETLVL
  • CHANMSG
  • TOPIC
  • SETTOPIC
  • USER
  • KICKED
  • BANNED
  • PROXY
  • UPDATE

#Events The APE_JSF can intercept RAW, based on that you can trigger further actions in your client. You can also define on the APE server the desired behaviour for every RAW that is send out.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.