IDIDComm.unpackDIDCommMessage() method

This API is provided as a 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>): Promise<IUnpackedDIDCommMessage>;

Parameters

ParameterTypeDescription
argsIUnpackDIDCommMessageArgsan object containing the serialized message to be unpacked
contextIAgentContext <IDIDManager & IKeyManager & IResolver>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.