import Role from 'clinical6/src/helpers/user/Role.js'

public class | source

Role

Mixin Extends:

RoleModel, Helper

Helper class representing a user role.

Test:

Static Member Summary

Static Public Members
public static get	type: String

Method Summary

Public Methods
public	getInvitableRoles(): Promise<Role> Gets the invitable user roles of the user role.
public	getPermissions(): Promise<Permission> Gets the role permissions.
public	save(): Promise<Role> Saves a role (insert if id doesn't exist, update if it does)

Inherited Summary

From class RoleModel
public	canViewPii: Boolean
public	description: Boolean
public	id: Number
public	isAdmin: Boolean
public	isDefault: Boolean
public	isMobile: Boolean
public	isSuper: Boolean
public	name: String
public	permanentLink: String

Static Public Members

public static get type: String source

Public Methods

public getInvitableRoles(): Promise<Role> source

Gets the invitable user roles of the user role.

Return:

Promise<Role>

Returns a promise via ajax call.

Example:

import { Role, roleService } from 'clinical6';

const role = new Role({...});

// Grab the invitable roles
role.getInvitableRoles();

Test:

[unit] Role.getInvitableRoles should successfully get the invitable user roles

public getPermissions(): Promise<Permission> source

Gets the role permissions.

Return:

Promise<Permission>

Returns a promise via ajax call.

Example:

import { Role, roleService } from 'clinical6';

const role = new Role({...});

// Grab the role permissions
role.getPermissions();

Test:

[unit] Role.getPermissions should successfully get the role permissions

public save(): Promise<Role> source

Saves a role (insert if id doesn't exist, update if it does)

Return:

Promise<Role>

Returns a promise via ajax call.

Example:

import { Role, roleService } from 'clinical6';

// Inserts new role (no existing id)
const role = new Role({
  "type": "user_roles",
  "attributes": {
      "permanent_link": "dummy_3669",
      "name": "et"
  }
});
role.save();

// Updates existing role(has existing id)
roleService.get().then(roles => roles[0].save());