Class AcknowledgmentResponse

Namespace

AsiBackbone.Core.Acknowledgments

Assembly

AsiBackbone.Core.dll

Represents a framework-neutral acknowledgment response for a liability or responsibility handshake.

public sealed class AcknowledgmentResponse

Inheritance

object

AcknowledgmentResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Acknowledged

Gets a value indicating whether the required acknowledgment was accepted.

public bool Acknowledged { get; }

Property Value

bool

AcknowledgmentCode

Gets the acknowledgment code accepted or rejected by the actor.

public string AcknowledgmentCode { get; }

Property Value

string

AcknowledgmentId

Gets the stable acknowledgment identifier.

public string AcknowledgmentId { get; }

Property Value

string

ActorDisplayName

Gets the optional display name or label associated with the actor.

public string? ActorDisplayName { get; }

Property Value

string

ActorId

Gets the stable actor identifier associated with the acknowledgment.

public string ActorId { get; }

Property Value

string

ActorType

Gets the actor type associated with the acknowledgment.

public GovernanceActorType ActorType { get; }

Property Value

GovernanceActorType

CorrelationId

Gets the correlation identifier associated with the acknowledgment, when supplied by the host.

public string? CorrelationId { get; }

Property Value

string

HandshakeId

Gets the handshake identifier associated with the acknowledgment.

public string HandshakeId { get; }

Property Value

string

HasMetadata

Gets a value indicating whether this acknowledgment contains metadata.

public bool HasMetadata { get; }

Property Value

bool

Metadata

Gets additional framework-neutral acknowledgment metadata supplied by the host.

public IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

OccurredUtc

Gets the UTC timestamp when the acknowledgment response occurred.

public DateTimeOffset OccurredUtc { get; }

Property Value

DateTimeOffset

Rejected

Gets a value indicating whether the required acknowledgment was rejected.

public bool Rejected { get; }

Property Value

bool

SchemaVersion

Gets the schema version for the serialized handshake acknowledgment shape.

public string SchemaVersion { get; }

Property Value

string

TraceId

Gets the trace identifier associated with the acknowledgment, when supplied by the host.

public string? TraceId { get; }

Property Value

string

Methods

Accept(AcknowledgmentRequest, IGovernanceActorContext, string?, DateTimeOffset?, IReadOnlyDictionary<string, string>?, string?)

Creates an accepted acknowledgment response for a liability or responsibility handshake.

public static AcknowledgmentResponse Accept(AcknowledgmentRequest request, IGovernanceActorContext actor, string? acknowledgmentId = null, DateTimeOffset? occurredUtc = null, IReadOnlyDictionary<string, string>? metadata = null, string? schemaVersion = null)

Parameters

request AcknowledgmentRequest

The handshake request being acknowledged.

actor IGovernanceActorContext

The actor accepting the handshake.

acknowledgmentId string

Optional acknowledgment identifier. When omitted, a new identifier is generated.

occurredUtc DateTimeOffset?

Optional response timestamp. When omitted, the current UTC timestamp is used.

metadata IReadOnlyDictionary<string, string>

Optional host-provided metadata.

schemaVersion string

Optional schema version for serialized or persisted acknowledgment records.

Returns

AcknowledgmentResponse

An accepted acknowledgment acknowledgment response.

Create(AcknowledgmentRequest, IGovernanceActorContext, bool, string?, DateTimeOffset?, IReadOnlyDictionary<string, string>?, string?)

Creates an acknowledgment response for a liability or responsibility handshake.

public static AcknowledgmentResponse Create(AcknowledgmentRequest request, IGovernanceActorContext actor, bool acknowledged, string? acknowledgmentId = null, DateTimeOffset? occurredUtc = null, IReadOnlyDictionary<string, string>? metadata = null, string? schemaVersion = null)

Parameters

request AcknowledgmentRequest

The handshake request being acknowledged.

actor IGovernanceActorContext

The actor responding to the handshake.

acknowledged bool

Whether the actor accepted the required acknowledgment.

acknowledgmentId string

Optional acknowledgment identifier. When omitted, a new identifier is generated.

occurredUtc DateTimeOffset?

Optional response timestamp. When omitted, the current UTC timestamp is used.

metadata IReadOnlyDictionary<string, string>

Optional host-provided metadata.

schemaVersion string

Optional schema version for serialized or persisted acknowledgment records.

Returns

AcknowledgmentResponse

A acknowledgment acknowledgment response.

Reject(AcknowledgmentRequest, IGovernanceActorContext, string?, DateTimeOffset?, IReadOnlyDictionary<string, string>?, string?)

Creates a rejected acknowledgment response for a liability or responsibility handshake.

public static AcknowledgmentResponse Reject(AcknowledgmentRequest request, IGovernanceActorContext actor, string? acknowledgmentId = null, DateTimeOffset? occurredUtc = null, IReadOnlyDictionary<string, string>? metadata = null, string? schemaVersion = null)

Parameters

request AcknowledgmentRequest

The handshake request being rejected.

actor IGovernanceActorContext

The actor rejecting the handshake.

acknowledgmentId string

Optional acknowledgment identifier. When omitted, a new identifier is generated.

occurredUtc DateTimeOffset?

Optional response timestamp. When omitted, the current UTC timestamp is used.

metadata IReadOnlyDictionary<string, string>

Optional host-provided metadata.

schemaVersion string

Optional schema version for serialized or persisted acknowledgment records.

Returns

AcknowledgmentResponse

A rejected acknowledgment acknowledgment response.