Class SignalApiInfo
- Namespace
- Signal.Application.Abstractions
- Assembly
- Signal.Application.dll
Information about the running signal-cli-rest-api, from GET /v1/about.
public sealed record SignalApiInfo : IEquatable<SignalApiInfo>
- Inheritance
-
SignalApiInfo
- Implements
- Inherited Members
Constructors
SignalApiInfo(string?, int, string?, IReadOnlyList<string>, IReadOnlyDictionary<string, IReadOnlyList<string>>)
Information about the running signal-cli-rest-api, from GET /v1/about.
public SignalApiInfo(string? Version, int Build, string? RawMode, IReadOnlyList<string> ApiVersions, IReadOnlyDictionary<string, IReadOnlyList<string>> Capabilities)
Parameters
VersionstringThe API version, e.g.
0.92.BuildintThe build number.
RawModestringThe container mode as reported, e.g.
json-rpc.ApiVersionsIReadOnlyList<string>Supported API versions, e.g.
v1,v2.CapabilitiesIReadOnlyDictionary<string, IReadOnlyList<string>>Supported features per endpoint, e.g.
v2/send→quotes,mentions.
Properties
ApiVersions
Supported API versions, e.g. v1, v2.
public IReadOnlyList<string> ApiVersions { get; init; }
Property Value
Build
The build number.
public int Build { get; init; }
Property Value
Capabilities
Supported features per endpoint, e.g. v2/send → quotes, mentions.
public IReadOnlyDictionary<string, IReadOnlyList<string>> Capabilities { get; init; }
Property Value
Mode
RawMode as ExecutionMode, or null if unknown.
public ExecutionMode? Mode { get; }
Property Value
RawMode
The container mode as reported, e.g. json-rpc.
public string? RawMode { get; init; }
Property Value
Version
The API version, e.g. 0.92.
public string? Version { get; init; }
Property Value
Methods
EnsureSupported(SignalCapability)
Throws a descriptive exception unless the API reports capability.
public void EnsureSupported(SignalCapability capability)
Parameters
capabilitySignalCapabilityThe required capability.
Exceptions
- NotSupportedException
The capability is not reported, typically because the container is outdated.
- ArgumentException
capabilityis default.
Supports(SignalCapability)
Whether the API reports capability in Capabilities.
public bool Supports(SignalCapability capability)
Parameters
capabilitySignalCapabilityThe capability, e.g. SendMentions.
Returns
Exceptions
- ArgumentException
capabilityis default.