Table of Contents

Namespace Signal.Application.Abstractions

Classes

AccountSettings

Account privacy settings for UpdateSettingsAsync(PhoneNumber, AccountSettings, CancellationToken). null leaves a setting unchanged.

AttachmentDownload

An attachment opened for streaming by OpenReadAsync(string, CancellationToken).

GroupPermissions

The permissions of a group. The API requires all three to be set together.

GroupSettings

Group settings for UpdateSettingsAsync(PhoneNumber, GroupId, GroupSettings, CancellationToken). null leaves a setting unchanged.

LinkedDevice

A device linked to an account, from ListAsync(PhoneNumber, CancellationToken).

NumberRegistration

Whether a phone number is registered with Signal, from CheckRegisteredAsync(PhoneNumber, IEnumerable<PhoneNumber>, CancellationToken).

ProfileUpdate

New profile values for an account.

RegistrationOptions

How a verification code is requested when registering a number.

SignalApiException

The signal-cli-rest-api answered with a non-success status code.

SignalApiInfo

Information about the running signal-cli-rest-api, from GET /v1/about.

StickerPack

A sticker pack known to an account, from ListAsync(PhoneNumber, CancellationToken).

UsernameAssignment

The result of SetUsernameAsync(PhoneNumber, string, CancellationToken).

Structs

SendResult

Result of a successful send.

SignalCapability

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

Interfaces

IAccountService

Lists accounts and links new devices.

IAttachmentService

Accesses attachments stored by the container (/v1/attachments).

IContactService

Reads and updates the account's contacts (/v1/contacts/{number}).

IDeviceService

Manages the devices linked to an account that is registered in the container (/v1/devices/{number}), i.e. the container acts as the primary device. To link the container itself to another account, use GetLinkQrCodeAsync(string, CancellationToken) instead.

IGroupService

Manages groups (/v1/groups/{number}).

IIdentityService

Inspects and trusts identity keys (safety numbers).

IMessageReceiver

A source of incoming envelopes for one account. The transport depends on the ExecutionMode: HTTP polling for normal/native, a WebSocket for json-rpc/json-rpc-native.

IMessageReceiverFactory

Resolves the IMessageReceiver responsible for an ExecutionMode.

IMessageSender

Sends and deletes messages.

IProfileService

Updates the account's Signal profile.

IReactionService

Sends and removes emoji reactions.

IReceiptService

Sends read and viewed receipts.

IRegistrationService

Registers a phone number as the container's primary Signal device, as an alternative to linking the container to an existing account (GetLinkQrCodeAsync(string, CancellationToken)).

ISignalClient

Convenience facade over all Signal ports. Inject it when you need several of them; inject individual ports when you need only one (keeps dependencies explicit).

IStickerService

Lists and installs sticker packs (/v1/sticker-packs/{number}).

ISystemService

Container-level information and health.

ITypingIndicatorService

Shows and hides the "typing…" indicator.

Enums

GroupLinkMode

Whether and how people can join a group through its invite link.

GroupPermission

Who may perform an action in a group.