DIDComm.unpackDIDCommMessage() method
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Unpacks a possible DIDComm message and returns the IDIDCommMessage and DIDCommMessagePacking used to pack it.
Signature:
unpackDIDCommMessage(args: IUnpackDIDCommMessageArgs, context: IAgentContext<IDIDManager & IKeyManager & IResolver & IMessageHandler>): Promise<IUnpackedDIDCommMessage>;
Parameters
Parameter | Type | Description |
---|---|---|
args | IUnpackDIDCommMessageArgs | an object containing the serialized message to be unpacked |
context | IAgentContext<IDIDManager & IKeyManager & IResolver & IMessageHandler> | This method requires an agent that also has IDIDManager, IKeyManager and IResolver plugins in use. When calling this method, the context is supplied automatically by the framework. |
Returns:
Promise<IUnpackedDIDCommMessage>
- a Promise that resolves to an object containing the IDIDCommMessage and DIDCommMessagePacking used.
This API may change without a BREAKING CHANGE notice.