@acceleratxr/core_sdk / Role
Class: Role#
Describes a collection of users that all have the same role. Roles are used to grant permissions.
REQUIRES: Account Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ Role
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new Role(other?: any): Role
Overrides EntityBase.constructor
Defined in src/models/Role.ts:39
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Role
Properties#
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
description#
• description: string | null = null
Defined in src/models/Role.ts:29
A textual description of the purpose of the role and its members.
members#
• members: Array<string> = new Array()
Defined in src/models/Role.ts:34
The list of UUIDs for each user that is a member of the role.
name#
• name: string = “”
Defined in src/models/Role.ts:19
The unique name of the role.
owners#
• owners: Array<string> = new Array()
Defined in src/models/Role.ts:39
The list of UUIDs for each user that is an owner of the role. Owners can add and remove other users to and from the role.
title#
• title: string | null = null
Defined in src/models/Role.ts:24
A textual name of the role.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/Role.ts:14
Returns: string