Interface UserPolicy

Export

UserPolicy

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

Properties

AccessSchedules? AllowedTags? AuthenticationProviderId BlockedChannels? BlockedMediaFolders? BlockedTags? BlockUnratedItems? EnableAllChannels? EnableAllDevices? EnableAllFolders? EnableAudioPlaybackTranscoding? EnableCollectionManagement? EnableContentDeletion? EnableContentDeletionFromFolders? EnableContentDownloading? EnabledChannels? EnabledDevices? EnabledFolders? EnableLiveTvAccess? EnableLiveTvManagement? EnableLyricManagement? EnableMediaConversion? EnableMediaPlayback? EnablePlaybackRemuxing? EnablePublicSharing? EnableRemoteAccess? EnableRemoteControlOfOtherUsers? EnableSharedDeviceControl? EnableSubtitleManagement? EnableSyncTranscoding? EnableUserPreferenceAccess? EnableVideoPlaybackTranscoding? ForceRemoteSourceTranscoding? InvalidLoginAttemptCount? IsAdministrator? IsDisabled? IsHidden? LoginAttemptsBeforeLockout? MaxActiveSessions? MaxParentalRating? PasswordResetProviderId RemoteClientBitrateLimit? SyncPlayAccess?

Properties

OptionalAccessSchedules

AccessSchedules?: null | AccessSchedule[]

Memberof

UserPolicy

OptionalAllowedTags

AllowedTags?: null | string[]

Memberof

UserPolicy

AuthenticationProviderId

AuthenticationProviderId: string

Memberof

UserPolicy

OptionalBlockedChannels

BlockedChannels?: null | string[]

Memberof

UserPolicy

OptionalBlockedMediaFolders

BlockedMediaFolders?: null | string[]

Memberof

UserPolicy

OptionalBlockedTags

BlockedTags?: null | string[]

Memberof

UserPolicy

OptionalBlockUnratedItems

BlockUnratedItems?: null | UnratedItem[]

Memberof

UserPolicy

OptionalEnableAllChannels

EnableAllChannels?: boolean

Memberof

UserPolicy

OptionalEnableAllDevices

EnableAllDevices?: boolean

Memberof

UserPolicy

OptionalEnableAllFolders

EnableAllFolders?: boolean

Memberof

UserPolicy

OptionalEnableAudioPlaybackTranscoding

EnableAudioPlaybackTranscoding?: boolean

Memberof

UserPolicy

OptionalEnableCollectionManagement

EnableCollectionManagement?: boolean

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

Memberof

UserPolicy

OptionalEnableContentDeletion

EnableContentDeletion?: boolean

Memberof

UserPolicy

OptionalEnableContentDeletionFromFolders

EnableContentDeletionFromFolders?: null | string[]

Memberof

UserPolicy

OptionalEnableContentDownloading

EnableContentDownloading?: boolean

Memberof

UserPolicy

OptionalEnabledChannels

EnabledChannels?: null | string[]

Memberof

UserPolicy

OptionalEnabledDevices

EnabledDevices?: null | string[]

Memberof

UserPolicy

OptionalEnabledFolders

EnabledFolders?: null | string[]

Memberof

UserPolicy

OptionalEnableLiveTvAccess

EnableLiveTvAccess?: boolean

Memberof

UserPolicy

OptionalEnableLiveTvManagement

EnableLiveTvManagement?: boolean

Memberof

UserPolicy

OptionalEnableLyricManagement

EnableLyricManagement?: boolean

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

Memberof

UserPolicy

OptionalEnableMediaConversion

EnableMediaConversion?: boolean

Memberof

UserPolicy

OptionalEnableMediaPlayback

EnableMediaPlayback?: boolean

Memberof

UserPolicy

OptionalEnablePlaybackRemuxing

EnablePlaybackRemuxing?: boolean

Memberof

UserPolicy

OptionalEnablePublicSharing

EnablePublicSharing?: boolean

Memberof

UserPolicy

OptionalEnableRemoteAccess

EnableRemoteAccess?: boolean

Memberof

UserPolicy

OptionalEnableRemoteControlOfOtherUsers

EnableRemoteControlOfOtherUsers?: boolean

Memberof

UserPolicy

OptionalEnableSharedDeviceControl

EnableSharedDeviceControl?: boolean

Memberof

UserPolicy

OptionalEnableSubtitleManagement

EnableSubtitleManagement?: boolean

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

Memberof

UserPolicy

OptionalEnableSyncTranscoding

EnableSyncTranscoding?: boolean

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

Memberof

UserPolicy

OptionalEnableUserPreferenceAccess

EnableUserPreferenceAccess?: boolean

Memberof

UserPolicy

OptionalEnableVideoPlaybackTranscoding

EnableVideoPlaybackTranscoding?: boolean

Memberof

UserPolicy

OptionalForceRemoteSourceTranscoding

ForceRemoteSourceTranscoding?: boolean

Memberof

UserPolicy

OptionalInvalidLoginAttemptCount

InvalidLoginAttemptCount?: number

Memberof

UserPolicy

OptionalIsAdministrator

IsAdministrator?: boolean

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

Memberof

UserPolicy

OptionalIsDisabled

IsDisabled?: boolean

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

Memberof

UserPolicy

OptionalIsHidden

IsHidden?: boolean

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

Memberof

UserPolicy

OptionalLoginAttemptsBeforeLockout

LoginAttemptsBeforeLockout?: number

Memberof

UserPolicy

OptionalMaxActiveSessions

MaxActiveSessions?: number

Memberof

UserPolicy

OptionalMaxParentalRating

MaxParentalRating?: null | number

Gets or sets the max parental rating.

Memberof

UserPolicy

PasswordResetProviderId

PasswordResetProviderId: string

Memberof

UserPolicy

OptionalRemoteClientBitrateLimit

RemoteClientBitrateLimit?: number

Memberof

UserPolicy

OptionalSyncPlayAccess

SyncPlayAccess?: SyncPlayUserAccessType

Memberof

UserPolicy

Settings

Member Visibility

On This Page

Properties
AccessSchedulesAllowedTagsAuthenticationProviderIdBlockedChannelsBlockedMediaFoldersBlockedTagsBlockUnratedItemsEnableAllChannelsEnableAllDevicesEnableAllFoldersEnableAudioPlaybackTranscodingEnableCollectionManagementEnableContentDeletionEnableContentDeletionFromFoldersEnableContentDownloadingEnabledChannelsEnabledDevicesEnabledFoldersEnableLiveTvAccessEnableLiveTvManagementEnableLyricManagementEnableMediaConversionEnableMediaPlaybackEnablePlaybackRemuxingEnablePublicSharingEnableRemoteAccessEnableRemoteControlOfOtherUsersEnableSharedDeviceControlEnableSubtitleManagementEnableSyncTranscodingEnableUserPreferenceAccessEnableVideoPlaybackTranscodingForceRemoteSourceTranscodingInvalidLoginAttemptCountIsAdministratorIsDisabledIsHiddenLoginAttemptsBeforeLockoutMaxActiveSessionsMaxParentalRatingPasswordResetProviderIdRemoteClientBitrateLimitSyncPlayAccess