User list get options
UsersListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace.
Definition
class UsersListOptions
{
UsersListOptions();
string AccountStatus { get; set; }
string ContentIds { get; set; }
string DisplayName { get; set; }
string EmailAddress { get; set; }
bool IncludeHidden { get; set; }
DateTime? JoinDate { get; set; }
DateTime? JoinDateEnd { get; set; }
DateTime? LastUpdatedUtcDate { get; set; }
int? PageIndex { get; set; }
int? PageSize { get; set; }
string Presence { get; set; }
int? RoleId { get; set; }
string SortBy { get; set; }
string SortOrder { get; set; }
string Usernames { get; set; }
}
Constructors
UsersListOptions();
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| AccountStatus | string | Used to filter by user account status. Optional Parameter | ||
| ContentIds | string | Comma separated list of ContentIds. Used to limit to a specific set of users as well as sort order if SortBy is set to ContentIdsOrder. Optional parameter | ||
| DisplayName | string | Used to limit results to only users with this display name. Optional parameter | ||
| EmailAddress | string | Used to limit to a specific user based on email address. Optional parameter | ||
| IncludeHidden | bool | By default 'hidden' users (like service accounts) will not be returned. Set IncludeHidden=true to return all users. Optional parameter | ||
| JoinDate | DateTime? | Used to limit results to just users who have joined on or after the specified date (see JoinDateEnd for end range options). Optional parameter | ||
| JoinDateEnd | DateTime? | When JoinDate is set, JoinDateEnd specifies the optional end date for the inclusive range of join dates for users to retrieve. When JoinDate is set and JoinDateEnd is not set, users with join dates equal to or greater than JoinDate are included. Optional parameter. | ||
| LastUpdatedUtcDate | DateTime? | Last updated date in the UTC. | ||
| PageIndex | int? | Specify the page number of paged results to return. Zero-based index. Optional parameter | 0 | |
| PageSize | int? | Specify the number of results to return per page. Optional parameter | 20 | |
| Presence | string | Presence. Optional paramater | Offline, Online | |
| RoleId | int? | Role Id | ||
| SortBy | string | Sort by. Optional parameter | ContentIdsOrder, DisplayName, Email, JoinedDate, LastVisitedDate, Posts, RecentPosts, Score:SCORE_ID, Username, Website | |
| SortOrder | string | Sort order. Optional parameter | Ascending, Descending | |
| Usernames | string | Used to limit to a specific set of users. Optional parameter |