{"type":"doc","content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"3"},"exclude":{"value":"Notes"}},"macroMetadata":{"macroId":{"value":"a88e3698-fd69-49ef-8018-f5acd53adab9"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":3},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For all","type":"text"},{"text":" ","type":"text"},{"text":"functions","type":"text","marks":[{"type":"strong"}]},{"text":", enter the parameters in the order listed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Italicized","type":"text","marks":[{"type":"em"}]},{"text":" ","type":"text"},{"text":"parameters are ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Received Events ","type":"text","marks":[{"type":"strong"}]},{"text":"are events of the \"wrangler\" domain that Wrangler will respond to","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Raised Events","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"are events that can be selected on within any ruleset in the pico when they occur","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sent Events","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"are events that the pico will send elsewhere as a result of triggering a Wrangler event.","type":"text"}]}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"INLINE

"io.picolabs.relationship" must be installed on your pico for these to work

See Managing Relationsips for an in-depth explanation on the relationship process.

Functions

established

Returns all of the established relationships for this pico in an array

Returns

NO ARGS: An array of relationship maps

key and value passed: The array will be filtered according to if the value at the key relationship attribute matches the value parameter

Parameters

Parameter	Datatype	Description
key	String	The relationship attribute that you want to filter for
value	String	The value of the relationship attribute you want to filter for

Returns

An array of established relationships. Possibly filtered.

jsConfluenceExample

outbound

Returns the pending outbound relationship requests in an array

Returns

NO ARGS: An array of pending outbound relationship maps

key and value passed: The array will be filtered according to if the value at the key map attribute matches the value parameter

Parameters

Returns

An array of outbound relationships. Possibly filtered.

jsConfluenceExample

inbound

Returns the pending inbound relationship requests in an array

Returns

NO ARGS: An array of pending inbound relationship maps

key and value passed: The array will be filtered according to if the value at the key map attribute matches the value parameter

Parameters

Parameter	Datatype	Description
key	String	The inbound relationship attribute that you want to filter for
value	String	The value of the inbound relationship attribute you want to filter for

Returns

An array of inbound relationship. Possibly filtered.

jsConfluenceExample

wellKnown_Rx

Returns the channel map of the WellKnown_Rx for this pico

Returns

A map in the channel map structure, describing the channel for the WellKnown_Rx on this pico.

jsConfluenceExample

autoAcceptConfig

Returns the current autoAccept configuration for relationships. This map represents a configuration that you can set for auto accepting relationship requests with the added attribute value.

Returns

A map with the auto accept configuration of the pico's relationship ruleset.

jsConfluenceExample

Received Events

relationship

wrangler:relationship

When a pico receives or raises this event, it initiates the relationship protocol. Through the protocol, a wrangler:inbound_pending_relationship_added event will be raised within the other pico. A wrangler:outbound_pending_relationship_added event will be raised in the pico which received the initial wrangler:relationship event.

Attributes

Attribute	Datatype	Description
wellKnown_Tx	String	The wellKnown_Rx channel from the other pico that you want to establish a relationship with.
name	String	The name of the Rx to be created on each pico. Defaults to a random English word if not given.
channel_type	String	The channel type that you want both pico's Rx to be
Rx_role	String	Describes this pico's role in the relationship
Tx_role	String	Describes the other pico's role in the relationship
Id	String	Optionally provide a custom Id for the relationship, defaults to a UUID. Be very careful when providing your own Id.
Tx_host	String	The network address of the engine hosting the other pico to relate to. Defaults to the same engine.
password	String	Not implemented

Directives Returned

Will return empty directives.

Corresponding Raised Events:

Wrangler Full API#inbound_pending_relationship_added in the other pico

pending_relationship_approval

wrangler:pending_relationship_approval

Should be raised by the developer as a response to wrangler:inbound_pending_relationship_added. The pico which received a wrangler:inbound_pending_relationship_added event should review the attributes and raise the wrangler:pending_relationship_approval event if the pico accepts the incoming relationship. See the example code for how this can be easily signaled using the "attributes" keyword.

Attributes

Must provide any one of the attributes.

Attribute	Datatype	Description
Rx	String	The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:inbound_pending_relationship_added.
Tx	String	The channel on the pico that sent the relationship request that was created to receive events from this pico.
Id	String	The relationship Id of the relationship you want to accept. Also given in wrangler:inbound_pending_relationship_added.

Directives Returned

Will return empty directives.

An example of a rule that raises wrangler:pending_relationship_approval to accept an inbound relationship request.

jsConfluenceExample

Corresponding Raised Events:

Wrangler Full API#relationship_added in the other pico

send_event_on_relationships

wrangler:send_event_on_relationships

This event can be used to send an arbitrary event to one or many relationships. Given a relationship ID, it will send the event on that relationship. Given a Tx_role or Rx_role it will send an event to all relationships that have that Tx_role or Rx_role recorded.

