SsfStreamStatus
: string
in package
A stream's SSF status (SSF 1.0 §8.1.2), with AXIAM's meaning pinned by D-51.
An open enum. A value this SDK's copy of the spec does not list decodes to
self::Unknown rather than failing the response it arrived in (CONTRACT.md §27.11 rule 1).
Its own wire spelling is the empty string, which no server value is, so carrying an
unrecognised value back into an update is refused by the server rather than written as a
spelling it never used. A match over these cases needs an Unknown arm.
Table of Contents
Cases
- Disabled = 'disabled'
- The wire value `disabled`.
- Enabled = 'enabled'
- The wire value `enabled`.
- Paused = 'paused'
- The wire value `paused`.
- Unknown = ''
- A value this SDK's copy of the spec does not list; see the type's summary.
Methods
- fromWire() : self
- Parses a wire value into a SsfStreamStatus, mapping an unrecognised one to {@see self::Unknown}.
- toWire() : string
- The wire spelling of this case, for a request body.
Cases
Enabled
The wire value `enabled`.
Paused
The wire value `paused`.
Disabled
The wire value `disabled`.
Unknown
A value this SDK's copy of the spec does not list; see the type's summary.
Methods
fromWire()
Parses a wire value into a SsfStreamStatus, mapping an unrecognised one to {@see self::Unknown}.
public
static fromWire(string $value) : self
Never throws. A parse error here would fail the whole response the value arrived in, so
one unrecognised field of one record would take down the page it was on (§27.11 rule 1).
A match over this enum needs an Unknown arm.
Parameters
- $value : string
Return values
selftoWire()
The wire spelling of this case, for a request body.
public
toWire() : string
self::Unknown has none: it stands for a value this SDK never saw, and sending it
back as the empty string would leave the refusal to the server. It raises a ValidationError here instead, before any request is made
(CONTRACT.md §34.2 P12.2(a)). Use ->value to render for a log line.