on master help sign in
plea
3472a49syzygyzer
reference/vane-apis/jael.md+19−8
@@ -131,7 +131,7 @@ A `$source` is `(each ship term)`.
131
131
132### `%meet`
132### `%meet`
133
133
134−This `task` is a placeholder that currently does nothing.
134+This `task` is deprecated and does not perform any actions.
135
135
136#### Accepts
136#### Accepts
137
137
@@ -157,34 +157,45 @@ This `task` returns no `gift`s.
157
157
158### `%nuke`
158### `%nuke`
159
159
160−This `task` cancels all trackers from a given set of ships.
160+This `task` cancels subscriptions to Jael's state from a given set of `ship`s.
161+This `task` works differently depending on whether the `task` originated locally
162+or remotely.
161
163
162#### Accepts
164#### Accepts
163
165
164```hoon
166```hoon
165[whos=(set ship)]
167[whos=(set ship)]
166```
168```
167−`whos` is the `set` of `ship`s for which trackers are to be canceled.
169+`whos` is the `set` of `ship`s from which subscriptions are to be canceled.
168
170
169#### Returns
171#### Returns
170
172
171−```hoon
173+This `task` returns no `gift`s.
172−[%done ~]
173−```
174−
175−After a `%nuke` `task`, Jael `%give`s a `%done` `gift` in response. This is an acknowledgement that the task was completed successfully.
176
174
177
175
178### `%plea`
176### `%plea`
179
177
178+This `task` is `%pass`ed to Jael from Ames. `%plea`s are wrappers for `task`s
179+that (typically? always?) originate from a remote source, as the `%plea` pattern
180+is used to extend the `%pass`/`%give` semantics over the Ames network.
181+
182+Jael accepts two kinds of `%plea`s: [`%nuke`](#nuke) and
183+[`%public-keys`](#public-keys) and will crash if passed anything else. See the relevant entries to learn how Jael
184+responds to these.
185+
180#### Accepts
186#### Accepts
181
187
182```hoon
188```hoon
183[=ship =plea:ames]
189[=ship =plea:ames]
184```
190```
191+`ship` is the origin of the plea, and `plea:ames` is `[vane=@tas =path
192+payload=*]`. Here, `vane=%j`, `path` is the internal route on the receiving ship, and `payload` is either a `%nuke` or
193+a `%public-keys` `task`.
185
194
186#### Returns
195#### Returns
187
196
197+Jael `%give`s a `%done` `gift` in response to a `%plea` `task`.
198+
188
199
189### `%private-keys`
200### `%private-keys`
190
201