Class FluentUsers
Provides access to users in a fluent way.
Inheritance
Namespace: StylelabsStylelabs.MSdkFluentWrappers
Assembly: Stylelabs.M.Sdk.Fluent.dll
Syntax
public class FluentUsersConstructors
FluentUsers(IUsersClient, IEntitiesClient, IEntityLoadConfiguration)
Initializes a new instance of the FluentUsers class.
Declaration
public FluentUsers(IUsersClient usersClient, IEntitiesClient entitiesClient, IEntityLoadConfiguration entityLoadConfiguration)Parameters
| Type | Name | Description |
|---|---|---|
| IUsersClient | usersClient |
The IUsersClient instance. |
| IEntitiesClient | entitiesClient |
The IEntitiesClient instance. |
| IEntityLoadConfiguration | entityLoadConfiguration |
FluentUsers(IUsersClient, IEntitiesClient)
Initializes a new instance of the FluentUsers class.
Declaration
public FluentUsers(IUsersClient usersClient, IEntitiesClient entitiesClient)Parameters
| Type | Name | Description |
|---|---|---|
| IUsersClient | usersClient |
The IUsersClient instance. |
| IEntitiesClient | entitiesClient |
The IEntitiesClient instance. |
Methods
GetUser(long)
Gets the specified user FluentUser.
Declaration
public FluentUser GetUser(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
The id of the user. |
Returns
| Type | Description |
|---|---|
| FluentUser |
The user FluentUser or null when it was not found. |
GetUser(string)
Gets the specified user FluentUser.
Declaration
public FluentUser GetUser(string username)Parameters
| Type | Name | Description |
|---|---|---|
| string | username |
Username of the user. |
Returns
| Type | Description |
|---|---|
| FluentUser |
The user FluentUser or null when it was not found. |
GetUserGroup(long)
Gets the specified user group FluentEntity.
Declaration
public FluentEntity GetUserGroup(long id)Parameters
| Type | Name | Description |
|---|---|---|
| long | id |
Id of the group. |
Returns
| Type | Description |
|---|---|
| FluentEntity |
The 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
| Type | Name | Description |
|---|---|---|
| string | groupName |
Name of the group. |
Returns
| Type | Description |
|---|---|
| FluentEntity |
The user group FluentEntity or null when it was not found. |
GetUserGroups(IEnumerable<long>)
Gets the specified user group fluent entities.
Declaration
public IList<FluentEntity> GetUserGroups(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
The ids of the user groups. |
Returns
| Type | Description |
|---|---|
| IList<>FluentEntity |
The user group fluent entities. |
GetUserGroups(IEnumerable<string>)
Gets the specified user group fluent entities.
Declaration
public IList<FluentEntity> GetUserGroups(IEnumerable<string> groupNames)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | groupNames |
The names of the user groups. |
Returns
| Type | Description |
|---|---|
| IList<>FluentEntity |
The user group fluent entities. |
GetUsers(IEnumerable<long>)
Gets the specified user fluent user entities.
Declaration
public IList<FluentUser> GetUsers(IEnumerable<long> ids)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids |
The ids of the users. |
Returns
| Type | Description |
|---|---|
| IList<>FluentUser |
The user fluent user entities. |
GetUsers(IEnumerable<string>)
Gets the specified user fluent user entities.
Declaration
public IList<FluentUser> GetUsers(IEnumerable<string> usernames)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | usernames |
A list of user names. |
Returns
| Type | Description |
|---|---|
| IList<>FluentUser |
The user fluent user entities. |