Signal.Bot

Appearance

Signal.Bot Namespace ​

Types ​

Base64Attachment ​

Represents a base64-encoded attachment with support for various input formats including raw base64, bytes, files, and data URIs.

Base64String ​

Represents a validated base64-encoded string with conversion utilities for byte arrays.

ConnectionError ​

Represents a connection-related event during WebSocket lifecycle that is reported as an error for handling purposes. This is not an actual error condition, but rather a notification mechanism for connection state changes such as initial connection or reconnection events.

ConnectionEvent ​

Defines the types of connection events that can occur during WebSocket communication.

CreateGroupBuilder ​

Provides a fluent interface for building and configuring CreateGroupRequest objects to create new Signal groups.

DisconnectionError ​

Represents a disconnection event that occurred during WebSocket communication. Contains information about the disconnection type, close status, reason, and provides methods to control automatic reconnection and graceful closing behavior.

DisconnectionEvent ​

Defines the different types of disconnection events that can occur during WebSocket communication.

Error ​

Represents an error or event that occurs during Signal Bot operations, with an optional exception and categorized error type. This serves as the base record for specific error types like ConnectionError and DisconnectionError.

Extensions ​

Provides extension methods for ISignalBotClient to simplify common Signal Bot API operations.

PollingExtensions ​

Provides extension methods for ISignalBotClient to enable message polling and receiving functionality. These methods allow starting message receivers in various modes including fire-and-forget background tasks and controlled lifecycle management with disposable handles.

FailureSource ​

Defines the types of errors that can occur during message polling and WebSocket communication.

Possible values:

  • Undefined - Undefined or unknown error type.
  • MessageReceived - Error occurred while processing a received message.
  • MessageReceiveTerminated - Message receiving was terminated due to an error.
  • DisconnectionHappened - A disconnection event occurred.
  • DisconnectionHappenTerminated - Disconnection handling was terminated due to an error.
  • ConnectionHappened - A connection event occurred.
  • ConnectionHappenTerminated - Connection handling was terminated due to an error.
  • Failed - A general failure occurred.

IQueryParameterRegistry ​

Defines a registry for managing query parameters in HTTP requests, supporting single values and collections.

IReceivedMessageHandler ​

Defines the contract for handling incoming Signal messages and errors during polling operations.

ISignalBotClient ​

Defines the core interface for interacting with the Signal Bot API, providing methods for sending requests and observing API interactions.

ReceiverOptionsBuilder ​

Provides a fluent interface for constructing ReceiverOptions with configurable polling behavior.

ReceiverOptions ​

Represents the configuration options for the Signal message receiver during polling operations.

SendMessageRequestBuilder ​

Provides a fluent interface for constructing SendMessageRequest objects with various message properties and configurations.

SignalBotClient ​

Defines the core interface for interacting with the Signal Bot API, providing methods for sending requests and observing API interactions.

SignalBotClientOptions ​

Represents the configuration options for a SignalBotClient instance.

SignalBotClientOptionsBuilder ​

Provides a fluent interface for constructing SignalBotClientOptions with validation.

UpdateGroupBuilder ​

Provides a fluent interface for building and configuring UpdateGroupRequest objects to update Signal group settings.