Table of Contents

Class UserSettings

Namespace
TorBoxSDK.Models.User
Assembly
TorBoxSDK.dll

Represents the configurable settings for a TorBox user account as returned by the API.

public sealed record UserSettings : IEquatable<UserSettings>
Inheritance
UserSettings
Implements
Inherited Members

Properties

AllowZipped

Gets a value indicating whether zipped downloads are allowed, or null if not specified.

[JsonPropertyName("allow_zipped")]
public bool? AllowZipped { get; init; }

Property Value

bool?

Gets a value indicating whether the filename is appended to download links, or null if not specified.

[JsonPropertyName("append_filename_to_links")]
public bool? AppendFilenameToLinks { get; init; }

Property Value

bool?

CdnSelection

Gets the CDN selection preference, or null if not specified.

[JsonPropertyName("cdn_selection")]
public string? CdnSelection { get; init; }

Property Value

string

DashboardFilter

Gets the dashboard filter configuration, or null if not specified.

[JsonPropertyName("dashboard_filter")]
public DashboardFilter? DashboardFilter { get; init; }

Property Value

DashboardFilter

DashboardSort

Gets the dashboard sort preference, or null if not specified.

[JsonPropertyName("dashboard_sort")]
public string? DashboardSort { get; init; }

Property Value

string

DiscordId

Gets the Discord ID for notifications, or null if not configured.

[JsonPropertyName("discord_id")]
public string? DiscordId { get; init; }

Property Value

string

DiscordNotifications

Gets a value indicating whether Discord notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("discord_notifications")]
public bool? DiscordNotifications { get; init; }

Property Value

bool?

DownloadSpeedInTab

Gets a value indicating whether download speed is shown in the browser tab, or null if not specified.

[JsonPropertyName("download_speed_in_tab")]
public bool? DownloadSpeedInTab { get; init; }

Property Value

bool?

EmailNotifications

Gets a value indicating whether email notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("email_notifications")]
public bool? EmailNotifications { get; init; }

Property Value

bool?

GofileApiKey

Gets the GoFile API key, or null if not configured.

[JsonPropertyName("gofile_api_key")]
public string? GofileApiKey { get; init; }

Property Value

string

GofileFolderId

Gets the GoFile folder ID, or null if not configured.

[JsonPropertyName("gofile_folder_id")]
public string? GofileFolderId { get; init; }

Property Value

string

GoogleDriveFolderId

Gets the Google Drive folder ID, or null if not configured.

[JsonPropertyName("google_drive_folder_id")]
public string? GoogleDriveFolderId { get; init; }

Property Value

string

JdownloaderNotifications

Gets a value indicating whether JDownloader notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("jdownloader_notifications")]
public bool? JdownloaderNotifications { get; init; }

Property Value

bool?

MegaEmail

Gets the MEGA email, or null if not configured.

[JsonPropertyName("mega_email")]
public string? MegaEmail { get; init; }

Property Value

string

MegaPassword

Gets the MEGA password, or null if not configured.

[JsonPropertyName("mega_password")]
public string? MegaPassword { get; init; }

Property Value

string

MobileNotifications

Gets a value indicating whether mobile notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("mobile_notifications")]
public bool? MobileNotifications { get; init; }

Property Value

bool?

OnedriveSavePath

Gets the OneDrive save path, or null if not configured.

[JsonPropertyName("onedrive_save_path")]
public string? OnedriveSavePath { get; init; }

Property Value

string

OnefichierApiKey

Gets the 1Fichier API key, or null if not configured.

[JsonPropertyName("onefichier_api_key")]
public string? OnefichierApiKey { get; init; }

Property Value

string

OnefichierFolderId

Gets the 1Fichier folder ID, or null if not configured.

[JsonPropertyName("onefichier_folder_id")]
public string? OnefichierFolderId { get; init; }

Property Value

string

PatreonId

Gets the Patreon ID, or null if not configured.

[JsonPropertyName("patreon_id")]
public string? PatreonId { get; init; }

Property Value

string

PixeldrainApiKey

Gets the Pixeldrain API key, or null if not configured.

[JsonPropertyName("pixeldrain_api_key")]
public string? PixeldrainApiKey { get; init; }

Property Value

string

RssNotifications

Gets a value indicating whether RSS notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("rss_notifications")]
public bool? RssNotifications { get; init; }

Property Value

bool?

SeedTorrents

Gets the torrent seeding preference, or null if not specified.

[JsonPropertyName("seed_torrents")]
public int? SeedTorrents { get; init; }

Property Value

