aries / net.globalid.aries.features.trustping.models.message / TrustPingMessage

TrustPingMessage

@JsonClass(true) data class TrustPingMessage : AgentMessage

The trust ping message is used as the first message in the trust ping protocol.

Constructors

<init>

The trust ping message is used as the first message in the trust ping protocol.

TrustPingMessage(comment: String?, responseRequested: Boolean?)

Properties

comment

is an optional comment for the receiver.

val comment: String?

responseRequested

if false, a response MUST NOT be sent.

val responseRequested: Boolean?

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>