User
Summary
Data object defining a user.
Item Index
Methods
Methods
hasPermission
Syntax
Summary
Check if logged on user has a permission. Only applicable to logged on user.
Parameters:
-
permissionSystemPermission
Returns:
Boolean:
true if user has permission
Example:
var isAllowed = user.hasPermission(Circuit.Enums.SystemPermission.MANAGE_TENANT);Properties
avatar
Syntax
avatar
String
Summary
Fully qualified avatar URL for user's small profile picture (40x40px). Default avatar URL if user did not upload a profile picture.
avatarLarge
Syntax
avatarLarge
String
Summary
Fully qualified avatar URL for user's large profile picture (250x250px). Default avatar URL if user did not upload a profile picture.
clientId
Syntax
clientId
String
Summary
Unique identifier for this client connection. Only applicable to logged on user.
userPresenceState
Syntax
userPresenceState
Presence
Summary
Presence object (state, location, etc). Only applicable for local user. Use getPresence for other users.
userType
Syntax
userType
UserType
Summary
Type of user (e.g. GUEST, REGULAR)