Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

returns an array of subscriptions collections keyed to subscriptions. Each subscriptions is owned by the pico which calls this function.

Parameter
Datatype
Required
<id><string>

 

<collection><string> 
<filtered><string> 
  • <id> = <subscription channel_name> | <subscriptions channel_eci> | <subscriptions_name>
  • <collection> = <name_space> | <relationship> | <status> |  <channel_name> | <inbound_eci> | <outbound_eci> | <subscriber_role> | <my_role> | <subscriber_eci>(might break things) |<attributes>
  • <filtered> = <desired value of collection>

On success

key
value
subscriptions
[{
<name_space:channel_name>:
      {"name_space":<string>,
       "relationship":<string>,
       "status":<string>,
       "channel_name":<string>,
       "inbound_eci":<string>,
       "subscriber_role":<string>,
       "my_role":<string>,
       "subscriber_eci":<string>,
       "attributes":<string>,
       "subscription_name":<string>
       },

},..{}n

]

 

uses example

 

Code Block
languagejavascript
themeConfluence
response = v1_wrangler:subscriptions(null,null,null){"subscriptions"};
 
 // all subscriptions

response = v1_wrangler:subscriptions("flipper",null,null){"subscriptions"};
 
 // single "flipper" subscriptions

response = v1_wrangler:subscriptions(null,"status",null){"subscriptions"};
 
 // collection of subscriptions by status

response = v1_wrangler:subscriptions(null,"status","inbound"){"subscriptions"};
 
 // collection of subscriptions with "inbound" as status