RamUser

The class representing users.

Inherits: RamObject

Static Methods

Method Arguments Description
fromDict
RamUser
dict or object: stepDict Builds a RamUser from a dict or object like the one returned by the RamDaemonInterface

Methods

Method Arguments Description
constructor string: userName,
string: userShortName,
string: userFolderPath="",
UserRole: role=UserRole.STANDARD
comment
string
A comment associated to the user
configPath
string
The path to the Config folder for this user
folderPath
string
The path to the user folder
role
UserRole
One of UserRole.ADMIN, UserRole.PROJECT_ADMIN, UserRole.LEAD or UserRole.STANDARD

API Dev notes

Note

These section is for the development of the API only; you should not need these when developping your add-on using the API.

(Im)mutable data

The data returned by the methods can be either mutable or immutable.

Method Type of the returned data
comment Immutable
configPath Immutable
folderPath Immutable
role Immutable

META