PluginServiceResult<T>14.1
Class in Unbroken.LaunchBox.Plugins.Services
public sealed class PluginServiceResult<T> where T : classContains the outcome and optional data of a host-managed provider query. Data collections returned by the host are read-only.
- Type parameter
T - The requested data type.
Constructors
PluginServiceResult<T>
public PluginServiceResult()A summary has not been written for this member.
Properties
IsStaleGets or initializes whether Value contains a retained cached observation because current retrieval or provider availability could not be confirmed.MessageGets or initializes a host-localized explanation, if available.ObservedAtGets or initializes when the returned observation was saved, when the service retains it in a cache.StatusGets or initializes the outcome; inspect this before treating absent data as an empty result.ValueGets or initializes the returned data, or null when unavailable.
IsStale
public bool IsStale { get; init; }Gets or initializes whether Value contains a retained cached observation because current retrieval or provider availability could not be confirmed.
Remarks
False when Value is null, when data comes from the current query, or when a cached observation is accepted by the service's freshness policy. Current partial results can therefore be false even with Incomplete or Failed status. False does not establish success or a fresh network fetch; inspect Status, Value, and ObservedAt independently.Message
public string? Message { get; init; }Gets or initializes a host-localized explanation, if available.
ObservedAt
public DateTimeOffset? ObservedAt { get; init; }Gets or initializes when the returned observation was saved, when the service retains it in a cache.
Remarks
Retained fallback data keeps its original timestamp. Null means no cache observation timestamp is supplied; it does not establish retrieval success or failure.Status
public required PluginServiceStatus Status { get; init; }Gets or initializes the outcome; inspect this before treating absent data as an empty result.
Value
public T? Value { get; init; }Gets or initializes the returned data, or null when unavailable.