public RILResponse <UserList> RetreiveUserList(UserListOptions options = null)
{
RestRequest request = new RestRequest(Methods.RetreiveUserList);
if (options != null)
{
request.AddDesrelializedObject(options);
}
return(Execute <UserList>(request));
}
/// <summary>
/// Get the paginated list of accounts for current org using 2.x API.
/// </summary>
/// <returns></returns>
public async Task <PagedResponse <UserType> > GetUsersPaginated(UserListOptions filteringOptions = null, IPageableRequest pagingOptions = null)
{
var response = await _apiClient.GetAsync <UsersResponseCollection>(
ApiUris.ListUsers(_apiClient.OrganizationId),
pagingOptions,
filteringOptions);
return(new PagedResponse <UserType>
{
items = response.user,
totalCount = response.totalCountSpecified ? response.totalCount : (int?)null,
pageCount = response.pageCountSpecified ? response.pageCount : (int?)null,
pageNumber = response.pageNumberSpecified ? response.pageNumber : (int?)null,
pageSize = response.pageSizeSpecified ? response.pageSize : (int?)null
});
}
/// <summary>
/// Returns a collection of <see cref="Altask.Data.Model.User"/> objects matching the specified filter.
/// </summary>
/// <param name="filter">A <see cref="Altask.www.Models.UserListOptions"/> object on which to filter.</param>
/// <returns>Returns a <see cref="Altask.Data.EntityResult"/> indicating success or failure.</returns>
public virtual async Task <ActionResult> List(UserListOptions filter)
{
ThrowIfDisposed();
if (filter == null)
{
filter = new UserListOptions();
}
var dtoUsers = new List <Altask.Data.Dto.User>();
var user = await Context.Users.AsNoTracking().Where(filter.GetPredicate())
.Include(e => e.Roles)
.ToListAsync();
foreach (var item in user)
{
dtoUsers.Add(item.ToDto());
}
return(Ok(new { users = dtoUsers }, JsonRequestBehavior.AllowGet));
}
public void RetreiveUserList()
{
RILResponse <UserList> response = Api.RetreiveUserList();
Assert.AreEqual(response.Status, Status.Success);
Assert.IsNotNull(response.Data);
UserListOptions options = new UserListOptions
{
Count = 3,
Format = Format.Json,
Page = 1,
RetreiveType = RetreiveType.MyApp,
RetrieveTags = RetrieveTags.Yes,
State = State.All,
Since = DateTime.Now.AddDays(-5)
};
response = Api.RetreiveUserList(options);
Assert.AreEqual(response.Status, Status.Success);
Assert.IsNotNull(response.Data);
Assert.AreEqual(response.Data.List.Count, 3);
}
public async Task Examples(SDK sdk)
{
var userId = "user-1";
// an example: create an entity
var newUser = new User
{
Email = "*****@*****.**"
};
await sdk
.Foundation()
.UserRepository()
.Create(newUser);
// end of example
// an example: read an entity
var userOne = await sdk
.Foundation()
.UserRepository()
.Read(userId);
Console.WriteLine($"User email address: {userOne.Email}");
// end of example
// an example: update an entity
var userTwo = await sdk
.Foundation()
.UserRepository()
.Read(userId);
userTwo.FullName = "CSharp SDK User";
await sdk
.Foundation()
.UserRepository()
.Update(userTwo.Id, userTwo);
// end of example
// an example: delete an entity
var userThree = await sdk
.Foundation()
.UserRepository()
.Read(userId);
await sdk
.Foundation()
.UserRepository()
.Delete(userThree.Id);
// end of example
// an example: list entities
var options = new UserListOptions
{
Order = "ASC",
PageSize = 5,
MaxResults = 10,
Include = "total_count"
};
var userList = sdk
.Foundation()
.UserRepository()
.List(options);
foreach (var user in userList)
{
Console.WriteLine($"{user.FullName}: ({user.Id}): {user.Email}");
}
// end of example
// an example: list entities with filters
var userOptions = new UserListOptions()
.EmailEqualTo("*****@*****.**")
.StatusIn(UserStatus.ACTIVE, UserStatus.ENROLLING);
userList = sdk
.Foundation()
.UserRepository()
.List(userOptions);
foreach (var user in userList)
{
Console.WriteLine($"{user.FullName}: ({user.Id}): {user.Email}");
}
// end of example
// an example: read first entity in list
var firstUserInList = sdk
.Foundation()
.UserRepository()
.List()
.FirstOrDefault();
Console.WriteLine($"User email address: {firstUserInList.Email}");
// end of example
}