Attributes

Must provide any one of the attributes.

Attribute	Datatype	Description
domain	String	The domain of the event to send
type	String	The type of the event you want to send
attrs	Map	A map of the attributes you want to be associated with the sent event
subID	String	The relationship ID of the relationship you want to send the event on
Rx_role	String	The Rx_role of the relationship you want to send the event on
Tx_role	String	The Tx_role of the relationship you want to send the event on

Directives Returned

Will return empty directives.

outbound_cancellation

wrangler:outbound_cancellation

Raise this within the pico that initiated the relationship creation exchange to cancel an outbound relationship request.

Attributes

Must provide any one of the attributes.

Attribute	Datatype	Description
Rx	String	The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:outbound_pending_relationship_added.
Id	String	The relationship Id of the outbound relationship request you want to cancel.

Directives Returned

Will return empty directives.

Corresponding Raised Events:

Wrangler Full API#outbound_relationship_cancelled
Wrangler Full API#inbound_relationship_cancelled in the other pico

inbound_rejection

wrangler:inbound_rejection

Raise this within the pico that has received an inbound_pending_relationship_added event to cancel an an inbound relationship request.

Attributes

Must provide any one of the attributes.

Attribute	Datatype	Description
Rx	String	The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:inbound_pending_relationship_added.
Id	String	The relationship Id of the inbound relationship request you want to cancel. Also given in wrangler:inbound_pending_relationship_added.

Directives Returned

Will return empty directives.

jsConfluenceExample

Corresponding Raised Events:

Wrangler Full API#outbound_relationship_cancelled in the other pico
Wrangler Full API#inbound_relationship_cancelled

relationship_cancellation

wrangler:relationship_cancellation

Raise this within a pico to cancel its relationship to another pico.

Attributes

Provide any one of the attributes.

If none of these attributes are given it will try to cancel the relationship associated with the channel the event was received on.

Attribute	Datatype	Description
Rx	String	The receiving channel created for the relationship you want to cancel.
Tx	String	The transmitting channel for the relationship you want to cancel.
Id	String	The Id of the relationship you want to cancel.

Directives Returned

Will return empty directives.

jsConfluenceExample

Corresponding Raised Events:

Wrangler Full API#relationship_removed in both picos in the relationship relationship

Raised Events

relationship_added

wrangler:relationship:added

Fired within a pico whenever a new relationship has been added.

Attributes Added

Attribute	Datatype	Description
Id	String	The relationship ID of the added relationship
Tx	String	The transmitting channel for the added relationship
Rx_role	String	The role this pico has in this relationship
Tx_role	String or NULL	The role the other pico has in the relationship
Tx_public_key	String or NULL	The key used for decryption of encrypted messages sent through the relationship
Tx_verify_key	String	The key used for verifying signed messages to send through the relationship
bus	Map	Holds the above information but contains the receiving channel under key "Rx" and if the other pico is on a different host, its host under key "Tx_host"

The event attributes look like the following structure:

jsConfluenceExample

An example of a rule selecting on a new relationship creation.

jsConfluenceExample

relationship_removed

wrangler:relationship_removed

Raised within the pico when a relationship has been removed.

Attributes Added

Attribute	Datatype	Description
Id	String	The relationship ID of the added relationship
bus	Map	Contains more information on the removed relationship

The event attributes look like the following structure:

jsConfluenceExample

An example of a rule selecting on a relationship removal.

jsConfluenceExample

inbound_pending_relationship_added

wrangler:inbound_pending_relationship_added

This event is raised within the pico when a new inbound relationship request has been sent to the pico, and the developer needs to approve it. Typical use is to use the event attributes to determine whether the relationship is one you are expecting, and then raising wrangler:pending_relationship_approval if they are.

Attributes Added

Attribute	Datatype	Description
Id	String	The relationship ID of the added relationship
Rx	String	The receiving channel that this pico will receive relationship events on
Rx_role	String	The role that this pico will take in the relationship
Tx	String	The channel to transmit events to on the other pico
Tx_host	String	The network address of the pico engine hosting the other pico in the relationship
Tx_public_key	String
Tx_role	String	The role of the other pico in the relationship relationship
Tx_verify_key	String
channel_name	String	The name of the channel created for the relationship
channel_type	String	The type of the channel created for the relationship
name	String	Also the name of the channel created for the relationship
public_key	String
verify_key	String
wellKnown_Tx	String	The wellKnown of this pico

The event attributes look like the following structure, depending on the arguments given to wrangler:relationship on the other pico:

jsConfluenceExample

An example of a rule accepting new relationship requests by selecting on wrangler:inbound_pending_relationship_added:

jsConfluenceExample

outbound_pending_relationship_added

