Table of Contents

Struct SignalCapability

Namespace
Signal.Application.Abstractions
Assembly
Signal.Application.dll

An optional feature of an API endpoint, as listed in Capabilities. Check it with Supports(SignalCapability) or EnsureSupported(SignalCapability).

public readonly record struct SignalCapability : IEquatable<SignalCapability>
Implements
Inherited Members

Remarks

signal-cli-rest-api currently reports only SendQuotes and SendMentions. Create other values with the constructor if a newer version reports more.

Constructors

SignalCapability(string, string)

An optional feature of an API endpoint, as listed in Capabilities. Check it with Supports(SignalCapability) or EnsureSupported(SignalCapability).

public SignalCapability(string Endpoint, string Feature)

Parameters

Endpoint string

The endpoint, e.g. v2/send.

Feature string

The feature, e.g. mentions.

Remarks

signal-cli-rest-api currently reports only SendQuotes and SendMentions. Create other values with the constructor if a newer version reports more.

Properties

Endpoint

The endpoint, e.g. v2/send.

public string Endpoint { get; init; }

Property Value

string

Feature

The feature, e.g. mentions.

public string Feature { get; init; }

Property Value

string

SendMentions

Mentions in messages sent with v2/send.

public static SignalCapability SendMentions { get; }

Property Value

SignalCapability

SendQuotes

Quoting (replying to) messages with v2/send.

public static SignalCapability SendQuotes { get; }

Property Value

SignalCapability

Methods

ToString()

Returns endpoint:feature.

public override string ToString()

Returns

string

The capability as text.