nova/Chatto
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

slight changes to jsdoc of jsonapi

Browse Source
This commit is contained in:
Rohan Sircar 2019-12-13 10:59:30 +05:30 committed by nova
parent 826dad2ad0
commit 1521c90a7d
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
chatto/src/main/javascript/ts/src/singleton/JsonAPI.ts
View File

@ -7,26 +7,30 @@ export namespace JsonAPI {
/**
* Json API URL for retrieving all messages between two users
*
* @format /api/chat/get/messages/{contactName}
* @example /api/chat/get/messages/some-user
*
* ### With sprintf
* const url = Sprintf(JsonAPI.CHAT_MESSAGES_GET, contactName);
*
* @format /api/chat/get/messages/{contactName}
* @example /api/chat/get/messages/some-user
*
*
* @param contactName
* The user whose messages wish to retrieve.
* The user whose messages we wish to retrieve.
*/
export const CHAT_MESSAGES_GET = `/api/chat/get/messages/%s`;
export const MESSAGE_POST = '/api/chat/post/message';
/**
* Json API URL for retrieving paginated messages between two users
* Page index starts with 0
* @example /api/chat/get/messages/some-user?page=0&size=5 will give the first page where each page has size 5
*
* ### With sprintf
* const url = Sprintf(JsonAPI.CHAT_MESSAGES_GET, contactName);
*
* @param contactName the user whose messages wish to retrieve
* @example /api/chat/get/messages/some-user?page=0&size=5 will give the first page where each page has size 5
*
*
*
* @param contactName the user whose messages we wish to retrieve
* @param page denotes the page required
* @param size denotes the size of each page
*/