WorkflowUserDetails

Class

User details.

Inheritance: WorkflowUserDetailsWorkflowUser

Constructors

constructor

inherited
Class Constructor
new WorkflowUserDetails(): WorkflowUserDetails
Returns 
WorkflowUserDetails

Properties

Hide inherited properties
PropertyTypeNotes
email
inherited
string

Email.

firstName
inherited
string

First name.

fullName
inherited
string

Full name

string[]

Groups the user is a member of.

string[]

Groups the user is the owner of.

isAssignable
inherited
boolean

Indicates whether the current user has privileges to assign jobs to this user.

lastName
inherited
string

Last name.

thumbnail
inherited
string

User's avatar.

username
inherited
string

Username.

string[]

Workflow Manager privileges for the user.

string[]

Workflow Manager roles associated with the user.

email

optionalinheritedinherited
Class Property
email: string

Email.

Inherited from WorkflowUser.email

firstName

optionalinheritedinherited
Class Property
firstName: string

First name.

Inherited from WorkflowUser.firstName

fullName

inheritedinherited
Class Property
fullName: string

Full name

Inherited from WorkflowUser.fullName

groups

Class Property
groups: string[]

Groups the user is a member of.

groupsOwned

optional
Class Property
groupsOwned: string[]

Groups the user is the owner of.

isAssignable

optionalinheritedinherited
Class Property
isAssignable: boolean

Indicates whether the current user has privileges to assign jobs to this user.

lastName

optionalinheritedinherited
Class Property
lastName: string

Last name.

Inherited from WorkflowUser.lastName

thumbnail

optionalinheritedinherited
Class Property
thumbnail: string

User's avatar.

Inherited from WorkflowUser.thumbnail

username

inheritedinherited
Class Property
username: string

Username.

Inherited from WorkflowUser.username

workflowPrivileges

optional
Class Property
workflowPrivileges: string[]

Workflow Manager privileges for the user.

workflowRoles

optional
Class Property
workflowRoles: string[]

Workflow Manager roles associated with the user.

Methods

MethodReturnsNotes
hasPrivilege(privilege)
boolean

Checks if the user has the specified privilege.

boolean

Checks if the user is a Workflow Manager administrator.

hasPrivilege

Class Method
hasPrivilege(privilegeWorkflowPrivilegeType): boolean

Checks if the user has the specified privilege.

Use dark colors for code blocksCopy
1
2
3
const canCreateJobs = userDetails.hasPrivilege(WorkflowPrivilegeType.JobCreate);
const canAddUpdateAttachments = userDetails.hasPrivilege(WorkflowPrivilegeType.JobUpdateAttachments);
const canUpdateHolds = userDetails.hasPrivilege(WorkflowPrivilegeType.JobUpdateHolds);
Parameters
ParameterTypeNotes
privilege
WorkflowPrivilegeType

The privilege to check.

Returns 
boolean

Returns whether the use has the specified privilege.

isAdministrator

Class Method
isAdministrator(): boolean

Checks if the user is a Workflow Manager administrator.

A user is a Workflow Manager administrator if they have either of the AdminAdvanced or AdminBasic privileges.

Returns 
boolean

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.