c4d.modules.net.UserPool¶
-
class
c4d.modules.net.
UserPool
¶ New in version R15.037.
Warning
This type cannot be instantiated.
Methods Signatures
Adds a user. |
|
Deletes a user. |
|
Checks a user’s credentials. |
|
Sets a user’s information. |
|
Sets a user’s password. |
|
Changes a user’s account type. |
|
Sets the language for a user. |
|
Changes a user’s password. |
|
Retrieves the users information from the pool. |
Methods Documentation
-
UserPool.
AddUser
(self, username, password, description, isAdmin)¶ Adds a user.
- Parameters
username (str) – The user’s name.
password (str) – The user’s password.
description (str) – The user’s description.
isAdmin (bool) – Set to True if the user to add is administrator, False otherwise.
- Return type
bool
- Returns
True if the user was successfully added, False otherwise.
-
UserPool.
DeleteUser
(self, userUuid)¶ Deletes a user.
- Parameters
userUuid (UUID) –
New in version R16.021: The user UUID.
- Return type
bool
- Returns
True if the user was successfully deleted, False otherwise.
-
UserPool.
CheckUserCredentials
(self, username, password)¶ Checks a user’s credentials.
- Parameters
username (str) – The user name.
password (str) – The user password.
- Return type
bool
- Returns
True if the user’s credentials were successfully checked, otherwise False.
-
UserPool.
EditUserInfo
(self, userUuid, description)¶ Sets a user’s information.
New in version R16.021.
- Parameters
userUuid – The user UUID.
description (str) – The new user description/information.
- Return type
bool
- Returns
True if the user’s information was successfully set, otherwise False.
-
UserPool.
EditUserPassword
(self, userUuid, password)¶ Sets a user’s password.
New in version R16.021.
- Parameters
userUuid – The user UUID.
password (str) – The new password.
- Return type
bool
- Returns
True if the user’s password was successfully set, otherwise False.
-
UserPool.
ChangeUserAccountType
(self, userUuid, isAdmin)¶ Changes a user’s account type.
New in version R16.021.
- Parameters
userUuid – The user UUID.
isAdmin (bool) – Set to True to change the user’s account type to administrator, False otherwise.
- Return type
bool
- Returns
True if the user’s account type was successfully changed, otherwise False.
-
UserPool.
ChangeLanguage
(self, userUuid, language)¶ Sets the language for a user.
New in version R16.021.
- Parameters
userUuid – The user UUID.
language (str) – The new language.
- Return type
bool
- Returns
True if the user’s password was successfully set, otherwise False.
-
UserPool.
ChangePassword
(self, userUuid, oldPassword, newPassword)¶ Changes a user’s password.
- Parameters
userUuid –
New in version R16.021: The user UUID.
oldPassword (str) – The old user’s password.
newPassword (str) – The new user’s password.
- Return type
bool
- Returns
True if the user’s password was successfully changed, otherwise False.