Skip to content

API Reference

This documentation was automatically generated from XML documentation comments.

Namespaces

Signal.Bot.Args

View Namespace →

  • OnApiRequestArgs - Provides event data for API request events, containing the request details before it is sent to the Signal Bot API.
  • OnApiResponseArgs - Provides event data for API response events, containing the request details and the corresponding HTTP response.

Signal.Bot

View Namespace →

  • 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.
  • 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.

... and 16 more

Signal.Bot.Exceptions

View Namespace →

  • RequestException - Represents errors that occur during Signal Bot API requests, optionally including HTTP status code information.

Signal.Bot.Requests

View Namespace →

... and 55 more

Signal.Bot.Serialization

View Namespace →

  • JsonBotAPI - Provides centralized JSON serialization configuration for the Signal Bot API client with source-generated serialization support.
  • JsonBotSerializerContext - Provides source-generated JSON serialization context for the Signal Bot API with optimized performance and AOT compatibility.

Signal.Bot.Types

View Namespace →

  • About - Represents information about the Signal Bot API server including version, build, and capabilities.
  • Acknowledged - Represents an acknowledgment response from the Signal Bot API, indicating that an operation was successfully received and processed.
  • Attachment - Represents a file attachment in a Signal message.
  • Configuration - Represents the configuration settings for the Signal Bot API.
  • Contact - Represents a Signal contact with profile information and settings.

... and 25 more