The Channels Server manages all storage and message passing for the channels applications.
See the preceding section to see more information of the format of each object and model used in this database.
In order to create a channel, an authenticated user will send a PUT request to the route www.hosturl.com/channel/ with the following information:
{
"title": (String)
}If the request is valid with no errors, a JSON object will be sent back with relevant information, including an id that can be used to access the channel later:
{
"id": (String, Unique),
"success": true,
"err": null
}If a request is made with a channel title that already exists, or without a title parameter, than an object with the error will be returned.
{
"success": false,
"err": "That channel already exists!" | "A title must be indicated"
}Within the Channels application, a user may need to view information about a channel. They can do this with a GET request to the route www.hosturl.com/channel/CHANNEL_ID, where CHANNEL_ID is the id of the Channel that you wish to get information from. An object with the following format will be sent back:
{
"channel": {
null | channel object...
},
"err": null | err object
}Each channel will follow this format:
{
"id": (String, Unique),
"title": (String),
"history": [DateTime],
"count": (Integer),
"created": {DateTime, Username}
}Copyright © 2016 Good Enough Apps
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.