Class UserClientBase

Current version: 3.4

Client for fetching user entities and user related actions.

Inheritance
object
UserClientBase
Implements
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public abstract class UserClientBase : IUsersClient

Constructors

UserClientBase(IMClient)

Initializes a new instance of the UserClientBase class.

Declaration
RequestResponse
public UserClientBase(IMClient client)
Parameters
TypeNameDescription
IMClientclient

The IMClient.

Properties

MClient

Gets the client.

Declaration
RequestResponse
protected IMClient MClient { get; }
Property Value
TypeDescription
IMClient

Methods

GetUserAsync(long, IEntityLoadConfiguration)

Gets the specified user entity.

Declaration
RequestResponse
public virtual Task<IEntity> GetUserAsync(long id, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
longid

The id of the user.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IEntity

The user entity or null when it was not found.

GetUserAsync(string, IEntityLoadConfiguration)

Gets the specified user entity.

Declaration
RequestResponse
public virtual Task<IEntity> GetUserAsync(string username, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
stringusername

Username of the user.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IEntity

The user or null when it was not found.

GetUserGroupAsync(long, IEntityLoadConfiguration)

Gets the specified user group entity.

Declaration
RequestResponse
public virtual Task<IEntity> GetUserGroupAsync(long id, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
longid

Id of the user.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IEntity

The user or null when it was not found.

GetUserGroupAsync(string, IEntityLoadConfiguration)

Gets the user group by the specified name.

Declaration
RequestResponse
public virtual Task<IEntity> GetUserGroupAsync(string groupName, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
stringgroupName

Name of the group.

IEntityLoadConfigurationloadConfiguration

The loading configuration.

Returns
TypeDescription
Task<>IEntity

The user group entity or null when it was not found.

GetUserGroupIdAsync(string)

Gets the ids of the specified user groups by name.

Declaration
RequestResponse
public virtual Task<long?> GetUserGroupIdAsync(string groupName)
Parameters
TypeNameDescription
stringgroupName

The groupName name.

Returns
TypeDescription
Task<>long

The group's id or null when it was not found.

GetUserGroupIdsAsync(IEnumerable<string>)

Gets the ids of the specified user groups by name.

Declaration
RequestResponse
public virtual Task<IDictionary<string, long>> GetUserGroupIdsAsync(IEnumerable<string> groupNames)
Parameters
TypeNameDescription
IEnumerable<>stringgroupNames

A list of group names.

Returns
TypeDescription
Task<>IDictionary<, >stringlong

Non null, case-insensitive dictionary that maps the user group names to ids. Users that don't exist, will not be in the result.

GetUserGroupNameAsync(long)

Gets the name of the specified user group.

Declaration
RequestResponse
public virtual Task<string> GetUserGroupNameAsync(long id)
Parameters
TypeNameDescription
longid

The id of the user group.

Returns
TypeDescription
Task<>string

The group name or null when it was not found.

GetUserGroupNamesAsync(IEnumerable<long>)

Gets the name of the specified user groups.

Declaration
RequestResponse
public virtual Task<IDictionary<long, string>> GetUserGroupNamesAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids of user groups.

Returns
TypeDescription
Task<>IDictionary<, >longstring

Non null dictionary that maps the user group ids to user group names. Users that don't exist, will not be in the result.

GetUserGroupsAsync(IEnumerable<long>, IEntityLoadConfiguration)

Gets the specified user group entities.

Declaration
RequestResponse
public virtual Task<IList<IEntity>> GetUserGroupsAsync(IEnumerable<long> ids, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids of the user groups.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IList<>IEntity

The user group entities. Can contain null when a user group was not found.

GetUserGroupsAsync(IEnumerable<string>, IEntityLoadConfiguration)

Gets the specified user group entities.

Declaration
RequestResponse
public virtual Task<IList<IEntity>> GetUserGroupsAsync(IEnumerable<string> groupNames, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
IEnumerable<>stringgroupNames

The names of the user groups.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IList<>IEntity

The user group entities. Can contain null when a user group was not found.

GetUserIdAsync(string)

Gets the id of the specified user by username.

Declaration
RequestResponse
public virtual Task<long?> GetUserIdAsync(string username)
Parameters
TypeNameDescription
stringusername

The user name.

Returns
TypeDescription
Task<>long

The user's id or null when it was not found.

GetUserIdsAsync(IEnumerable<string>)

Gets the ids of the specified users by username.

Declaration
RequestResponse
public virtual Task<IDictionary<string, long>> GetUserIdsAsync(IEnumerable<string> usernames)
Parameters
TypeNameDescription
IEnumerable<>stringusernames

A list of user names.

Returns
TypeDescription
Task<>IDictionary<, >stringlong

Non null, case-insensitive dictionary that maps the user names to ids. Users that don't exist, will not be in the result.

GetUsernameAsync(long)

Gets the username of the specified user.

Declaration
RequestResponse
public virtual Task<string> GetUsernameAsync(long id)
Parameters
TypeNameDescription
longid

The id of the user.

Returns
TypeDescription
Task<>string

The username or null when it was not found.

GetUsernamesAsync(IEnumerable<long>)

Gets the usernames of the specified users.

Declaration
RequestResponse
public virtual Task<IDictionary<long, string>> GetUsernamesAsync(IEnumerable<long> ids)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids of the entities to get.

Returns
TypeDescription
Task<>IDictionary<, >longstring

Non null dictionary that maps the user ids to usernames. Users that don't exist, will not be in the result.

GetUsersAsync(IEnumerable<long>, IEntityLoadConfiguration)

Gets the specified user entities.

Declaration
RequestResponse
public virtual Task<IList<IEntity>> GetUsersAsync(IEnumerable<long> ids, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
IEnumerable<>longids

The ids of the users.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IList<>IEntity

The user entities. Can contain null when a user was not found.

GetUsersAsync(IEnumerable<string>, IEntityLoadConfiguration)

Gets the specified user entities.

Declaration
RequestResponse
public virtual Task<IList<IEntity>> GetUsersAsync(IEnumerable<string> usernames, IEntityLoadConfiguration loadConfiguration = null)
Parameters
TypeNameDescription
IEnumerable<>stringusernames

A list of user names.

IEntityLoadConfigurationloadConfiguration

The load configuration.

Returns
TypeDescription
Task<>IList<>IEntity

The user entities. Can contain null when a user was not found.

ResetPasswordAsync(long)

Resets the password of the specified user. This sends an e-mail to the specified user with a link to choose a new password.

Declaration
RequestResponse
public abstract Task ResetPasswordAsync(long id)
Parameters
TypeNameDescription
longid

Id of the user.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ForbiddenException

When the current user is not a superuser.

SetPasswordAsync(long, string)

Changes the password of the specified user.

Declaration
RequestResponse
public abstract Task SetPasswordAsync(long id, string password)
Parameters
TypeNameDescription
longid

The user id to change the password on.

stringpassword

The password to reset.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ForbiddenException

When the current user is not a superuser.

Implements

Do you have some feedback for us?

If you have suggestions for improving this article,