...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Info | ||
|---|---|---|
| ||
Create an organization for documentation by being precise with headings and using the child display macro to see it at the start of the page. I've added it below. Note that it's not very helpful because the structure of the page isn't very precise. |
| Child pages (Children Display) | ||
|---|---|---|
|
Channel Functions
| Function | Use |
|---|---|
| channel | List a set of channels depending on what parameters are past. |
| channelAttributes | Lists a channels attributes |
| channelPolicy | Lists a channels policy |
| channelType | Lists a channels type |
All channel functions return an object with a status and an return object. Documentation will referance the return object only.
Channel Actions
| Event Domain | Event Type | Actions | Use |
|---|---|---|---|
| wrangler | channel_creation_requested | createChannel | Creates a new channel |
| wrangler | channel_deletion_requested | deleteChannel | Deletes a channel |
| wrangler | update_channel_attributes_requested | updateAttributes | Updates a channel attributes |
| wrangler | update_channel_policy_requested | updatePolicy | Updates a channel policy |
| wrangler | update_channel_type_requested | updateType | Updates a channel type |
...
On success
| key | value |
|---|---|
| channels | [{ "last_active":<number>, "policy":<null>, //not implemented yet
}, },..{}n] |
uses example
| Code Block | ||||
|---|---|---|---|---|
| ||||
response = v1_wrangler:channel(null,null,null){"channels"}; // all channels
response = v1_wrangler:channel("flipper",null,null){"channels"}; // single "flipper" channel
response = v1_wrangler:channel(null,"type",null){"channels"}; // collection of channels by type
response = v1_wrangler:channel(null,"type","OAUTH"){"channels"}; // collection of channels with "OAUTH" as type |
...