Class TorBoxResponse

Namespace

TorBoxSDK.Models.Common

Assembly

TorBoxSDK.dll

Represents a standard TorBox API response without a typed data payload.

public sealed record TorBoxResponse : IEquatable<TorBoxResponse>

Inheritance

object

TorBoxResponse

Implements

IEquatable<TorBoxResponse>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

All TorBox API responses share a common envelope with Success, Error, and Detail fields. Use TorBoxResponse<T> when the response includes a typed data payload.

Properties

Detail

Gets additional detail about the response or error, or null if none was provided.

[JsonPropertyName("detail")]
public string? Detail { get; init; }

Property Value

string

Error

Gets the error message returned by the API, or null if no error occurred.

[JsonPropertyName("error")]
public string? Error { get; init; }

Property Value

string

Success

Gets a value indicating whether the API request was successful.

[JsonPropertyName("success")]
public bool Success { get; init; }

Property Value

bool