Skip to content

Commit fe3063d

Browse files
Merge branch 'main' into feat/remove-voucher
2 parents 8144854 + 6802cbf commit fe3063d

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

src/references/dataProtector/methods/processProtectedData.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -367,18 +367,26 @@ const processProtectedDataResponse = await dataProtectorCore.processProtectedDat
367367
You can expect this callback function to be called with the following titles:
368368

369369
```ts
370-
'FETCH_PROTECTED_DATA_ORDERBOOK';
371-
'FETCH_APP_ORDERBOOK';
372-
'FETCH_WORKERPOOL_ORDERBOOK';
370+
'FETCH_ORDERS';
373371
'PUSH_REQUESTER_SECRET';
372+
'GENERATE_ENCRYPTION_KEY';
373+
'PUSH_ENCRYPTION_KEY';
374374
'REQUEST_TO_PROCESS_PROTECTED_DATA';
375+
'TASK_EXECUTION';
375376
'CONSUME_TASK';
376377
'CONSUME_RESULT_DOWNLOAD';
377378
'CONSUME_RESULT_DECRYPT';
378379
```
379380

380381
Once with `isDone: false`, and then with `isDone: true`
381382

383+
::: info
384+
385+
The `'GENERATE_ENCRYPTION_KEY'` and `'PUSH_ENCRYPTION_KEY'` status titles are
386+
only triggered when `encryptResult` is set to `true`.
387+
388+
:::
389+
382390
## Return Value
383391

384392
```ts twoslash
@@ -437,6 +445,27 @@ processed during the task.
437445

438446
:::
439447

448+
### pemPrivateKey
449+
450+
`string`
451+
452+
The PEM-formatted RSA private key used to decrypt the encrypted computation
453+
result. This property is only present in the response when `encryptResult` is
454+
set to `true`.
455+
456+
If you provided a `pemPrivateKey` in the parameters, the same key will be
457+
returned. If you didn't provide one but enabled `encryptResult`, a newly
458+
generated private key will be returned, which you must securely store to decrypt
459+
the result.
460+
461+
::: tip
462+
463+
You can use this `pemPrivateKey` with the
464+
[getResultFromCompletedTask()](/references/dataProtector/methods/getResultFromCompletedTask)
465+
method to decrypt and retrieve the result of a completed task.
466+
467+
:::
468+
440469
<script setup>
441470
import { computed } from 'vue';
442471
import RequiredBadge from '@/components/RequiredBadge.vue'

0 commit comments

Comments
 (0)