PollRequest Class
The body a SET Recipient posts to a transmitter's polling endpoint (RFC 8936 Section 2.2): what to return now, and what of the previous delivery is being acknowledged. The three request variations of Section 2.4 - poll-only, acknowledge-only, combined - are all spellings of this one object.
public record PollRequest : System.IEquatable<Abblix.SecurityEvents.Delivery.PollRequest>Inheritance System.Object → PollRequest
Implements System.IEquatable<PollRequest>
Remarks
Every member is optional and an absent member is omitted from the wire, not sent as null: the empty JSON object is the specification's own example of a valid default poll. Absence has meaning here - an omitted MaxEvents is "no limit", where a zero is "acknowledge only" - so the properties are nullable rather than defaulted.
Properties
PollRequest.Acknowledged Property
The "jti" values of SETs received successfully, whose acknowledgement releases the transmitter from retaining them (RFC 8936 Section 2.2).
public System.Collections.Generic.IReadOnlyList<string>? Acknowledged { get; init; }Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PollRequest.Errors Property
The invalid SETs of the previous delivery, keyed by "jti", each with the error that condemned it (RFC 8936 Section 2.2).
public System.Collections.Generic.IReadOnlyDictionary<string,Abblix.SecurityEvents.Delivery.DeliveryError>? Errors { get; init; }Property Value
System.Collections.Generic.IReadOnlyDictionary<System.String,DeliveryError>
PollRequest.MaxEvents Property
The most unacknowledged SETs the transmitter should return. Zero makes the request acknowledge-only; absent places no limit (RFC 8936 Section 2.2).
public System.Nullable<int> MaxEvents { get; init; }Property Value
PollRequest.ReturnImmediately Property
True asks for an immediate response even when no SETs are available - short polling. Absent or false makes the request a long poll (RFC 8936 Section 2.2).
public System.Nullable<bool> ReturnImmediately { get; init; }