c4d.modules.net.UserPool¶

class c4d.modules.net.UserPool¶: New in version R15.037.

Warning

This type cannot be instantiated.

Overview¶

Account Settings
`UserPool.ChangeLanguage()`	Sets the language for a user.
`UserPool.ChangeUserAccountType()`	Changes a user’s account type.
`UserPool.EditUserInfo()`	Sets a user’s information.
Authentication
`UserPool.ChangePassword()`	Changes a user’s password.
`UserPool.CheckUserCredentials()`	Checks a user’s credentials.
`UserPool.EditUserPassword()`	Sets a user’s password.
User Management
`UserPool.AddUser()`	Adds a user.
`UserPool.DeleteUser()`	Deletes a user.
`UserPool.GetUsers()`	Retrieves the users information from the pool.

Members¶

Account Settings¶

UserPool.ChangeLanguage(self, userUuid, language)¶

Sets the language for a user.

New in version R16.021.

Parameters

userUuid (UUID) – The user UUID.
language (str) – The new language.

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.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.

Authentication¶

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.

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.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.

User Management¶

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 –

New in version R16.021: The user UUID.

Return type

bool

Returns

True if the user was successfully deleted, False otherwise.

UserPool.GetUsers(self)¶

Retrieves the users information from the pool.

New in version R16.021.

Return type

List[Dict[username, str, description: str, uuid: UUID, , isadmin: bool, language: str]]

Returns

The users information.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.