Class User

Class User

Inheritance
System.Object
BaseItem
User
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public sealed class User : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>

Properties

Configuration

Declaration
[IgnoreDataMember]
public UserConfiguration Configuration { get; set; }
Property Value
Type Description
UserConfiguration

ConfigurationDirectoryPath

Gets the path to the user's configuration directory

Declaration
[IgnoreDataMember]
public string ConfigurationDirectoryPath { get; }
Property Value
Type Description
System.String

The configuration directory path.

ConnectAccessKey

Declaration
public string ConnectAccessKey { get; set; }
Property Value
Type Description
System.String

ConnectLinkType

Declaration
public UserLinkType? ConnectLinkType { get; set; }
Property Value
Type Description
System.Nullable<UserLinkType>

ConnectUserId

Declaration
public string ConnectUserId { get; set; }
Property Value
Type Description
System.String

ConnectUserName

Declaration
public string ConnectUserName { get; set; }
Property Value
Type Description
System.String

ContainingFolderPath

Returns the folder containing the item. If the item is a folder, it returns the folder itself

Declaration
[IgnoreDataMember]
public override string ContainingFolderPath { get; }
Property Value
Type Description
System.String

The containing folder path.
Overrides

EasyPassword

Declaration
public string EasyPassword { get; set; }
Property Value
Type Description
System.String

EnableInternalIdsExternally

Declaration
[IgnoreDataMember]
public override bool EnableInternalIdsExternally { get; }
Property Value
Type Description
System.Boolean
Overrides

ImageInfos

Declaration
public override ItemImageInfo[] ImageInfos { get; set; }
Property Value
Type Description
ItemImageInfo[]
Overrides

IsLockedOut

Declaration
[IgnoreDataMember]
public bool IsLockedOut { get; }
Property Value
Type Description
System.Boolean

LastActivityDate

Gets or sets the last activity date.

Declaration
public DateTimeOffset? LastActivityDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

The last activity date.

LastLoginDate

Gets or sets the last login date.

Declaration
public DateTimeOffset? LastLoginDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTimeOffset>

The last login date.

Name

Gets or sets the name.

Declaration
public override string Name { get; set; }
Property Value
Type Description
System.String

The name.
Overrides

Password

Gets or sets the password.

Declaration
public string Password { get; set; }
Property Value
Type Description
System.String

The password.

Path

Gets or sets the path.

Declaration
[IgnoreDataMember]
public override string Path { get; set; }
Property Value
Type Description
System.String

The path.
Overrides

Policy

Declaration
[IgnoreDataMember]
public UserPolicy Policy { get; set; }
Property Value
Type Description
UserPolicy

Salt

Declaration
public string Salt { get; set; }
Property Value
Type Description
System.String

SupportsPeople

Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }
Property Value
Type Description
System.Boolean
Overrides

UsesIdForConfigurationPath

From now on all user paths will be Id-based. This is for backwards compatibility.

Declaration
public bool UsesIdForConfigurationPath { get; set; }
Property Value
Type Description
System.Boolean

Methods

AssertNotDisabled()

Declaration
public void AssertNotDisabled()

AssertNotLockedOut()

Declaration
public void AssertNotLockedOut()

AssertRemoteAccessAllowed()

Declaration
public void AssertRemoteAccessAllowed()

GetDefaultPrimaryImageAspectRatio()

Declaration
public override double GetDefaultPrimaryImageAspectRatio()
Returns
Type Description
System.Double
Overrides

GetTypedSetting(String)

Declaration
public object GetTypedSetting(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Object

IsGrantedAccessToFeature(String)

Declaration
public bool IsGrantedAccessToFeature(string featureId)
Parameters
Type Name Description
System.String featureId
Returns
Type Description
System.Boolean

IsParentalScheduleAllowed()

Declaration
public bool IsParentalScheduleAllowed()
Returns
Type Description
System.Boolean

IsParentalScheduleAllowed(DateTimeOffset)

Declaration
public bool IsParentalScheduleAllowed(DateTimeOffset date)
Parameters
Type Name Description
System.DateTimeOffset date
Returns
Type Description
System.Boolean

Rename(String)

Renames the user.

Declaration
public Task Rename(string newName)
Parameters
Type Name Description
System.String newName

The new name.
Returns
Type Description
System.Threading.Tasks.Task

Task.
Exceptions
Type Condition
System.ArgumentNullException

UpdateToRepository(ItemUpdateType, BaseItem, MetadataRefreshOptions)

Declaration
public override void UpdateToRepository(ItemUpdateType updateReason, BaseItem parent, MetadataRefreshOptions metadataRefreshOptions)
Parameters
Type Name Description
ItemUpdateType updateReason
BaseItem parent
MetadataRefreshOptions metadataRefreshOptions
Overrides

UpdateToRepository(ItemUpdateType, MetadataRefreshOptions)

Declaration
public override void UpdateToRepository(ItemUpdateType updateReason, MetadataRefreshOptions metadataRefreshOptions)
Parameters
Type Name Description
ItemUpdateType updateReason
MetadataRefreshOptions metadataRefreshOptions
Overrides

UpdateTypedSetting(String, Object)

Declaration
public void UpdateTypedSetting(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

Implements

Extension Methods