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 |
...
On success
| key | value |
|---|---|
| channels | [{ "last_active":<number>, "policy":<null>, //not implemented yet
}, },..{}n] |
| Code Block | ||||
|---|---|---|---|---|
| ||||
response = v1_wrangler:channel("flipper",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 |
...
| Attribute | Datatype | Required |
|---|---|---|
| <eci> | <string> | //defaults to eci used to raise event |
| <channel_name> | <string> | √ |
| <channel_type> | <string> | //defaults to Unkown |
| <attributess> | <string> | |
| <policy> | <string> | //not fully implemented |
Event raised on success
| Event Domain | Event Type | Attributes |
|---|---|---|
| wrangler | channel_created | all attributes from original event |
deleteChannel
removes a channel corresponding with the provided event attributes
...
Event raised on success // not being raised yet
| Event Domain | Event Type | Attributes |
|---|---|---|
| wrangler | channel_deleted | all attributes from original event |
updateAttributes
updates attributes of a channel corresponding with the provided event attributes
| Event Domain | Event Type |
|---|---|
| wrangler | update_channel_attributes_requested |
must provide at least one of the two, eci and channel_name event attributes.
| Attribute | Datatype | Required |
|---|---|---|
| <eci> | <string> | |
| <channel_name> | <string> |
|
| <attributess> | <string> |
Event raised on success // not being raised yet
| Event Domain | Event Type | Attributes |
|---|---|---|
| wrangler | channel_attributes_updated | all attributes from original event |
updateType
updates type of a channel corresponding with the provided event attributes
| Event Domain | Event Type |
|---|---|
| wrangler | update_channel_type_requested |
must provide at least one of the two, eci and channel_name event attributes.
| Attribute | Datatype | Required |
|---|---|---|
| <eci> | <string> | |
| <channel_name> | <string> |
|
| <channel_type> | <string> |
Event raised on success // not being raised yet
| Event Domain | Event Type | Attributes |
|---|---|---|
| wrangler | channel_type_updated | all attributes from original event |
updatePolicy // not fully implamented
updates policy of a channel corresponding with the provided event attributes
| Event Domain | Event Type |
|---|---|
| wrangler | update_channel_type_requested |
must provide at least one of the two, eci and channel_name event attributes.
| Attribute | Datatype | Required |
|---|---|---|
| <eci> | <string> | |
| <channel_name> | <string> |
|
| <policy> | <string> |
Event raised on success // not being raised yet
| Event Domain | Event Type | Attributes |
|---|---|---|
| wrangler | channel_policy_updated | all attributes from original event |