Grants read-only access to learning content to any member of a group carrying this role. The role is context-less in that its appliesTo checks do not depend on organisation or repository scope; instead, access to a specific course or module is gated by whether the group holds a Program/Group enrolement covering that content, which is checked here.

Implements: Role


Properties

PropertyReturnsDescription
categoryStringCategory this role is grouped under when roles are presented for assignment.
descriptionStringHuman-readable description of what this role grants, shown wherever roles are listed for assignment.
nameStringRegistered name of this role, used as the lookup key when granting it to a group.

Inherited from Role

Methods

canConnectToOrganisation()

Returns: boolean

Convenience method for callers, such as Velocity templates, which just need to know if this role can be assigned within an organisation context, without dealing with the TargetType enum directly.

canConnectToRepository()

Returns: boolean

Convenience method for callers, such as Velocity templates, which just need to know if this role can be assigned within a repository (or website) context, without dealing with the TargetType enum directly.


Methods

getName()

Returns: String

Registered name of this role, used as the lookup key when granting it to a group.

getDescription()

Returns: String

Human-readable description of what this role grants, shown wherever roles are listed for assignment.

getCategory()

Returns: String

Category this role is grouped under when roles are presented for assignment.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.