> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-013b37f0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve Users
## Retrieve Logged In User Details
You can get the details of the logged-in user using the `getLoggedInUser()` method. This method can also be used to check if the user is logged in or not. If the method returns `nil`, it indicates that the user is not logged in and you need to log the user into CometChat SDK.
```swift theme={null}
let user = CometChat.getLoggedInUser();
```
```objc theme={null}
User *user = [CometChat getLoggedInUser];
```
This method will return a `User` object containing all the information related to the logged-in user.
## Retrieve List of Users
In order to fetch the list of users, you can use the `UsersRequest` class. To use this class i.e to create an object of the UsersRequest class, you need to use the `UsersRequestBuilder` class. The `UsersRequestBuilder` class allows you to set the parameters based on which the users are to be fetched.
The `UsersRequestBuilder` class allows you to set the below parameters:
### Set Limit
This method sets the limit i.e. the number of users that should be fetched in a single iteration.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.build()
```
### Set Search Keyword
This method allows you to set the search string based on which the users are to be fetched.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.set(searchKeyword: "abc")
.build()
```
### Search In
This method allows you to define in which user property should the searchKeyword be searched. This method only works in combination with `setSearchKeyword()`. By default the keyword is searched in both UID & Name.
```swift theme={null}
let searchKeyword = "super"
let searchIn = ["uid", "name"]
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.set(searchKeyword: searchKeyword)
..searchIn(searchIn)
.build()
```
### Set Status
The status based on which the users are to be fetched. The status parameter can contain one of the below two values:
* CometChat.UserStatus.online - will return the list of only online users.
* CometChat.UserStatus.offline - will return the list of only offline users.
If this parameter is not set, will return all the available users.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.set(status: .online)
.build()
```
### Hide Blocked Users
This method is used to determine if the blocked users should be returned as a part of the user list. if set to true, the user list will not contain the users blocked by the logged-in user.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.hideBlockedUsers(true)
.build()
```
### Set Roles
This method allows you to fetch the users based on multiple roles.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.set(roles : ["role1","role2"])
.build()
```
### Friends Only
This property when set to true will return only the friends of the logged-in user.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.friendsOnly(true)
.build();
```
### Set Tags
This method accepts a list of tags based on which the list of users is to be fetched. The list fetched will only contain the users that have been tagged with the specified tags.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.set(tags: ["tag1", "tag2"])
.build();
```
### With Tags
This property when set to true will fetch tags data along with the list of users.
```swift theme={null}
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: 30)
.withTags(true)
.build()
```
### Set UIDs
This method accepts a list of UIDs based on which the list of users is fetched. A maximum of 25 users can be fetched.
```swift theme={null}
let UIDs = ["cometchat-uid-1", "cometchat-uid-2"]
let limit = 30
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: limit)
.setUIDs(UIDs)
.build();
```
### Sort By
This method allows you to sort the User List by a specific property of User. By default the User List is sorted by `status => name => UID` . If `name` is pass to the `sortBy()` method the user list will be sorted by `name => UID`.
```swift theme={null}
let sortBy = "name"
let limit = 30
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: limit)
.sortBy(sortBy)
.build();
```
### Sort By Order
This method allows you to sort the User List in a specific order. By default the user list is sorted in ascending order.
```swift theme={null}
let limit = 30
let usersRequest = UsersRequest.UsersRequestBuilder()
.set(limit: limit)
.sortOrder(.desc)
.build();
```
Finally, once all the parameters are set to the builder class, you need to call the build() method to get the object of the UsersRequest class.
Once you have the object of the `UsersRequest` class, you need to call the `fetchNext()` method. Calling this method will return a list of `User` objects containing n number of users where n is the limit set in the builder class.
```swift theme={null}
let limit = 20;
let usersRequest = UsersRequest.UsersRequestBuilder(limit: limit).build();
usersRequest.fetchNext(onSuccess: { (users) in
for user in users {
print("User: " + user.stringValue())
}
}) { (error) in
print("User list fetching failed with error: " + error!.errorDescription);
}
```
```objc theme={null}
NSInteger limit = 30 ;
UsersRequest *userRequest = [[[UsersRequestBuilder alloc]initWithLimit:limit] build];
[userRequest fetchNextOnSuccess:^(NSArray * users) {
for (User *user in users) {
NSLog(@"User: %@ ",[user stringValue]);
}
} onError:^(CometChatException * error) {
NSLog(@"User list fetching failed with error: %@",[error errorDescription]);
}];
```
## Retrieve Particular User Details
To get the information of a user, you can use the `getUser()` method.
```swift theme={null}
let uid = "cometchat-uid-1";
CometChat.getUser(UID: uid, onSuccess: { (user) in
print("User: " + user.stringValue())
}) { (error) in
print("User fetching failed with error: " + error.errorDescription);
}
```
```objc theme={null}
NSString *UID = @"cometchat-uid-1";
[CometChat getUserWithUID:UID onSuccess:^(User * user) {
NSLog(@"User: %@",[user stringValue]);
} onError:^(CometChatException * error) {
NSLog(@"User fetching failed with error: %@",[error errorDescription]);
}];
```
The `getUser()` method takes the following parameters:
| Parameter | Description |
| --------- | ------------------------------------------------------------- |
| UID | The `UID` of the user for whom the details are to be fetched. |
On success, the You will receive a `User` objects.