KnownPermissionGroup

Represents a pre-defined group of permissions for a Security Token

Hierarchy

↳ PermissionGroup

↳ KnownPermissionGroup

Index

Properties

Methods

Properties

Protected context

• context: Context

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

ticker

• ticker: string

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

type

• type: PermissionGroupType

Defined in src/api/entities/KnownPermissionGroup.ts:30

uuid

• uuid: string

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

Methods

exists

▸ exists(): Promise‹boolean›

Defined in src/api/entities/KnownPermissionGroup.ts:90

Determine whether this Known Permission Group exists on chain

Returns: Promise‹boolean›

getPermissions

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

Retrieve the Permissions associated with this Permission Group

isEqual

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

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

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Entity‹unknown, unknown›

Returns: boolean

toJson

â–¸ toJson(): HumanReadable

Defined in src/api/entities/KnownPermissionGroup.ts:97

Return the KnownPermissionGroup's static data

Returns: HumanReadable

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated

Was this helpful?