1. Stylelabs.M.Sdk.Fluent.Wrappers

Class FluentUsers

Provides access to users in a fluent way.

Inheritance

object

FluentUsers

Namespace: StylelabsStylelabs.MSdkFluentWrappers

Assembly: Stylelabs.M.Sdk.Fluent.dll

Syntax

public class FluentUsers

Constructors

FluentUsers(IUsersClient, IEntitiesClient, IEntityLoadConfiguration)

Initializes a new instance of the FluentUsers class.

Declaration

public FluentUsers(IUsersClient usersClient, IEntitiesClient entitiesClient, IEntityLoadConfiguration entityLoadConfiguration)

Parameters

TypeNameDescription
IUsersClientusersClientThe IUsersClient instance.
IEntitiesCliententitiesClientThe IEntitiesClient instance.
IEntityLoadConfigurationentityLoadConfigurationThe IEntityLoadConfiguration.

FluentUsers(IUsersClient, IEntitiesClient)

Initializes a new instance of the FluentUsers class.

Declaration

public FluentUsers(IUsersClient usersClient, IEntitiesClient entitiesClient)

Parameters

TypeNameDescription
IUsersClientusersClientThe IUsersClient instance.
IEntitiesCliententitiesClientThe IEntitiesClient instance.

Methods

GetUser(long)

Gets the specified user FluentUser.

Declaration

public FluentUser GetUser(long id)

Parameters

TypeNameDescription
longidThe id of the user.

Returns

TypeDescription
FluentUserThe user FluentUser or null when it was not found.

GetUser(string)

Gets the specified user FluentUser.

Declaration

public FluentUser GetUser(string username)

Parameters

TypeNameDescription
stringusernameUsername of the user.

Returns

TypeDescription
FluentUserThe user FluentUser or null when it was not found.

GetUserGroup(long)

Gets the specified user group FluentEntity.

Declaration

public FluentEntity GetUserGroup(long id)

Parameters

TypeNameDescription
longidId of the group.

Returns

TypeDescription
FluentEntityThe user group FluentEntity or null when it was not found.

GetUserGroup(string)

Gets the specified user group FluentEntity.

Declaration

public FluentEntity GetUserGroup(string groupName)

Parameters

TypeNameDescription
stringgroupNameName of the group.

Returns

TypeDescription
FluentEntityThe user group FluentEntity or null when it was not found.

GetUserGroups(IEnumerable)

Gets the specified user group fluent entities.

Declaration

public IList<FluentEntity> GetUserGroups(IEnumerable<long> ids)

Parameters

TypeNameDescription
IEnumerable<>longidsThe ids of the user groups.

Returns

TypeDescription
IList<>FluentEntityThe user group fluent entities.

GetUserGroups(IEnumerable)

Gets the specified user group fluent entities.

Declaration

public IList<FluentEntity> GetUserGroups(IEnumerable<string> groupNames)

Parameters

TypeNameDescription
IEnumerable<>stringgroupNamesThe names of the user groups.

Returns

TypeDescription
IList<>FluentEntityThe user group fluent entities.

GetUsers(IEnumerable)

Gets the specified user fluent user entities.

Declaration

public IList<FluentUser> GetUsers(IEnumerable<long> ids)

Parameters

TypeNameDescription
IEnumerable<>longidsThe ids of the users.

Returns

TypeDescription
IList<>FluentUserThe user fluent user entities.

GetUsers(IEnumerable)

Gets the specified user fluent user entities.

Declaration

public IList<FluentUser> GetUsers(IEnumerable<string> usernames)

Parameters

TypeNameDescription
IEnumerable<>stringusernamesA list of user names.

Returns

TypeDescription
IList<>FluentUserThe user fluent user entities.
If you have suggestions for improving this article, let us know!