Class UserProfile

Namespace

TorBoxSDK.Models.User

Assembly

TorBoxSDK.dll

Represents a TorBox user account returned by the API.

public sealed record UserProfile : IEquatable<UserProfile>

Inheritance

object

UserProfile

Implements

IEquatable<UserProfile>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AdditionalConcurrentSlots

Gets the number of additional concurrent download slots.

[JsonPropertyName("additional_concurrent_slots")]
public int AdditionalConcurrentSlots { get; init; }

Property Value

int

AuthId

Gets the authentication identifier of the user, or null if not available.

[JsonPropertyName("auth_id")]
public string? AuthId { get; init; }

Property Value

string

BaseEmail

Gets the base email address of the user (without aliases), or null if not available.

[JsonPropertyName("base_email")]
public string? BaseEmail { get; init; }

Property Value

string

CooldownUntil

Gets the date and time until which the user is on cooldown, or null if not on cooldown.

[JsonPropertyName("cooldown_until")]
public DateTimeOffset? CooldownUntil { get; init; }

Property Value

DateTimeOffset?

CreatedAt

Gets the date and time when the user account was created, or null if not available.

[JsonPropertyName("created_at")]
public DateTimeOffset? CreatedAt { get; init; }

Property Value

DateTimeOffset?

Customer

Gets the customer identifier from the payment provider, or null if not available.

[JsonPropertyName("customer")]
public string? Customer { get; init; }

Property Value

string

Email

Gets the email address of the user, or null if not available.

[JsonPropertyName("email")]
public string? Email { get; init; }

Property Value

string

Id

Gets the unique identifier of the user.

[JsonPropertyName("id")]
public long Id { get; init; }

Property Value

long

IsSubscribed

Gets a value indicating whether the user has an active subscription.

[JsonPropertyName("is_subscribed")]
public bool IsSubscribed { get; init; }

Property Value

bool

IsVendor

Gets a value indicating whether the user is a vendor.

[JsonPropertyName("is_vendor")]
public bool IsVendor { get; init; }

Property Value

bool

LongTermSeeding

Gets a value indicating whether long-term seeding is enabled.

[JsonPropertyName("long_term_seeding")]
public bool LongTermSeeding { get; init; }

Property Value

bool

LongTermStorage

Gets a value indicating whether long-term storage is enabled.

[JsonPropertyName("long_term_storage")]
public bool LongTermStorage { get; init; }

Property Value

bool

Plan

Gets the numeric identifier of the user's current plan.

[JsonPropertyName("plan")]
public int Plan { get; init; }

Property Value

int

PremiumExpiresAt

Gets the date and time when the user's premium subscription expires, or null if not subscribed.

[JsonPropertyName("premium_expires_at")]
public DateTimeOffset? PremiumExpiresAt { get; init; }

Property Value

DateTimeOffset?

PurchasesReferred

Gets the number of purchases referred by the user.

[JsonPropertyName("purchases_referred")]
public int PurchasesReferred { get; init; }

Property Value

int

Settings

Gets the user's account settings, or null if not included in the response.

[JsonPropertyName("settings")]
public UserSettings? Settings { get; init; }

Property Value

UserSettings

TorrentsDownloaded

Gets the number of torrents downloaded by the user.

[JsonPropertyName("torrents_downloaded")]
public long TorrentsDownloaded { get; init; }

Property Value

long

TotalBytesDownloaded

Gets the total number of bytes downloaded by the user.

[JsonPropertyName("total_bytes_downloaded")]
public long TotalBytesDownloaded { get; init; }

Property Value

long

TotalBytesUploaded

Gets the total number of bytes uploaded by the user.

[JsonPropertyName("total_bytes_uploaded")]
public long TotalBytesUploaded { get; init; }

Property Value

long

TotalDownloaded

Gets the total bytes downloaded by the user.

[JsonPropertyName("total_downloaded")]
public long TotalDownloaded { get; init; }

Property Value

long

UpdatedAt

Gets the date and time when the user account was last updated, or null if not available.

[JsonPropertyName("updated_at")]
public DateTimeOffset? UpdatedAt { get; init; }

Property Value

DateTimeOffset?

UsenetDownloadsDownloaded

Gets the number of usenet downloads completed by the user.

[JsonPropertyName("usenet_downloads_downloaded")]
public long UsenetDownloadsDownloaded { get; init; }

Property Value

long

UserReferral

Gets the user's referral identifier, or null if not available.

[JsonPropertyName("user_referral")]
public string? UserReferral { get; init; }

Property Value

string

VendorId

Gets the vendor identifier, or null if the user is not a vendor.

[JsonPropertyName("vendor_id")]
public string? VendorId { get; init; }

Property Value

string

WebDownloadsDownloaded

Gets the number of web downloads completed by the user.

[JsonPropertyName("web_downloads_downloaded")]
public long WebDownloadsDownloaded { get; init; }

Property Value

long