wrangler:outbound_pending_relationship_added

This is raised within the pico that has just initiated a relationship request using wrangler:relationship. This allows manipulation of the outgoing request, including cancelling it if necessary.

Attributes Added

These are currently identical to the attributes passed to wrangler:relationship.

Attribute	Datatype	Description
Rx_role	String	The role that this pico will take in the relationship
Tx_host	String	The network address of the pico engine hosting the other pico in the relationship
Tx_role	String	The role of the other pico in the relationship relationship
channel_type	String	The type of the channel created for the relationship
name	String	The name of the channel created for the relationship
wellKnown_Tx	String	The wellKnown of the pico the request is being sent to

The event attributes look like the following structure, depending on the arguments given to wrangler:relationship:

jsConfluenceExample

An example of a rule selecting on wrangler:oubound_pending_relationship_added to prepare for the relationship.

jsConfluenceExample

outbound_relationship_cancelled

wrangler:outbound_relationship_cancelled

Raised when an outbound relationship has been cancelled through the use of wrangler:outbound_cancellation or the inbound request rejected on the other pico using wrangler:inbound_rejection.

Attributes Added

Attribute	Datatype	Description
Id	String	The Id that had been created for the possible relationship
Rx/Tx	String	Use the bus attribute to get information. This attribute will change depending on how the relationship was cancelled. It will give a channel that was originally created for the relationship from either pico.
bus	Map	The internals of the cancelled outbound request. See attached example for its values.

An example of a rule selecting on wrangler:outbound_relationship_cancelled:

jsConfluenceExample

The structure of the bus when the oubound relationship has been cancelled:

jsConfluenceExample

inbound_relationship_cancelled

wrangler:inbound_relationship_cancelled

Raised when an inbound relationship has been cancelled through the use of wrangler:inbound_rejection or the outbound request was rejected on the other pico using wrangler:outbound_cancellation.

Attributes Added

Attribute	Datatype	Description
Id	String	The Id that had been created for the possible relationship
Rx/Tx	String	Use the bus attribute to get information. This attribute will change depending on how the relationship was cancelled. It will give a channel that was originally created for the relationship from either pico.
bus	Map	The internals of the cancelled inbound request. The internals of the cancelled outbound request. See attached example for its values.

An example of a rule selecting on wrangler:inbound_relationship_cancelled:

jsConfluenceExample

The structure of the bus when the inbound relationship has been cancelled:

jsConfluenceExample

","nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{"atlassian-macro-output-type":{"value":"INLINE"}},"macroMetadata":{"macroId":{"value":"87a14fd3-15d9-43a4-bf65-b99b1a82bb04"},"schemaVersion":{"value":"1"},"title":"Excerpt"}}},"content":[{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"\"io.picolabs.relationship\" must be installed on your pico for these to work","type":"text"}]}]},{"type":"paragraph","content":[{"text":"See Managing Relationsips for an in-depth explanation on the relationship process.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Functions","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"established","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns all of the established relationships for this pico in an array","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"NO ARGS: An array of relationship maps","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" and ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" passed: The array will be filtered according to if the value at the ","type":"text"},{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" relationship attribute matches the ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" parameter","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2113.272},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship attribute that you want to filter for","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"value","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The value of the relationship attribute you want to filter for","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Returns","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"An array of established relationships. Possibly filtered.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"establishedArray = relationship:established()\n/*\n[\n {\n \"Tx_host\": \"http://10.37.68.7:8080\", // The host of the other pico\n \"Id\": \"cjrcuow1a001q04rqu6h7ihit\", // The ID of the relationship\n \"Tx\": \"5V8ks8hmirW8MfE96aNaHn\", // The transmitting channel to send events to on the other pico\n \"Rx\": \"5N8EnBfeCA3ajsniKDZdkQ\", // The receiving channel to receive events on this pico\n\t\"Tx_role\": \"sensor\", // The role of the pico on the other end of the relationship\n\t\"Rx_role\": \"manager\", // This pico's role from its own perspective\n \"Tx_verify_key\": \"3SnLikfRD8Cm5JtHaWe26byvcn4f7bQAVVZM2zWEEgUm\", // The key used for verifying signed messages sent through the relationship\n \"Tx_public_key\": \"FzkwstPeu7jQamcsY4HycW6f4RmNNPynqCveTiGbsVHy\" // The public key used for encrypting messages to send to the other pico\n },\n {\n \"Id\": \"cjrcv4dwt003004rqdonu3ulx\",\n \"Rx\": \"E8Ei7TFbUNs4VSqsYHBWhb\",\n \"Tx\": \"T7wRhAvKNJocFezx2QCUpY\",\n \"Tx_verify_key\": \"FEhBwJFRy9WGx3QQPaKWXSvxB9YRQDNk6QVmX1GW9e6y\",\n \"Tx_public_key\": \"5UENb6pXGw5W9Vmz9uKmkzoMWifxWfeDLHsnFhMvkCYK\"\n }\n]\n*/","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"outbound","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns the pending outbound relationship requests in an array","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"NO ARGS: An array of pending outbound relationship maps","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" and ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" passed: The array will be filtered according to if the value at the ","type":"text"},{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" map attribute matches the ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" parameter","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"An array of outbound relationships. Possibly filtered.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"pendingOutboundRels = relationship:outbound()\n/*\n[\n {\n \"Id\": \"cjrcv6tzl003g04rqlri0vqqw\",\n \"wellKnown_Tx\": \"HLy15B5xmws3avFpbS6beZ\",\n \"Rx\": \"AgZKbAHa47RYytKBAK31DF\"\n }\n]\n*/","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"inbound","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns the pending inbound relationship requests in an array","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"NO ARGS: An array of pending inbound relationship maps","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" and ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" passed: The array will be filtered according to if the value at the ","type":"text"},{"text":"key","type":"text","marks":[{"type":"underline"}]},{"text":" map attribute matches the ","type":"text"},{"text":"value","type":"text","marks":[{"type":"underline"}]},{"text":" parameter","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2113.272},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The inbound relationship attribute that you want to filter for","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[302.54]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"value","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.93]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1539.8]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The value of the inbound relationship attribute you want to filter for","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Returns","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"An array of inbound relationship. Possibly filtered.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"pendingInboundRels = relationship:inbound()\n/*\n[\n {\n \"Id\": \"cjrcv6tzl003g04rqlri0vqqw\", // The ID of the relationship\n \"Tx\": \"AgZKbAHa47RYytKBAK31DF\", // The channel to transmit events to on the other pico\n \"Rx\": \"GTh2ZdE6tpWqQQQ3jHL1Dv\", // The channel to receive events on for this pico\n \"Tx_verify_key\": \"6H4w3JV3VktkV1hAkYXFbba1d1dYSTQfZ7PgdcBtrnGs\", // signing key for sending signed messages\n \"Tx_public_key\": \"GaTt4ChY1Fre39szbRGLVE4waVGJ3qqo1NQWg1nutugN\" // public key for encrypting messages\n },\n {\n \"Id\": \"cjrcvvq0e004104rq8obn20e0\",\n \"Tx\": \"X9o6b6dhGevQGNZCyg3AEx\",\n \"Rx\": \"Rj6ACgfzVhU6PNgbjHhNTz\",\n \"Tx_verify_key\": \"HS9rJbPdQjsgY4q18eVxv7QPQkJcTdN14aiorDHeEEhu\",\n \"Tx_public_key\": \"DxbYXzoj9ozkHUz2NtWm7aXgGUSuRR8BbQTZeT1aKAni\"\n }\n]\n*/","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"wellKnown_Rx"},"legacyAnchorId":{"value":"RelationshipsAPI-wellKnown_Rx"}},"macroMetadata":{"macroId":{"value":"ef746d9d-1ea4-4d09-9a38-2f31e1218d81"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"wellKnown_Rx","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns the channel map of the WellKnown_Rx for this pico","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"A map in the channel map structure, describing the channel for the WellKnown_Rx on this pico.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"wellKnownChannel = relationship:wellKnown_Rx()\n/*\n{\n \"id\": \"Cv1x3ufMEemxoYwFZ41WKb\",\n \"pico_id\": \"cjrb850we001cnkrq4in3pd37\",\n \"name\": \"wellKnown_Rx\",\n \"type\": \"Tx_Rx\",\n \"policy_id\": \"cjrcuog6b001l04rqfxz9lnei\",\n \"sovrin\": {\n \"did\": \"Cv1x3ufMEdmxoYwFZ41WKb\",\n \"verifyKey\": \"7VddbRHoDdxGBvqL6iYMi83T3QoKxxCLjNijMFawXbcV\",\n \"encryptionPublicKey\": \"BX1eddj7carru3KEd4CrAwmxG6S7A16hbpDCSoUXaGdw\"\n }\n}\n*/","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"autoAcceptConfig","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Returns the current autoAccept configuration for relationships. This map represents a configuration that you can set for auto accepting relationship requests with the added attribute value.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Returns","type":"text"}]},{"type":"paragraph","content":[{"text":"A map with the auto accept configuration of the pico's relationship ruleset.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"relationshipConfig = relationship:autoAcceptConfig()\n/*\n{\n \"password\": [\n \"1234\"\n ]\n}\n*/","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Received Events","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"relationship","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:relationship","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"When a pico receives or raises this event, it initiates the relationship protocol. Through the protocol, a wrangler:inbound_pending_relationship_added event will be raised within the other pico. A wrangler:outbound_pending_relationship_added event will be raised in the pico which received the initial wrangler:relationship event.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2180.8959999999997},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"wellKnown_Tx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The wellKnown_Rx channel from the other pico that you want to establish a relationship with.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"name","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The name of the Rx to be created on each pico. Defaults to a random English word if not given.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"channel_type","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The channel type that you want both pico's Rx to be","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx_role","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Describes this pico's role in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_role","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Describes the other pico's role in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Optionally provide a custom Id for the relationship, defaults to a UUID. Be very careful when providing your own Id.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_host","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The network address of the engine hosting the other pico to relate to. Defaults to the same engine.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"password","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}},{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Not implemented","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Corresponding Raised Events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#inbound_pending_relationship_added in the other pico","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"pending_relationship_approval","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:pending_relationship_approval","type":"text"}]},{"type":"paragraph","content":[{"text":"Should be raised by the developer as a response to wrangler:inbound_pending_relationship_added. The pico which received a wrangler:inbound_pending_relationship_added event should review the attributes and raise the wrangler:pending_relationship_approval event if the pico accepts the incoming relationship. See the example code for how this can be easily signaled using the \"attributes\" keyword.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"Must provide any one of the attributes.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2180.8959999999997},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:inbound_pending_relationship_added.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The channel on the pico that sent the relationship request that was created to receive events from this pico.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship Id of the relationship you want to accept. Also given in wrangler:inbound_pending_relationship_added.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a rule that raises wrangler:pending_relationship_approval to accept an inbound relationship request.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"/*\n rule auto_accept {\n select when wrangler inbound_pending_relationship_added\n pre {\n attributes = event:attrs.klog(\"inbound relationship attributes: \")\n }\n always {\n raise wrangler event \"pending_relationship_approval\"\n attributes attributes);\n }\n*/","type":"text"}]},{"type":"paragraph","content":[{"text":"Corresponding Raised Events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#relationship_added in the other pico","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"send_event_on_relationships","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:send_event_on_relationships","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This event can be used to send an arbitrary event to one or many relationships. Given a relationship ID, it will send the event on that relationship. Given a Tx_role or Rx_role it will send an event to all relationships that have that Tx_role or Rx_role recorded.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"Must provide any one of the attributes.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2590.96},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"domain","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The domain of the event to send","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The type of the event you want to send","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"attrs","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Map","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"A map of the attributes you want to be associated with the sent event","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"subID","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship ID of the relationship you want to send the event on","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx_role","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The Rx_role of the relationship you want to send the event on","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[273.96]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_role","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[266.99]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[2050.02]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The Tx_role of the relationship you want to send the event on","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"outbound_cancellation","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:outbound_cancellation","type":"text"}]},{"type":"paragraph","content":[{"text":"Raise this within the pico that initiated the relationship creation exchange to cancel an outbound relationship request.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"Must provide any one of the attributes.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2180.8959999999997},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:outbound_pending_relationship_added.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship Id of the outbound relationship request you want to cancel.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Corresponding Raised Events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#outbound_relationship_cancelled","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#inbound_relationship_cancelled in the other pico","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"inbound_rejection","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:inbound_rejection","type":"text"}]},{"type":"paragraph","content":[{"text":"Raise this within the pico that has received an inbound_pending_relationship_added event to cancel an an inbound relationship request.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"Must provide any one of the attributes.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2180.764},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[269.12]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.44]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1640.21]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[269.12]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.44]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1640.21]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The receiving channel created for this relationship. This is already created and given as an attribute of wrangler:inbound_pending_relationship_added.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[269.12]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.44]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1640.21]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship Id of the inbound relationship request you want to cancel. Also given in wrangler:inbound_pending_relationship_added.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"/*\n rule auto_deny {\n select when wrangler inbound_pending_relationship_added\n pre {\n attributes = event:attrs.klog(\"inbound relationship attributes: \")\n }\n always {\n raise wrangler event \"inbound_rejection\" \n attributes event:attrs);\n }\n*/","type":"text"}]},{"type":"paragraph","content":[{"text":"Corresponding Raised Events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#outbound_relationship_cancelled in the other pico","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#inbound_relationship_cancelled","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"relationship_cancellation","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:relationship_cancellation","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Raise this within a pico to cancel its relationship to another pico. ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes","type":"text"}]},{"type":"paragraph","content":[{"text":"Provide any one of the attributes. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If none of these attributes are given it will try to cancel the relationship associated with the channel the event was received on.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2180.8959999999997},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The receiving channel created for the relationship you want to cancel.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The transmitting channel for the relationship you want to cancel.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.66]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.92]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1641.32]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The Id of the relationship you want to cancel.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Directives Returned","type":"text"}]},{"type":"paragraph","content":[{"text":"Will return empty directives. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"/*\n{\n \"directives\": []\n}\n*/","type":"text"}]},{"type":"paragraph","content":[{"text":"Corresponding Raised Events:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Wrangler Full API#relationship_removed in both picos in the relationship relationship","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Raised Events","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"relationship_added"},"legacyAnchorId":{"value":"RelationshipsAPI-relationship_added"}},"macroMetadata":{"macroId":{"value":"d55e15e1-a725-46ee-967c-1c5765e3feb9"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"relationship_added","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:relationship:added","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Fired within a pico whenever a new relationship has been added.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship ID of the added relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The transmitting channel for the added relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role this pico has in this relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String or NULL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role the other pico has in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_public_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String or NULL","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The key used for decryption of encrypted messages sent through the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_verify_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The key used for verifying signed messages to send through the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"bus","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Map","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Holds the above information but contains the receiving channel under key \"Rx\" and if the other pico is on a different host, its host under key \"Tx_host\"","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The event attributes look like the following structure:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"Id\": \"cjrl7rbbh005kksrqle152lji\",\n \"Tx\": \"DWkbD6URr3JuQWtq9FjzQH\",\n \"Tx_public_key\": \"DWbUgvRLhtrp6Zv4CbuMLCZnV9qShsB2bXfW4E5EbEYh\",\n \"Tx_verify_key\": \"7pZSMfshJjPhjDbspNgko2KkmfET3pgW733UAZkbKxSX\",\n \"_headers\": { // These were appended from the HTTP communication between the two picos\n \"content-type\": \"application/json\",\n \"host\": \"10.37.155.96:8080\",\n \"content-length\": \"585\",\n \"connection\": \"close\"\n },\n \"bus\": {\n \"Tx_host\": \"http://localhost:8080\",\n \"Id\": \"cjrl7rbbh005kksrqle152lji\",\n \"Rx\": \"UGRZHTfz5P9AXFb4WXkJF8\",\n \"Tx\": \"DWkbD6URr3JuQWtq9FjzQH\",\n \"Tx_verify_key\": \"7pZSMfshJjPhjDbspNgko2KkmfET3pgW733UAZkbKxSX\",\n \"Tx_public_key\": \"DWbUgvRLhtrp6Zv4CbuMLCZnV9qShsB2bXfW4E5EbEYh\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a rule selecting on a new relationship creation.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule get_peer_ids {\n select when wrangler relationship_added\n foreach relationship:established() setting (relationship)\n pre {\n }\n if (relationship{\"Rx_role\"}.klog(\"RX_ROLE: \") == \"node\") then\n event:send({\n \"eci\":relationship{\"Tx\"},\n \"eid\":\"getting_info\",\n \"domain\":\"gossip\",\n \"type\":\"get_peer_id\",\n \"attrs\":{\n \"channel\":relationship{\"Tx\"}\n }\n }, relationship{\"Tx_host\"}.defaultsTo(meta:host))\n fired {\n ent:relationship_result := event:attrs\n }\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"relationship_removed"},"legacyAnchorId":{"value":"RelationshipsAPI-relationship_removed"}},"macroMetadata":{"macroId":{"value":"c0a28ac2-a1de-40d9-8818-66cbf8884263"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"relationship_removed","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:relationship_removed","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Raised within the pico when a relationship has been removed.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship ID of the added relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"bus","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Map","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Contains more information on the removed relationship","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The event attributes look like the following structure:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"Id\": \"cjrmo1pox002fvkrq36wbu7tk\",\n \"_headers\": { // These were appended from the HTTP communication between the two picos\n \"host\": \"localhost:8080\",\n \"connection\": \"keep-alive\",\n \"accept\": \"application/json, text/javascript, */*; q=0.01\",\n \"x-requested-with\": \"XMLHttpRequest\",\n \"user-agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.81 Safari/537.36\",\n \"referer\": \"http://localhost:8080/\",\n \"accept-encoding\": \"gzip, deflate, br\",\n \"accept-language\": \"en-US,en;q=0.9\"\n },\n \"bus\": {\n \"Rx_role\": \"10\",\n \"Tx_role\": \"2\",\n \"Tx_host\": \"http://10.37.184.244:8080\",\n \"Id\": \"cjrmo1pox002fvkrq36wbu7tk\",\n \"Tx\": \"BcAgD4DVKfmhsxKPhi55dz\",\n \"Rx\": \"QWEuQaqCP7pdeLR4riPfEs\",\n \"Tx_verify_key\": \"6nHdu1Ygf8GZaS2DnFHqjjv5psVvJsPnQfeBV8A6Tqxk\",\n \"Tx_public_key\": \"CmLjRfsPrxARqQCUWshDxLosQudvfDBV4iSReHU8qQyr\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a rule selecting on a relationship removal.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule remove_node_entry_after_sub_removal {\n select when wrangler relationship_removed\n pre {\n\tsub_id = event:attr(\"Id\")\n }\n if (relationship{\"Rx_role\"}.klog(\"RX_ROLE: \") == \"node\") then\n noop()\n fired {\n ent:node_list := ent:node_list.delete([sub_id]);\n }\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"inbound_pending_relationship_added"},"legacyAnchorId":{"value":"RelationshipsAPI-inbound_pending_relationship_added"}},"macroMetadata":{"macroId":{"value":"23372368-1327-43bb-9186-629a7c5cbd49"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"inbound_pending_relationship_added","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:inbound_pending_relationship_added","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This event is raised within the pico when a new inbound relationship request has been sent to the pico, and the developer needs to approve it. Typical use is to use the event attributes to determine whether the relationship is one you are expecting, and then raising wrangler:pending_relationship_approval if they are. ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The relationship ID of the added relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The receiving channel that this pico will receive relationship events on","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role that this pico will take in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The channel to transmit events to on the other pico","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_host","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The network address of the pico engine hosting the other pico in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_public_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role of the other pico in the relationship relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_verify_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"channel_name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The name of the channel created for the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"channel_type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The type of the channel created for the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Also the name of the channel created for the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"public_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"verify_key","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"type":"hardBreak"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"wellKnown_Tx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The wellKnown of this pico","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The event attributes look like the following structure, depending on the arguments given to wrangler:relationship on the other pico:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"Id\": \"cjrmog0gd0030vkrqu0eeqax5\",\n \"Rx\": \"AQM7aFvb2Yp33pjypNcBhM\",\n \"Rx_role\": \"10\",\n \"Tx\": \"3naK2ZUH6a4vaWzLvU5cfn\",\n \"Tx_host\": \"http://10.37.184.244:8080\",\n \"Tx_public_key\": \"6G1fmv3KQd7hXpokesKFKrHE8dJJYpiew4eEAZwWbEKa\",\n \"Tx_role\": \"2\",\n \"Tx_verify_key\": \"2X4gcL8FGA4qrCniyBmYnfdKN5fitDu843mJtFFR5kBi\",\n \"_headers\": { // These were appended from the HTTP communication between the two picos\n \"content-type\": \"application/json\",\n \"host\": \"localhost:8080\",\n \"content-length\": \"981\",\n \"connection\": \"close\"\n },\n \"channel_name\": \"cool\",\n \"channel_type\": \"cool sub channel\",\n \"name\": \"cool\",\n \"password\": \"\",\n \"public_key\": \"6G1fmv3KQd7hXpokesKFKrHE8dJJYpiew4eEAZwWbEKa\",\n \"verify_key\": \"2X4gcL8FGA4qrCniyBmYnfdKN5fitDu843mJtFFR5kBi\",\n \"wellKnown_Tx\": \"5qMBoPpNh2fBnfG7JNk5yD\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a rule accepting new relationship requests by selecting on wrangler:inbound_pending_relationship_added:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule auto_accept {\n select when wrangler inbound_pending_relationship_added\n pre {\n }\n always {\n raise wrangler event \"pending_relationship_approval\"\n attributes event:attrs\n }\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"outbound_pending_relationship_added"},"legacyAnchorId":{"value":"RelationshipsAPI-outbound_pending_relationship_added"}},"macroMetadata":{"macroId":{"value":"06c52b26-97e3-4030-81ad-b826d93af377"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"outbound_pending_relationship_added","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:outbound_pending_relationship_added","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This is raised within the pico that has just initiated a relationship request using wrangler:relationship. This allows manipulation of the outgoing request, including cancelling it if necessary.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"paragraph","content":[{"text":"These are currently identical to the attributes passed to wrangler:relationship.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role that this pico will take in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_host","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The network address of the pico engine hosting the other pico in the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Tx_role","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The role of the other pico in the relationship relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"channel_type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The type of the channel created for the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"name","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The name of the channel created for the relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"wellKnown_Tx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The wellKnown of the pico the request is being sent to","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"The event attributes look like the following structure, depending on the arguments given to wrangler:relationship:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"Rx_role\": \"2\",\n \"Tx_host\": \"http://localhost:8080\",\n \"Tx_role\": \"10\",\n \"_headers\": { // These were appended from the HTTP communication between the two picos\n \"host\": \"localhost:8080\",\n \"connection\": \"keep-alive\",\n \"accept\": \"application/json, text/javascript, */*; q=0.01\",\n \"x-requested-with\": \"XMLHttpRequest\",\n \"user-agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.81 Safari/537.36\",\n \"referer\": \"http://localhost:8080/\",\n \"accept-encoding\": \"gzip, deflate, br\",\n \"accept-language\": \"en-US,en;q=0.9\",\n \"if-none-match\": \"W/\\\"11-cFrA0CClfKTQMohnyK0tNW5C4dU\\\"\"\n },\n \"channel_type\": \"cool sub channel\",\n \"name\": \"cool\",\n \"password\": \"\",\n \"wellKnown_Tx\": \"5qMBoPpNh2fBnfG7JNk5yD\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"An example of a rule selecting on wrangler:oubound_pending_relationship_added to prepare for the relationship.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule auto_accept {\n select when wrangler outbound_pending_relationship_added\n pre {\n\tother_pico_host = event:attr{\"Tx_host\"}\n }\n if other_pico_host then\n noop()\n fired {\n ent:attempted_hosts := ent:attempted_hosts.append(other_pico_host);\n }\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"outbound_relationship_cancelled"},"legacyAnchorId":{"value":"RelationshipsAPI-outbound_relationship_cancelled"}},"macroMetadata":{"macroId":{"value":"f128c6a8-fdbe-4599-8ce2-7deb3cf3a3e3"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"outbound_relationship_cancelled","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:outbound_relationship_cancelled","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Raised when an outbound relationship has been cancelled through the use of wrangler:outbound_cancellation or the inbound request rejected on the other pico using wrangler:inbound_rejection.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The Id that had been created for the possible relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx/Tx","type":"text","marks":[{"type":"em"},{"type":"textColor","attrs":{"color":"#ff9900"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Use the bus attribute to get information","type":"text","marks":[{"type":"underline"}]},{"text":". This attribute will change depending on how the relationship was cancelled. It will give a channel that was originally created for the relationship from either pico.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"bus","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Map","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The internals of the cancelled outbound request. See attached example for its values.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"An example of a rule selecting on wrangler:outbound_relationship_cancelled:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule sub_request_cancelled_or_rejected {\n select when wrangler outbound_relationship_cancelled\n always {\n ent:sub := event:attrs\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The structure of the bus when the oubound relationship has been cancelled:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"bus\": {\n \"Id\": \"cjs51fu2a006kksrq7av62ttd\", // the ID of the cancelled relationship request\n \"wellKnown_Tx\": \"5qMBoPpNh2fBnfG7JNk5yD\", // The well known of the other pico\n \"Rx\": \"AiPhhS6Tkz7QqmqbRZujEM\" // The receiving channel that no longer exists that was created for this pico for the relationship\n }\n}","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"inbound_relationship_cancelled"},"legacyAnchorId":{"value":"RelationshipsAPI-inbound_relationship_cancelled"}},"macroMetadata":{"macroId":{"value":"ac434893-ca1b-4693-b2e6-0ee3c50e11a6"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"inbound_relationship_cancelled","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"wrangler:inbound_relationship_cancelled","type":"text"}]},{"type":"paragraph","content":[{"text":"Raised when an inbound relationship has been cancelled through the use of wrangler:inbound_rejection or the outbound request was rejected on the other pico using wrangler:outbound_cancellation.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Attributes Added","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":2065.936},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Attribute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Datatype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The Id that had been created for the possible relationship","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Rx/Tx","type":"text","marks":[{"type":"em"},{"type":"textColor","attrs":{"color":"#ff9900"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Use the bus attribute to get information. This attribute will change depending on how the relationship was cancelled. It will give a channel that was originally created for the relationship from either pico.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.69]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"bus","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[270.94]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Map","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1526.31]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"The internals of the cancelled inbound request. The internals of the cancelled outbound request. See attached example for its values.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"An example of a rule selecting on wrangler:inbound_relationship_cancelled:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"rule inbound_sub_req_cancelled {\n select when wrangler inbound_relationship_cancelled\n always {\n ent:sub := event:attrs\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"The structure of the bus when the inbound relationship has been cancelled:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"{\n \"bus\": {\n \"Id\": \"cjs51fu2a006kksrq7av62ttd\", // the ID of the cancelled relationship request\n \"Tx\": \"AiPhhS6Tkz7QqmqbRZujEM\", // The transmitting channel that no longer exists that was created for the other pico for the relationship\n \"Rx\": \"8UVQvmstjx7C35D3sKHRy6\", // The receiving channel that no longer exists that was created for this pico for the relationship\n \"Tx_verify_key\": \"6J4uxarQkQGc43KZkUhmHwowPAc3Hb5oezLnyoJgvM5k\", // The signing key that had been created to allow signing of future relationship events\n \"Tx_public_key\": \"9xvw5iYsPjGirBofxAniXU8w1bZ4CfT6pfmcigZpzGkQ\" // The encryption key that had been created to allow encrypted communication of future relationship events\n }\n}_","type":"text"}]},{"type":"rule"}]}],"version":1}}}},{"type":"paragraph"},{"type":"paragraph"}],"version":1}

Relationships API

Notes