Gets a list of users based on the provided criteria.
Namespace:
MattermostDriver
Assembly:
MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
Syntaxpublic List<User> GetUsers(
int page,
int per_page,
string in_team = "",
string in_channel = "",
string not_in_channel = ""
)
Public Function GetUsers (
page As Integer,
per_page As Integer,
Optional in_team As String = "",
Optional in_channel As String = "",
Optional not_in_channel As String = ""
) As List(Of User)
public:
List<User^>^ GetUsers(
int page,
int per_page,
String^ in_team = L"",
String^ in_channel = L"",
String^ not_in_channel = L""
)
member GetUsers :
page : int *
per_page : int *
?in_team : string *
?in_channel : string *
?not_in_channel : string
(* Defaults:
let _in_team = defaultArg in_team ""
let _in_channel = defaultArg in_channel ""
let _not_in_channel = defaultArg not_in_channel ""
*)
-> List<User>
Parameters
- page
- Type: SystemInt32
The page of results to retrieve. Starts at 0. - per_page
- Type: SystemInt32
The number of results per page. - in_team (Optional)
- Type: SystemString
(Optional) Restricts search to a specific team. Cannot be used with other restrictions. - in_channel (Optional)
- Type: SystemString
(Optional) Restricts search to a specific channel. Cannot be used with other restrictions. - not_in_channel (Optional)
- Type: SystemString
(Optional) Restricts search to users not in a specific channel. Cannot be used with other restrictions.
Return Value
Type:
ListUserA list of User objects.
See Also