Searches users matching the specified criteria.
Namespace:
MattermostDriver
Assembly:
MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
Syntaxpublic 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
)
Public Function SearchUsers (
term As String,
Optional team_id As String = "",
Optional not_in_team_id As String = "",
Optional in_channel_id As String = "",
Optional not_in_channel_id As String = "",
Optional allow_inactive As Boolean = false,
Optional without_team As Boolean = false
) As List(Of User)
public:
List<User^>^ SearchUsers(
String^ term,
String^ team_id = L"",
String^ not_in_team_id = L"",
String^ in_channel_id = L"",
String^ not_in_channel_id = L"",
bool allow_inactive = false,
bool without_team = false
)
member SearchUsers :
term : string *
?team_id : string *
?not_in_team_id : string *
?in_channel_id : string *
?not_in_channel_id : string *
?allow_inactive : bool *
?without_team : bool
(* Defaults:
let _team_id = defaultArg team_id ""
let _not_in_team_id = defaultArg not_in_team_id ""
let _in_channel_id = defaultArg in_channel_id ""
let _not_in_channel_id = defaultArg not_in_channel_id ""
let _allow_inactive = defaultArg allow_inactive false
let _without_team = defaultArg without_team false
*)
-> List<User>
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:
ListUserA list of User objects.
See Also