Get a User Contact List
User List#
To retrieve all registered users on MirrorFly SDK use below method. User list can also be retrieved based on search key word, also this method supports pagination. This function will return the total number of pages.
warning
User presence and Profile instant update will not happen until a messege is sent to that particular user.
Request Params#
| Arguments | Description | Type | Required |
|---|---|---|---|
| SEARCH_TERM | Search term to search against the name default value is empty | String | false |
| PAGE_NUMBER | Page number to get the particular pages default value is 1 | Number | false |
| LIMIT | Limit to set the number of users per page default value is 20 | Number | false |
| META_DATA_FILTER | MetaDataFilter which filters the results by metadata default value is empty | Object | false |
Request Input for MetaDataFilter#
| Arguments | Description | Type |
|---|---|---|
| key | Name of the Key | String |
| value | Name of the value | Array of String or Boolean or Number |
Response Params#
| Arguments | Description | Type |
|---|---|---|
| statusCode | Status Code | Number |
| message | Success/Error Message | String |
| totalPages | Total pages based on the limit | Number |
| totalUsers | Total users registered to the application | Number |
| users | Array of Users Object | Array |
Check here for response format of users.
Get Registered Users#
The registered users who are all in your contacts will be retrieved using this method. The contact sync should be done in the mobile(Android/iOS) application.
warning
Profile and user presence updates will be observed to the contacts who are all in your mobile(Android/iOS) application.
Response Params#
| Arguments | Description | Type |
|---|---|---|
| statusCode | Status Code | Number |
| message | Success/Error Message | String |
| data | Array of Users Object | Array |
Check here for response format of data.
note
friendsListListener also will be triggered with the same response.