int?

ShowTrackerInTorrents

Gets a value indicating whether tracker info is shown in torrent details, or null if not specified.

[JsonPropertyName("show_tracker_in_torrents")]
public bool? ShowTrackerInTorrents { get; init; }

Property Value

bool?

StremioAllowAdult

Gets a value indicating whether adult content is allowed in Stremio, or null if not specified.

[JsonPropertyName("stremio_allow_adult")]
public bool? StremioAllowAdult { get; init; }

Property Value

bool?

StremioAllowZipped

Gets a value indicating whether zipped downloads are allowed in Stremio, or null if not specified.

[JsonPropertyName("stremio_allow_zipped")]
public bool? StremioAllowZipped { get; init; }

Property Value

bool?

StremioCache

Gets the Stremio cache settings, or null if not specified.

[JsonPropertyName("stremio_cache")]
public IReadOnlyList<int>? StremioCache { get; init; }

Property Value

IReadOnlyList<int>

StremioDisableFilteredNote

Gets a value indicating whether the filtered note is disabled in Stremio, or null if not specified.

[JsonPropertyName("stremio_disable_filtered_note")]
public bool? StremioDisableFilteredNote { get; init; }

Property Value

bool?

StremioDisableYourMediaStreams

Gets a value indicating whether your media streams are disabled in Stremio, or null if not specified.

[JsonPropertyName("stremio_disable_your_media_streams")]
public bool? StremioDisableYourMediaStreams { get; init; }

Property Value

bool?

StremioEmojiInDescription

Gets a value indicating whether emoji is shown in description in Stremio, or null if not specified.

[JsonPropertyName("stremio_emoji_in_description")]
public bool? StremioEmojiInDescription { get; init; }

Property Value

bool?

StremioLanguage

Gets the Stremio language preferences, or null if not specified.

[JsonPropertyName("stremio_language")]
public IReadOnlyList<int>? StremioLanguage { get; init; }

Property Value

IReadOnlyList<int>

StremioLegacyYourMedia

Gets a value indicating whether legacy your media is enabled in Stremio, or null if not specified.

[JsonPropertyName("stremio_legacy_your_media")]
public bool? StremioLegacyYourMedia { get; init; }

Property Value

bool?

StremioLimitPerResolutionTorrent

Gets the limit per resolution for torrents in Stremio, or null if not specified.

[JsonPropertyName("stremio_limit_per_resolution_torrent")]
public int? StremioLimitPerResolutionTorrent { get; init; }

Property Value

int?

StremioLimitPerResolutionUsenet

Gets the limit per resolution for usenet in Stremio, or null if not specified.

[JsonPropertyName("stremio_limit_per_resolution_usenet")]
public int? StremioLimitPerResolutionUsenet { get; init; }

Property Value

int?

StremioOnlyYourMediaStreams

Gets a value indicating whether only your media streams are shown in Stremio, or null if not specified.

[JsonPropertyName("stremio_only_your_media_streams")]
public bool? StremioOnlyYourMediaStreams { get; init; }

Property Value

bool?

StremioQuality

Gets the Stremio quality preferences, or null if not specified.

[JsonPropertyName("stremio_quality")]
public IReadOnlyList<int>? StremioQuality { get; init; }

Property Value

IReadOnlyList<int>

StremioResolution

Gets the Stremio resolution preferences, or null if not specified.

[JsonPropertyName("stremio_resolution")]
public IReadOnlyList<int>? StremioResolution { get; init; }

Property Value

IReadOnlyList<int>

StremioResultSort

Gets the Stremio result sort preference, or null if not specified.

[JsonPropertyName("stremio_result_sort")]
public string? StremioResultSort { get; init; }

Property Value

string

StremioSeedTorrents

Gets the Stremio torrent seeding setting, or null if not specified.

[JsonPropertyName("stremio_seed_torrents")]
public int? StremioSeedTorrents { get; init; }

Property Value

int?

StremioSizeLower

Gets the Stremio minimum size filter, or null if not specified.

[JsonPropertyName("stremio_size_lower")]
public long? StremioSizeLower { get; init; }

Property Value

long?

StremioSizeUpper

Gets the Stremio maximum size filter, or null if not specified.

[JsonPropertyName("stremio_size_upper")]
public long? StremioSizeUpper { get; init; }

Property Value

long?

StremioSort

Gets the Stremio sort preference, or null if not specified.

[JsonPropertyName("stremio_sort")]
public string? StremioSort { get; init; }

Property Value

string

StremioTorrentSeedersCutoff

