# 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:

The function returns a [#live-collection](https://docs.social.plus/core-concepts/live-objects-collections#live-collection "mention") of `ChannelMember` objects. You can filter search results with more than one option, such as filtering by muted and banned users. The role filter takes the role enum as an argument. 

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 statuses.

* `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 a member whose user has been deleted  
* `false` -> exclude member whose user has been deleted

{% tabs %}
{% tab title="iOS" %}
{% embed url="<https://gist.github.com/amythee/a383044414f51aabdf7ccc3914c96295>" %}
{% endtab %}

{% tab title="Android" %}
{% embed url="<https://gist.github.com/amythee/8b6c5700af831618cc5cb54f177c002e>" %}
{% endtab %}

{% tab title="JavaScript" %}
Supported ✅ (please wait while we prepare a real example!)
{% endtab %}

{% tab title="TypeScript" %}
{% embed url="<https://gist.github.com/amythee/d42191da396cfa37ddb51586ccc03edb>" %}
{% endtab %}

{% tab title="Flutter" %}
{% embed url="<https://gist.github.com/amythee/c1476d8cc7e4a698c49460440b483151#file-amitychannelmembersearch-dart>" %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.social.plus/social-plus-sdk/chat/channels/search-members.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.