| Note |
|---|
This page is unfinished. For a taste, see the engine module documentation. |
...
| Table of Contents | ||
|---|---|---|
|
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 |
...
| Parameter | Datatype | Required | |
|---|---|---|---|
| <id> | <string> |
| |
| <collection> | <string> | ||
| <filtered> | <string> |
- <id> = <channel_name> | <channel_eci>
- <collection> = <type> | <name> | <cid>(will be eci soon) | <last_active> | <attributes>(may break)
- <filtered> = <desired value of collection>
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 |
...
| Parameter | Datatype | Required | |
|---|---|---|---|
| <eci> | <string> |
| |
| <name> | <string> |
- <eci> = <channel_eci>
- <name> = <channel_name>
On success
| key | value |
|---|---|
| attributes | {"channel_attributes":<string> // for example "Time_hopping" } |
| Code Block | ||||
|---|---|---|---|---|
| ||||
response = v1_wrangler:channelAttributes("532569A0-43BB-11E6-AA23-29E4C71C24B1",null){"attributes"}; // attributes by eci
response = v1_wrangler:channelAttributes(null,"Dr.Who"){"attributes"}; // attributes by channel name
|
...
| Parameter | Datatype | Required | |
|---|---|---|---|
| <eci> | <string> |
| |
| <name> | <string> |
- <eci> = <channel_eci>
- <name> = <channel_name>
On success
| key | value |
|---|---|
| policy | {"error":[""] } |
| Code Block | ||||
|---|---|---|---|---|
| ||||
response = v1_wrangler:channelPolicy("532569A0-43BB-11E6-AA23-29E4C71C24B1",null){"policy"}; // policy by eci
response = v1_wrangler:channelPolicy(null,"Dr.Who"){"policy"}; // policy by channel name |
channelType
returns a type as a string keyed to type.
...
| Parameter | Datatype | Required | |
|---|---|---|---|
| <eci> | <string> |
| |
| <name> | <string> |
|
- <eci> = <channel_eci>
- <name> = <channel_name>
On success
| key | value |
|---|---|
| type | <string> // for example "Time_wizard" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
response = v1_wrangler:channelType("532569A0-43BB-11E6-AA23-29E4C71C24B1",null){"type"}; // type by eci
response = v1_wrangler:channelType(null,"Dr.Who"){"type"}; // type by channel name |
...
| 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 |
...
| Attribute | Datatype | Required | |
|---|---|---|---|
| <eci> | <string> | ||
| <channel_name> | <string> |
|
Event raised on success // not being raised yet
...
| Attribute | Datatype | Required | |
|---|---|---|---|
| <eci> | <string> | ||
| <channel_name> | <string> | ||
| <attributess> | <string> |
Event raised on success // not being raised yet
...
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| Status | ||||
|---|---|---|---|---|
|
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 |
...