Class User

Hierarchy

User

Implements

UserLike
Patchable<UserLike>

Index

Constructors

constructor

Accessors

Methods

prompt

Constructors

constructor

new User(_context: Context, _id: Guid): User

- Defined in src/user/user.ts:85
PUBLIC METHODS

Parameters
- _context: Context
- _id: Guid
Returns User

Accessors

context

get context(): Context

- Defined in src/user/user.ts:42
Returns Context

grantedPermissions

get grantedPermissions(): Permissions[]

- Defined in src/user/user.ts:85
An array of values from the Permissions enum. These indicate permissions that this user has granted, either implicitly or explicitly.

inheritdoc

Returns Permissions[]

groups

get groups(): GroupMask
set groups(val: GroupMask): void

- Defined in src/user/user.ts:50
This user's group memberships. Some actors will behave differently depending on if the user is in at least one of a set of groups. See GroupMask.

Returns GroupMask
- Defined in src/user/user.ts:58
This user's group memberships. Some actors will behave differently depending on if the user is in at least one of a set of groups. See GroupMask.

Parameters
- val: GroupMask
Returns void

hasGrantedPermissions

get hasGrantedPermissions(): boolean

- Defined in src/user/user.ts:80
returnes true if has any stored permissions

Returns boolean

id

get id(): Guid

- Defined in src/user/user.ts:43
Returns Guid

name

get name(): string

- Defined in src/user/user.ts:44
Returns string

properties

get properties(): {}

- Defined in src/user/user.ts:75
A grab bag of miscellaneous, possibly host-dependent, properties.

Returns {}

Methods

prompt

prompt(text: string, acceptInput?: boolean): Promise<DialogResponse>

- Defined in src/user/user.ts:100
Present the user with a modal dialog, and resolve with the response.

Parameters
- text: string
  
  A message presented to the user.
- Default value acceptInput: boolean = false
  
  Whether or not the dialog should include a text input field.
Returns Promise<DialogResponse>