Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias UserPolicy

    type UserPolicy = {
        IsAdministrator?: boolean;
        IsHidden?: boolean;
        EnableCollectionManagement?: boolean;
        EnableSubtitleManagement?: boolean;
        EnableLyricManagement?: boolean;
        IsDisabled?: boolean;
        MaxParentalRating?: number | null;
        MaxParentalSubRating?: number | null;
        BlockedTags?: string[] | null;
        AllowedTags?: string[] | null;
        EnableUserPreferenceAccess?: boolean;
        AccessSchedules?: AccessSchedule[] | null;
        BlockUnratedItems?: UnratedItem[] | null;
        EnableRemoteControlOfOtherUsers?: boolean;
        EnableSharedDeviceControl?: boolean;
        EnableRemoteAccess?: boolean;
        EnableLiveTvManagement?: boolean;
        EnableLiveTvAccess?: boolean;
        EnableMediaPlayback?: boolean;
        EnableAudioPlaybackTranscoding?: boolean;
        EnableVideoPlaybackTranscoding?: boolean;
        EnablePlaybackRemuxing?: boolean;
        ForceRemoteSourceTranscoding?: boolean;
        EnableContentDeletion?: boolean;
        EnableContentDeletionFromFolders?: string[] | null;
        EnableContentDownloading?: boolean;
        EnableSyncTranscoding?: boolean;
        EnableMediaConversion?: boolean;
        EnabledDevices?: string[] | null;
        EnableAllDevices?: boolean;
        EnabledChannels?: string[] | null;
        EnableAllChannels?: boolean;
        EnabledFolders?: string[] | null;
        EnableAllFolders?: boolean;
        InvalidLoginAttemptCount?: number;
        LoginAttemptsBeforeLockout?: number;
        MaxActiveSessions?: number;
        EnablePublicSharing?: boolean;
        BlockedMediaFolders?: string[] | null;
        BlockedChannels?: string[] | null;
        RemoteClientBitrateLimit?: number;
        AuthenticationProviderId: string;
        PasswordResetProviderId: string;
        SyncPlayAccess?: "CreateAndJoinGroups" | "JoinGroups" | "None";
    }
    Index
    IsAdministrator? IsHidden? EnableCollectionManagement? EnableSubtitleManagement? EnableLyricManagement? IsDisabled? MaxParentalRating? MaxParentalSubRating? BlockedTags? AllowedTags? EnableUserPreferenceAccess? AccessSchedules? BlockUnratedItems? EnableRemoteControlOfOtherUsers? EnableSharedDeviceControl? EnableRemoteAccess? EnableLiveTvManagement? EnableLiveTvAccess? EnableMediaPlayback? EnableAudioPlaybackTranscoding? EnableVideoPlaybackTranscoding? EnablePlaybackRemuxing? ForceRemoteSourceTranscoding? EnableContentDeletion? EnableContentDeletionFromFolders? EnableContentDownloading? EnableSyncTranscoding? EnableMediaConversion? EnabledDevices? EnableAllDevices? EnabledChannels? EnableAllChannels? EnabledFolders? EnableAllFolders? InvalidLoginAttemptCount? LoginAttemptsBeforeLockout? MaxActiveSessions? EnablePublicSharing? BlockedMediaFolders? BlockedChannels? RemoteClientBitrateLimit? AuthenticationProviderId PasswordResetProviderId SyncPlayAccess?
    IsAdministrator?: boolean

    Gets or sets a value indicating whether this instance is administrator.

    IsHidden?: boolean

    Gets or sets a value indicating whether this instance is hidden.

    EnableCollectionManagement?: boolean

    Gets or sets a value indicating whether this instance can manage collections.

    EnableSubtitleManagement?: boolean

    Gets or sets a value indicating whether this instance can manage subtitles.

    EnableLyricManagement?: boolean

    Gets or sets a value indicating whether this user can manage lyrics.

    IsDisabled?: boolean

    Gets or sets a value indicating whether this instance is disabled.

    MaxParentalRating?: number | null

    Gets or sets the max parental rating.

    MaxParentalSubRating?: number | null
    BlockedTags?: string[] | null
    AllowedTags?: string[] | null
    EnableUserPreferenceAccess?: boolean
    AccessSchedules?: AccessSchedule[] | null
    BlockUnratedItems?: UnratedItem[] | null
    EnableRemoteControlOfOtherUsers?: boolean
    EnableSharedDeviceControl?: boolean
    EnableRemoteAccess?: boolean
    EnableLiveTvManagement?: boolean
    EnableLiveTvAccess?: boolean
    EnableMediaPlayback?: boolean
    EnableAudioPlaybackTranscoding?: boolean
    EnableVideoPlaybackTranscoding?: boolean
    EnablePlaybackRemuxing?: boolean
    ForceRemoteSourceTranscoding?: boolean
    EnableContentDeletion?: boolean
    EnableContentDeletionFromFolders?: string[] | null
    EnableContentDownloading?: boolean
    EnableSyncTranscoding?: boolean

    Gets or sets a value indicating whether [enable synchronize].

    EnableMediaConversion?: boolean
    EnabledDevices?: string[] | null
    EnableAllDevices?: boolean
    EnabledChannels?: string[] | null
    EnableAllChannels?: boolean
    EnabledFolders?: string[] | null
    EnableAllFolders?: boolean
    InvalidLoginAttemptCount?: number
    LoginAttemptsBeforeLockout?: number
    MaxActiveSessions?: number
    EnablePublicSharing?: boolean
    BlockedMediaFolders?: string[] | null
    BlockedChannels?: string[] | null
    RemoteClientBitrateLimit?: number
    AuthenticationProviderId: string
    PasswordResetProviderId: string
    SyncPlayAccess?: "CreateAndJoinGroups" | "JoinGroups" | "None"

    Enum SyncPlayUserAccessType.

    Settings
    Member Visibility

    On This Page
    Properties
    IsAdministratorIsHiddenEnableCollectionManagementEnableSubtitleManagementEnableLyricManagementIsDisabledMaxParentalRatingMaxParentalSubRatingBlockedTagsAllowedTagsEnableUserPreferenceAccessAccessSchedulesBlockUnratedItemsEnableRemoteControlOfOtherUsersEnableSharedDeviceControlEnableRemoteAccessEnableLiveTvManagementEnableLiveTvAccessEnableMediaPlaybackEnableAudioPlaybackTranscodingEnableVideoPlaybackTranscodingEnablePlaybackRemuxingForceRemoteSourceTranscodingEnableContentDeletionEnableContentDeletionFromFoldersEnableContentDownloadingEnableSyncTranscodingEnableMediaConversionEnabledDevicesEnableAllDevicesEnabledChannelsEnableAllChannelsEnabledFoldersEnableAllFoldersInvalidLoginAttemptCountLoginAttemptsBeforeLockoutMaxActiveSessionsEnablePublicSharingBlockedMediaFoldersBlockedChannelsRemoteClientBitrateLimitAuthenticationProviderIdPasswordResetProviderIdSyncPlayAccess