Search Members

Search Channel Members

The searchMembers function in the AmityChannelParticipation class is used to search for members in a channel when mentioning. It takes the following parameters:

If no keyword is supplied, the list of users will be organized alphabetically by display name. When a keyword is provided, the list will be arranged based on search rank.

Here's an explanation of the function parameter:

displayname|keyword : A parameter accepting the string for searching

memberships: A parameter accepting an array of enum of membership status, enabling filtering members with matching one of the member status.

  • MEMBER -> active members

  • MUTED -> muted members

  • BANNED -> banned members

roles : A parameter accepting an array of roles, enabling filtering members with matching roles

includeDeleted : A parameter accepting a boolean value.

  • true -> include member whose user has been deleted

  • false -> exclude member whose user has been deleted

Last updated