Class SignalOptions
- Namespace
- Signal.Application.Configuration
- Assembly
- Signal.Application.dll
Root options of Signal.NET, bound from the Signal section of appsettings.json
and validated on startup by SignalOptionsValidator.
public sealed class SignalOptions
- Inheritance
-
SignalOptions
- Inherited Members
Remarks
Settings read through IOptionsMonitor (commands, access control, rate limit, receive options)
apply without a restart when the configuration file changes. Connection-level settings (base URL, mode,
accounts, HTTP resilience, concurrency) are read once at startup.
Fields
SectionName
The configuration section name: Signal.
public const string SectionName = "Signal"
Field Value
Properties
AccessControl
Sender allow/block lists.
public AccessControlOptions AccessControl { get; set; }
Property Value
Accounts
Registered accounts (E.164 phone numbers) to receive messages for. At least one is required.
public List<string> Accounts { get; set; }
Property Value
Background
Background work queued by commands and handlers (IBackgroundWorkQueue).
public BackgroundOptions Background { get; set; }
Property Value
BaseUrl
Base URL of the signal-cli-rest-api container. Default http://localhost:8080/.
public Uri BaseUrl { get; set; }
Property Value
Commands
Command system settings.
public CommandOptions Commands { get; set; }
Property Value
FailOnModeMismatch
Stop the host when the verified mode differs from Mode; otherwise only a warning is logged.
public bool FailOnModeMismatch { get; set; }
Property Value
Http
HTTP client timeout and retry settings.
public HttpOptions Http { get; set; }
Property Value
Localization
Languages of the texts the framework sends (errors, help, prompts).
public LocalizationOptions Localization { get; set; }
Property Value
MaxConcurrency
Number of conversations processed in parallel. Messages of the same conversation are always processed in order. Default 4.
public int MaxConcurrency { get; set; }
Property Value
Mode
Must match the container's MODE. Decides between HTTP polling (Normal,
Native) and WebSocket receiving (JsonRpc,
JsonRpcNative). Default Normal.
public ExecutionMode Mode { get; set; }
Property Value
RateLimit
Per-sender rate limiting.
public RateLimitOptions RateLimit { get; set; }
Property Value
Receive
HTTP polling settings (normal/native modes).
public ReceiveOptions Receive { get; set; }
Property Value
Scheduler
Scheduled messages (IMessageScheduler).
public SchedulerOptions Scheduler { get; set; }
Property Value
VerifyModeOnStartup
public bool VerifyModeOnStartup { get; set; }
Property Value
WebSocket
WebSocket settings (json-rpc/json-rpc-native modes).
public WebSocketOptions WebSocket { get; set; }