mirrors
/
PretendYoureXyzzy
mirror of https://github.com/ajanata/PretendYoureXyzzy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

still very incomplete

ajanata 2012-12-29 14:27:13 -08:00
parent 2ae5cc6f47
commit 9f941fa67a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
API.md Normal file

@ -0,0 +1,12 @@
Work-in-progress API documentation.
# Definitions
**AJAX_URL**: URL to the client action servlet.
**LONGPOLL_URL**: URL to the long-poll servlet.
**Constants**: Any references to "constants" would be referring to the data defined in https://github.com/ajanata/PretendYoureXyzzy/blob/master/src/net/socialgamer/cah/Constants.java. These values are used to express commands and parameters over the wire. Some UI strings are defined here as well (which you are free to replace with something equivalent).
**CONSTANTS_URL**: URL to the JavaScript version of the wire constants.
Long poll: The client MUST always keep a connection open to LONGPOLL_URL; the server will block until there is something to tell the client. When the client receives a response