ClientUpdateUser Method (String, String, String, String, String, String, String, String) |
Partially updates a user based on provided information.
Namespace:
MattermostDriver
Assembly:
MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
Syntaxpublic User UpdateUser(
string user_id,
string username = "",
string nickname = "",
string first_name = "",
string last_name = "",
string position = "",
string email = "",
string locale = ""
)
Public Function UpdateUser (
user_id As String,
Optional username As String = "",
Optional nickname As String = "",
Optional first_name As String = "",
Optional last_name As String = "",
Optional position As String = "",
Optional email As String = "",
Optional locale As String = ""
) As User
public:
User^ UpdateUser(
String^ user_id,
String^ username = L"",
String^ nickname = L"",
String^ first_name = L"",
String^ last_name = L"",
String^ position = L"",
String^ email = L"",
String^ locale = L""
)
member UpdateUser :
user_id : string *
?username : string *
?nickname : string *
?first_name : string *
?last_name : string *
?position : string *
?email : string *
?locale : string
(* Defaults:
let _username = defaultArg username ""
let _nickname = defaultArg nickname ""
let _first_name = defaultArg first_name ""
let _last_name = defaultArg last_name ""
let _position = defaultArg position ""
let _email = defaultArg email ""
let _locale = defaultArg locale ""
*)
-> User
Parameters
- user_id
- Type: SystemString
The user ID. - username (Optional)
- Type: SystemString
(Optional) The user's new username. - nickname (Optional)
- Type: SystemString
(Optional) The user's new nickname. - first_name (Optional)
- Type: SystemString
(Optional) The user's new first name. - last_name (Optional)
- Type: SystemString
(Optional) The user's new last name. - position (Optional)
- Type: SystemString
(Optional) The user's new position. - email (Optional)
- Type: SystemString
(Optional) The user's new email. - locale (Optional)
- Type: SystemString
(Optional) The user's new locale.
Return Value
Type:
UserThe updated User object.
See Also