Filter Users By MetaData

To retrieve all users by metaData 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.

await SDK.getUsersList(`SEARCH_TERM`, `PAGE_NUMBER`, `LIMIT`, `META_DATA_FILTER`);

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

Sample Format for MetaDataFilter#

{
  metaDataKey : "",
  metaDataValues: []
}

Request Input for MetaDataKey#

Arguments	Description	Type
metaDataKey	Name of the Key	String
value	Name of the value	String

Request Input for MetaDataValues#

Arguments	Description	Type
metaDataValues	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

Response Format:#

data: [
  {
    name: "", // String - Name of the User
    image: "", // String - Profile Image of the User
    thumbImage: "", // String - Profile ThumbImage of the User
    email: "", // String - User Email
    status: "", // String - User Status
    userJid: "", // String - Jid of the User
    userId: "", // String - User Id
    nickName: "", // String -  Nick Name of the User
    mobileNumber: "", // String - User Mobile Number
    isAdminBlocked: false, // Boolean - To denote whether admin blocked this account or not
  },
  //...
];