Interface IUserManager

Interface IUserManager

Namespace: MediaBrowser.Controller.Library
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IUserManager

Properties

Users

Gets the users.

Declaration
[Obsolete("Use GetUsers, GetUserList, GetUserIds, GetUserIdList, or GetUserCount to get a list of users based on a filter set. Avoid working with the entire user list all at once.")]
User[] Users { get; }
Property Value
Type Description
User[]

The users.

Methods

AddParts(IEnumerable<IAuthenticationProvider>, IEnumerable<IUserConfigurationFactory>)

Declaration
void AddParts(IEnumerable<IAuthenticationProvider> authenticationProviders, IEnumerable<IUserConfigurationFactory> configurationFactories)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IAuthenticationProvider> authenticationProviders
System.Collections.Generic.IEnumerable<IUserConfigurationFactory> configurationFactories

AuthenticateUser(String, String, Boolean, Boolean, CancellationToken)

Authenticates the user.

Declaration
Task<User> AuthenticateUser(string username, string password, bool isUserSession, bool isInLocalNetwork, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String username
System.String password
System.Boolean isUserSession
System.Boolean isInLocalNetwork
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<User>

ChangePassword(User, String)

Changes the password.

Declaration
Task ChangePassword(User user, string newPassword)
Parameters
Type Name Description
User user
System.String newPassword
Returns
Type Description
System.Threading.Tasks.Task

CreateUser(String, User, UserCopyOptions[])

Declaration
Task<User> CreateUser(string name, User cloneFromUser, UserCopyOptions[] userCopyOptions)
Parameters
Type Name Description
System.String name
User cloneFromUser
UserCopyOptions[] userCopyOptions
Returns
Type Description
System.Threading.Tasks.Task<User>

CreateUser(String, UserPolicy)

Creates the user.

Declaration
Task<User> CreateUser(string name, UserPolicy userPolicy)
Parameters
Type Name Description
System.String name

The name.
UserPolicy userPolicy

The user policy.
Returns
Type Description
System.Threading.Tasks.Task<User>

User.
Exceptions
Type Condition
System.ArgumentNullException

name
System.ArgumentException

DeleteUser(User)

Deletes the user.

Declaration
Task DeleteUser(User user)
Parameters
Type Name Description
User user

The user.
Returns
Type Description
System.Threading.Tasks.Task

Task.
Exceptions
Type Condition
System.ArgumentNullException

user
System.ArgumentException

GetAuthenticationProviders()

Declaration
NameIdPair[] GetAuthenticationProviders()
Returns
Type Description
NameIdPair[]

GetGuid(Int64)

Declaration
Guid GetGuid(long id)
Parameters
Type Name Description
System.Int64 id
Returns
Type Description
System.Guid

GetGuid(ReadOnlySpan<Char>)

Declaration
Guid GetGuid(ReadOnlySpan<char> id)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> id
Returns
Type Description
System.Guid

GetInternalId(Guid)

Declaration
long GetInternalId(Guid id)
Parameters
Type Name Description
System.Guid id
Returns
Type Description
System.Int64

GetInternalId(ReadOnlySpan<Char>)

Declaration
long GetInternalId(ReadOnlySpan<char> id)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> id
Returns
Type Description
System.Int64

GetInternalId(String)

Declaration
long GetInternalId(string id)
Parameters
Type Name Description
System.String id
Returns
Type Description
System.Int64

GetTypedUserSetting(Int64, String)

Declaration
object GetTypedUserSetting(long userId, string key)
Parameters
Type Name Description
System.Int64 userId
System.String key
Returns
Type Description
System.Object

GetUserById(Guid)

Gets a User by Id

Declaration
User GetUserById(Guid id)
Parameters
Type Name Description
System.Guid id

The id.
Returns
Type Description
User

User.
Exceptions
Type Condition
System.ArgumentNullException

GetUserById(Int64)

Declaration
User GetUserById(long id)
Parameters
Type Name Description
System.Int64 id
Returns
Type Description
User

GetUserById(ReadOnlySpan<Char>)

Declaration
User GetUserById(ReadOnlySpan<char> id)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> id
Returns
Type Description
User

GetUserById(String)

Gets the user by identifier.

Declaration
User GetUserById(string id)
Parameters
Type Name Description
System.String id

The identifier.
Returns
Type Description
User

User.

GetUserByName(ReadOnlySpan<Char>)

Declaration
User GetUserByName(ReadOnlySpan<char> name)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> name
Returns
Type Description
User

GetUserByName(String)

Gets the name of the user by.

Declaration
User GetUserByName(string name)
Parameters
Type Name Description
System.String name

The name.
Returns
Type Description
User

User.

GetUserConfiguration(User)

Gets the user configuration.

Declaration
UserConfiguration GetUserConfiguration(User user)
Parameters
Type Name Description
User user

The user.
Returns
Type Description
UserConfiguration

UserConfiguration.

GetUserCount(UserQuery)

Declaration
int GetUserCount(UserQuery query)
Parameters
Type Name Description
UserQuery query
Returns
Type Description
System.Int32

GetUserDto(User)

Gets the user dto.

Declaration
UserDto GetUserDto(User user)
Parameters
Type Name Description
User user
Returns
Type Description
UserDto

GetUserDto(User, Boolean)

Gets the user dto.

Declaration
UserDto GetUserDto(User user, bool isAuthenticated)
Parameters
Type Name Description
User user
System.Boolean isAuthenticated
Returns
Type Description
UserDto

GetUserIdList(UserQuery)

Declaration
long[] GetUserIdList(UserQuery query)
Parameters
Type Name Description
UserQuery query
Returns
Type Description
System.Int64[]

GetUserIds(UserQuery)

Declaration
QueryResult<long> GetUserIds(UserQuery query)
Parameters
Type Name Description
UserQuery query
Returns
Type Description
QueryResult<System.Int64>

GetUserList(UserQuery)

Declaration
User[] GetUserList(UserQuery query)
Parameters
Type Name Description
UserQuery query
Returns
Type Description
User[]

GetUserPolicy(User)

Gets the user policy.

Declaration
UserPolicy GetUserPolicy(User user)
Parameters
Type Name Description
User user

The user.
Returns
Type Description
UserPolicy

UserPolicy.

GetUsers(UserQuery)

Declaration
QueryResult<User> GetUsers(UserQuery query)
Parameters
Type Name Description
UserQuery query
Returns
Type Description
QueryResult<User>

GetUserSetting(Int64, String)

Declaration
string GetUserSetting(long userId, string key)
Parameters
Type Name Description
System.Int64 userId
System.String key
Returns
Type Description
System.String

GetUserSettingsType(String)

Declaration
Type GetUserSettingsType(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Type

GetUsersWithSettings(String)

Declaration
long[] GetUsersWithSettings(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Int64[]

MakeValidUsername(String)

Makes the valid username.

Declaration
string MakeValidUsername(string username)
Parameters
Type Name Description
System.String username

The username.
Returns
Type Description
System.String

System.String.

RedeemPasswordResetPin(String)

Redeems the password reset pin.

Declaration
Task<PinRedeemResult> RedeemPasswordResetPin(string pin)
Parameters
Type Name Description
System.String pin

The pin.
Returns
Type Description
System.Threading.Tasks.Task<PinRedeemResult>

true if XXXX, false otherwise.

RefreshUsersMetadata(CancellationToken)

Refreshes metadata for each user

Declaration
Task RefreshUsersMetadata(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
System.Threading.Tasks.Task

Task.

RenameUser(User, String)

Renames the user.

Declaration
Task RenameUser(User user, string newName)
Parameters
Type Name Description
User user

The user.
System.String newName

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

Task.
Exceptions
Type Condition
System.ArgumentNullException

user
System.ArgumentException

ResetPassword(User)

Resets the password.

Declaration
Task ResetPassword(User user)
Parameters
Type Name Description
User user

The user.
Returns
Type Description
System.Threading.Tasks.Task

Task.

SetTypedUserSetting(Int64, String, Object)

Declaration
void SetTypedUserSetting(long userId, string key, object configuration)
Parameters
Type Name Description
System.Int64 userId
System.String key
System.Object configuration

SetUserSettings(Int64, NameValuePair[])

Declaration
void SetUserSettings(long userId, NameValuePair[] settings)
Parameters
Type Name Description
System.Int64 userId
NameValuePair[] settings

StartForgotPasswordProcess(String, Boolean, CancellationToken)

Starts the forgot password process.

Declaration
Task<ForgotPasswordResult> StartForgotPasswordProcess(string enteredUsername, bool isInNetwork, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String enteredUsername
System.Boolean isInNetwork
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<ForgotPasswordResult>

UpdateConfiguration(User, UserConfiguration)

Declaration
void UpdateConfiguration(User user, UserConfiguration newConfiguration)
Parameters
Type Name Description
User user
UserConfiguration newConfiguration

UpdateConfiguration(Int64, UserConfiguration)

Updates the configuration.

Declaration
void UpdateConfiguration(long userId, UserConfiguration newConfiguration)
Parameters
Type Name Description
System.Int64 userId

The user identifier.
UserConfiguration newConfiguration

The new configuration.

UpdateUser(User)

Updates the user.

Declaration
void UpdateUser(User user)
Parameters
Type Name Description
User user

The user.
Exceptions
Type Condition
System.ArgumentNullException

user
System.ArgumentException

UpdateUser(User, Boolean)

Declaration
void UpdateUser(User user, bool triggerEvent)
Parameters
Type Name Description
User user
System.Boolean triggerEvent

UpdateUserPolicy(Int64, UserPolicy)

Updates the user policy.

Declaration
void UpdateUserPolicy(long userId, UserPolicy userPolicy)
Parameters
Type Name Description
System.Int64 userId

The user identifier.
UserPolicy userPolicy

The user policy.

Events

UserConfigurationUpdated

Declaration
event EventHandler<GenericEventArgs<User>> UserConfigurationUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserCreated

Declaration
event EventHandler<GenericEventArgs<User>> UserCreated
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserDeleted

Occurs when [user deleted].

Declaration
event EventHandler<GenericEventArgs<User>> UserDeleted
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserLockedOut

Declaration
event EventHandler<GenericEventArgs<User>> UserLockedOut
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserPasswordChanged

Declaration
event EventHandler<GenericEventArgs<User>> UserPasswordChanged
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserPolicyUpdated

Declaration
event EventHandler<GenericEventArgs<User>> UserPolicyUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

UserUpdated

Occurs when [user updated].

Declaration
event EventHandler<GenericEventArgs<User>> UserUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<User>>

Extension Methods