Skip to content

CreateStreamRequest Class

The body of a receiver's request to create an Event Stream: exactly the receiver-supplied members of the stream configuration, every one optional (SSF 1.0 Section 8.1.1.1). An empty body is well-formed - a transmitter reads a missing delivery as poll, and one that supports poll delivery answers with its own endpoint URL; one that does not may answer 400, so a caller should consult the advertised "delivery_methods_supported" first.

C#
public sealed record CreateStreamRequest : System.IEquatable<Abblix.SharedSignals.Model.CreateStreamRequest>

Inheritance System.Object → CreateStreamRequest

Implements System.IEquatable<CreateStreamRequest>

Properties

CreateStreamRequest.Delivery Property

OPTIONAL. The delivery method the receiver proposes. Absent means poll: the transmitter assumes "urn:ietf:rfc

", and one that supports poll answers with a delivery object carrying its own endpoint URL - while one that does not support the method may answer 400 (SSF 1.0 Section 8.1.1.1).

C#
public Abblix.SharedSignals.Model.Delivery.StreamDeliveryMethod? Delivery { get; init; }

Property Value

StreamDeliveryMethod

CreateStreamRequest.Description Property

OPTIONAL. A human-readable description of the stream (SSF 1.0 Section 8.1.1).

C#
public string? Description { get; init; }

Property Value

System.String

CreateStreamRequest.EventsRequested Property

OPTIONAL. The event types the receiver asks for - only ones it understands and can act on; the transmitter ignores values it does not understand (SSF 1.0 Section 8.1.1).

C#
public System.Collections.Generic.IReadOnlyList<string>? EventsRequested { get; init; }

Property Value

System.Collections.Generic.IReadOnlyList<System.String>