PermissionGroup

Represents a group of permissions for an Asset

Hierarchy

Index

Properties

Methods

Properties

asset

asset: Asset

Defined in src/api/entities/PermissionGroup.ts:19

Asset for which this group specifies permissions


Protected context

context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48


uuid

uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

Abstract exists

exists(): Promise‹boolean›

Inherited from Entity.exists

Defined in src/api/entities/Entity.ts:68

Determine whether this Entity exists on chain

Returns: Promise‹boolean›


Abstract getPermissions

getPermissions(): Promise‹GroupPermissions

Defined in src/api/entities/PermissionGroup.ts:35

Retrieve the Permissions associated with this Permission Group

Returns: Promise‹GroupPermissions


isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

NameType

entity

Entity‹unknown, unknown›

Returns: boolean


Abstract toHuman

toHuman(): unknown

Inherited from Entity.toHuman

Defined in src/api/entities/Entity.ts:73

Returns Entity data in a human readable (JSON) format

Returns: unknown


Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

NameTypeDescription

identifiers

Identifiers

Returns: string


Static isUniqueIdentifiers

isUniqueIdentifiers(identifiers: unknown): boolean

Inherited from Entity.isUniqueIdentifiers

Defined in src/api/entities/Entity.ts:42

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters:

NameTypeDescription

identifiers

unknown

object to type check

Returns: boolean


Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

NameTypeDescription

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated