aries / net.globalid.aries.features.notification / AckMessage

AckMessage

abstract class AckMessage : AgentMessage

This message is an explicit acknowledgment for a message referenced by ~thread.thid (this message must have a thread decorator with a thread ID). AckMessage is adopted by other protocols, so the implementations must specify the correct type so that the correct message processor receives the message.

Constructors

<init>

This message is an explicit acknowledgment for a message referenced by ~thread.thid (this message must have a thread decorator with a thread ID). AckMessage is adopted by other protocols, so the implementations must specify the correct type so that the correct message processor receives the message.

AckMessage(type: String)

Properties

status

is one of "OK" (a positive outcome), "FAIL" (a negative outcome) and "PENDING" (no outcome is yet known).

abstract val status: String

Extension Functions

addThread

Adds the thread decorator with threadId to the current message

fun AgentMessage.addThread(threadId: String): Unit

getThreadId

Returns the message thread id

fun AgentMessage.getThreadId(): String

toOutboundContext

Returns an OutboundMessageContext constructed from an AgentMessage and a given ConnectionRecord. This only puts the connection ID in the context.

fun AgentMessage.toOutboundContext(connection: ConnectionRecord): Single<OutboundMessageContext>

Returns an OutboundMessageContext constructed from an AgentMessage and a given ConnectionContext. The connection context from the record is checked and the corresponding outbound context is constructed.

fun AgentMessage.toOutboundContext(connectionContext: ConnectionContext): Single<OutboundMessageContext>

toOutboundMessage

Returns an OutboundMessage constructed from an AgentMessage and a given ConnectionRecord. The outbound message might not be constructable, based on the state of the record. In that case, an error is returned.

fun AgentMessage.toOutboundMessage(record: ConnectionRecord): Single<OutboundMessage>

Returns an OutboundMessage constructed from an AgentMessage and a given ServiceDecorator. In this case, the message can always be constructed as the decorator contains all the needed data. We generate a new key pair for this message so that the receiver can send a response (it needs to be encrypted with our public/verification key).

fun AgentMessage.toOutboundMessage(agent: Agent, serviceDecorator: ServiceDecorator): Single<OutboundMessage>

Inheritors

CredentialAckMessage

AckMessage implementation for credential protocol.

data class CredentialAckMessage : AckMessage

PresentationAckMessage

AckMessage implementation for present proof protocol.

data class PresentationAckMessage : AckMessage