Click or drag to resize

ClientSearchUsers Method

Searches users matching the specified criteria.

Namespace:  MattermostDriver
Assembly:  MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
Syntax
public List<User> SearchUsers(
	string term,
	string team_id = "",
	string not_in_team_id = "",
	string in_channel_id = "",
	string not_in_channel_id = "",
	bool allow_inactive = false,
	bool without_team = false
)

Parameters

term
Type: SystemString
The term to search for.
team_id (Optional)
Type: SystemString
(Optional) Restricts search to users in the specified team.
not_in_team_id (Optional)
Type: SystemString
(Optional) Restricts search to users not in the specified team.
in_channel_id (Optional)
Type: SystemString
(Optional) Restricts search to users in a specified channel.
not_in_channel_id (Optional)
Type: SystemString
(Optional) Restricts search to users not in a specified channel. Requires team_id.
allow_inactive (Optional)
Type: SystemBoolean
(Defaults to false) If true, deactivated users will be included in the search.
without_team (Optional)
Type: SystemBoolean
(Defaults to false) If true, only users not on a team will be included in the search. Ignores team_id, in_channel_id, and not_in_channel_id restrictions.

Return Value

Type: ListUser
A list of User objects.
See Also