Table of Contents

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

Version string

The API version, e.g. 0.92.

Build int

The build number.

RawMode string

The container mode as reported, e.g. json-rpc.

ApiVersions IReadOnlyList<string>

Supported API versions, e.g. v1, v2.

Capabilities IReadOnlyDictionary<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

IReadOnlyList<string>

Build

The build number.

public int Build { get; init; }

Property Value

int

Capabilities

Supported features per endpoint, e.g. v2/send → quotes, mentions.

public IReadOnlyDictionary<string, IReadOnlyList<string>> Capabilities { get; init; }

Property Value

IReadOnlyDictionary<string, IReadOnlyList<string>>

Mode

RawMode as ExecutionMode, or null if unknown.

public ExecutionMode? Mode { get; }

Property Value

ExecutionMode?

RawMode

The container mode as reported, e.g. json-rpc.

public string? RawMode { get; init; }

Property Value

string

Version

The API version, e.g. 0.92.

public string? Version { get; init; }

Property Value

string

Methods

EnsureSupported(SignalCapability)

Throws a descriptive exception unless the API reports capability.

public void EnsureSupported(SignalCapability capability)

Parameters

capability SignalCapability

The required capability.

Exceptions

NotSupportedException

The capability is not reported, typically because the container is outdated.

ArgumentException

capability is default.

Supports(SignalCapability)

Whether the API reports capability in Capabilities.

public bool Supports(SignalCapability capability)

Parameters

capability SignalCapability

The capability, e.g. SendMentions.

Returns

bool

true if the feature is listed for the endpoint (case-insensitive).

Exceptions

ArgumentException

capability is default.