Gets the torrent seeders cutoff in Stremio, or null if not specified.

[JsonPropertyName("stremio_torrent_seeders_cutoff")]
public int? StremioTorrentSeedersCutoff { get; init; }

Property Value

int?

StremioUseCustomSearchEngines

Gets a value indicating whether custom search engines are used in Stremio, or null if not specified.

[JsonPropertyName("stremio_use_custom_search_engines")]
public bool? StremioUseCustomSearchEngines { get; init; }

Property Value

bool?

StremioWaitForDownloadTorrent

Gets a value indicating whether to wait for torrent download in Stremio, or null if not specified.

[JsonPropertyName("stremio_wait_for_download_torrent")]
public bool? StremioWaitForDownloadTorrent { get; init; }

Property Value

bool?

StremioWaitForDownloadUsenet

Gets a value indicating whether to wait for usenet download in Stremio, or null if not specified.

[JsonPropertyName("stremio_wait_for_download_usenet")]
public bool? StremioWaitForDownloadUsenet { get; init; }

Property Value

bool?

TelegramId

Gets the Telegram ID for notifications, or null if not configured.

[JsonPropertyName("telegram_id")]
public string? TelegramId { get; init; }

Property Value

string

TelegramNotifications

Gets a value indicating whether Telegram notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("telegram_notifications")]
public bool? TelegramNotifications { get; init; }

Property Value

bool?

WebNotifications

Gets a value indicating whether web notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("web_notifications")]
public bool? WebNotifications { get; init; }

Property Value

bool?

WebPlayerAlwaysSkipIntro

Gets a value indicating whether the web player always skips intros, or null if not specified.

[JsonPropertyName("web_player_always_skip_intro")]
public bool? WebPlayerAlwaysSkipIntro { get; init; }

Property Value

bool?

WebPlayerAlwaysTranscode

Gets a value indicating whether the web player always transcodes media, or null if not specified.

[JsonPropertyName("web_player_always_transcode")]
public bool? WebPlayerAlwaysTranscode { get; init; }

Property Value

bool?

WebPlayerAudioPreferredLanguage

Gets the preferred audio language for the web player, or null if not specified.

[JsonPropertyName("web_player_audio_preferred_language")]
public string? WebPlayerAudioPreferredLanguage { get; init; }

Property Value

string

WebPlayerDisableNextUpDialogue

Gets a value indicating whether the "Next Up" dialogue is disabled in the web player, or null if not specified.

[JsonPropertyName("web_player_disable_next_up_dialogue")]
public bool? WebPlayerDisableNextUpDialogue { get; init; }

Property Value

bool?

WebPlayerDisablePrestreamSelector

Gets a value indicating whether the pre-stream selector is disabled in the web player, or null if not specified.

[JsonPropertyName("web_player_disable_prestream_selector")]
public bool? WebPlayerDisablePrestreamSelector { get; init; }

Property Value

bool?

WebPlayerEnableScrobbling

Gets a value indicating whether scrobbling is enabled in the web player, or null if not specified.

[JsonPropertyName("web_player_enable_scrobbling")]
public bool? WebPlayerEnableScrobbling { get; init; }

Property Value

bool?

WebPlayerSubtitlePreferredLanguage

Gets the preferred subtitle language for the web player, or null if not specified.

[JsonPropertyName("web_player_subtitle_preferred_language")]
public string? WebPlayerSubtitlePreferredLanguage { get; init; }

Property Value

string

WebdavFlatten

Gets a value indicating whether the WebDAV structure is flattened, or null if not specified.

[JsonPropertyName("webdav_flatten")]
public bool? WebdavFlatten { get; init; }

Property Value

bool?

WebdavUseFolderView

Gets a value indicating whether folder view is used for WebDAV, or null if not specified.

[JsonPropertyName("webdav_use_folder_view")]
public bool? WebdavUseFolderView { get; init; }

Property Value

bool?

WebdavUseLocalFiles

Gets a value indicating whether local files are used for WebDAV, or null if not specified.

[JsonPropertyName("webdav_use_local_files")]
public bool? WebdavUseLocalFiles { get; init; }

Property Value

bool?

WebhookNotifications

Gets a value indicating whether webhook notifications are enabled, or null if the setting is not specified.

[JsonPropertyName("webhook_notifications")]
public bool? WebhookNotifications { get; init; }

Property Value

bool?

WebhookUrl

Gets the webhook URL for notifications, or null if not configured.

[JsonPropertyName("webhook_url")]
public string? WebhookUrl { get; init; }

Property Value

string
Edit this page