Class Role

A role determines what actions allowed to be performed by users on a project.

Hierarchy (View Summary)

Endpoint
- Role

Index

Constructors

Properties

Accessors

data description name permissions

Methods

checkout delete save update

Constructors

constructor

new Role(data: any, projectId: string, httpClient: IHttpClient): Role
Parameters
- data: any
  Raw role data received from the server. For more information, see Open Cloud Projects API.
- projectId: string
  Owner project ID.
- httpClient: IHttpClient
  HTTP client instance used to send requests to the REST API server.
Returns Role
Overrides Endpoint.constructor

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

data

get data(): any
Raw role data received from the server. For more information, see Open Cloud Projects API.

Returns any

description

get description(): string
Role description.

Returns string

name

get name(): string
Role name.

Returns string

permissions

get permissions(): IRoleActions
Role actions are allowed to be performed.

Returns IRoleActions

Methods

checkout

checkout(): Promise<Role>
Reloads role data from the server.

Returns Promise<Role>

delete

delete(): Promise<any>
Deletes a role from the project.

Returns Promise<any>
Returns the raw data of a deleted role. For more information, see Open Cloud Projects API.

Overrides Endpoint.delete

save

save(): Promise<Role>
Saves role properties changes to the server. Call this method to update role data on the server after any property changes.

Returns Promise<Role>

update

update(data: any): Promise<Role>
Updates role data on the server.
Parameters
- data: any
  Raw role data. For more information, see Open Cloud Projects API.
Returns Promise<Role>