Class SignalRApiClientBase

Base class for API clients that support SignalR hub connections.

Inheritance

object

ApiClientBase

SignalRApiClientBase

Inherited Members

ApiClientBase.DefaultUserIdPreconditionQueryName

ApiClientBase.DefaultSessionCookieName

ApiClientBase.SerializerOptions

ApiClientBase.SessionCookieName

ApiClientBase.UserAgent

ApiClientBase.IsPersistentSession

ApiClientBase.SessionToken

ApiClientBase.CreateRequest(HttpMethod, string, params ReadOnlySpan<(string Name, object Value)>)

ApiClientBase.GetBaseAddress()

ApiClientBase.GetDefaultQueryParams(string)

ApiClientBase.SendAsync(HttpRequestMessage, CancellationToken)

ApiClientBase.SendAsync(HttpRequestMessage, object, CancellationToken)

ApiClientBase.SendAsync<TResponse>(HttpRequestMessage, CancellationToken)

ApiClientBase.SendAsync<TResponse>(HttpRequestMessage, object, CancellationToken)

ApiClientBase.SendStreamingAsync<TItem>(HttpRequestMessage, CancellationToken)

ApiClientBase.SendStreamingAsync<TItem>(HttpRequestMessage, object, CancellationToken)

ApiClientBase.GetApiUrl(string, ReadOnlySpan<(string Name, object Value)>)

Namespace: Singulink.Net.Http.Api.Client

Assembly: Singulink.Net.Http.Api.Client.SignalR.dll

Syntax

public abstract class SignalRApiClientBase : ApiClientBase

Constructors

Name	Description
SignalRApiClientBase()	Initializes a new instance of the SignalRApiClientBase class using reflection-based JSON serialization with default Web options.
SignalRApiClientBase(ApiClientBase)	Initializes a new instance of the SignalRApiClientBase class that shares the session state and JSON serializer options with the specified parent client.
SignalRApiClientBase(string?, Action<string?>?)	Initializes a new instance of the SignalRApiClientBase class using reflection-based JSON serialization with default Web options, the specified session token and session token changed callback.
SignalRApiClientBase(JsonSerializerOptions, string?, Action<string?>?)	Initializes a new instance of the SignalRApiClientBase class using the specified JSON serializer options, with an optional session token and session token changed callback.
SignalRApiClientBase(IJsonTypeInfoResolver, Action<JsonSerializerOptions>?)	Initializes a new instance of the SignalRApiClientBase class using JSON serialization backed by the specified source-generated type information resolver (e.g. a JsonSerializerContext). This constructor is compatible with trimming.
SignalRApiClientBase(IJsonTypeInfoResolver, string?, Action<string?>?, Action<JsonSerializerOptions>?)	Initializes a new instance of the SignalRApiClientBase class using JSON serialization backed by the specified source-generated type information resolver (e.g. a JsonSerializerContext), with the specified session token and session token changed callback. This constructor is compatible with trimming.

Methods

Name	Description
CreateHubConnection(string, Action<HttpConnectionOptions>?, params ReadOnlySpan<(string Name, object? Value)>)	Creates a new ApiHubConnection for the specified hub path with optional connection options and query string parameters. Default query parameters from GetDefaultQueryParams(string) are automatically merged with per-call parameters (per-call parameters with the same name take precedence). Session cookies and user agent are applied automatically on non-browser platforms.
CreateHubConnection(string, params ReadOnlySpan<(string Name, object? Value)>)	Creates a new ApiHubConnection for the specified hub path with optional query string parameters. Default query parameters from GetDefaultQueryParams(string) are automatically merged with per-call parameters (per-call parameters with the same name take precedence). Session cookies and user agent are applied automatically on non-browser platforms.
CreateHubConnectionBuilder()	Creates a new HubConnectionBuilder for building hub connections. Default implementation returns a builder with automatic reconnect enabled. Override to customize the builder (e.g. adjust reconnect policy, etc.).