CreateOOBPresentationRequest
@hyperledger/identus-sdk v8.1.3
@hyperledger/identus-sdk / plugins/internal/didcomm / CreateOOBPresentationRequest
Class: CreateOOBPresentationRequest
Defined in: packages/lib/sdk/src/plugins/internal/didcomm/tasks/CreateOOBPresentationRequest.ts:34
Task class for creating out-of-band (OOB) presentation request invitations.
This class generates a base64-encoded JSON string representing an OOB invitation that includes a presentation request attachment. The invitation can be shared with potential credential holders to initiate the presentation verification flow.
Extends
Task<string,CreateOOBPresentationRequestArgs>
Constructors
Constructor
new CreateOOBPresentationRequest(...
args: [CreateOOBPresentationRequestArgs]):CreateOOBPresentationRequest
Defined in: packages/lib/sdk/src/utils/tasks.ts:18
Parameters
| Parameter | Type | Description |
|---|---|---|
...args | [CreateOOBPresentationRequestArgs] | - |
Returns
CreateOOBPresentationRequest
Inherited from
Task<string, Args>.constructor
Accessors
attachments
Get Signature
get attachments():
AttachmentDescriptor[]
Defined in: packages/lib/sdk/src/plugins/internal/didcomm/tasks/CreateOOBPresentationRequest.ts:53
Gets the attachments for the out-of-band invitation.
Returns
Array containing the presentation request as an attachment descriptor
oobBody
Get Signature
get oobBody(): {
accept:string[];goal:string;goal_code:string; }
Defined in: packages/lib/sdk/src/plugins/internal/didcomm/tasks/CreateOOBPresentationRequest.ts:40
Gets the body configuration for the out-of-band invitation.
Returns
{ accept: string[]; goal: string; goal_code: string; }
The OOB invitation body with goal code, goal description, and accepted protocols
Methods
log()
log():
unknown
Defined in: packages/lib/sdk/src/utils/tasks.ts:27
Returns
unknown
Inherited from
Task.log
run()
run(
_ctx:AgentContext):Promise<string>
Defined in: packages/lib/sdk/src/plugins/internal/didcomm/tasks/CreateOOBPresentationRequest.ts:74
Executes the task to create an out-of-band presentation request invitation.
This method validates the provided presentation request, generates a unique invitation ID, creates the OOB invitation structure, and returns it as a base64-encoded string.
Parameters
| Parameter | Type | Description |
|---|---|---|
_ctx | AgentContext | The agent context (not used in current implementation) |
Returns
Promise<string>
A Promise that resolves to a base64-encoded OOB invitation string
Throws
When the provided presentation request is invalid or not an instance of RequestPresentation
Overrides
Task.run