-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.CustomPermissionGroup.CustomPermissionGroup
api/entities/CustomPermissionGroup.CustomPermissionGroup
Represents a group of custom permissions for an Asset
-
↳
CustomPermissionGroup
• asset: BaseAsset
Asset for which this group specifies permissions
api/entities/PermissionGroup.ts:19
• id: BigNumber
api/entities/CustomPermissionGroup.ts:43
• uuid: string
▸ exists(): Promise
<boolean
>
Determine whether this Custom Permission Group exists on chain
Promise
<boolean
>
api/entities/CustomPermissionGroup.ts:108
▸ getPermissions(): Promise
<GroupPermissions
>
Retrieve the list of permissions and transaction groups associated with this Permission Group
Promise
<GroupPermissions
>
PermissionGroup.getPermissions
api/entities/CustomPermissionGroup.ts:74
▸ isEqual(entity
): boolean
Determine whether this Entity is the same as another one
Name | Type |
---|---|
entity |
Entity <unknown , unknown > |
boolean
▸ setPermissions(args
, opts?
): Promise
<GenericPolymeshTransaction
<void
, void
>>
Modify the group's permissions
Name | Type |
---|---|
args |
SetGroupPermissionsParams |
opts? |
ProcedureOpts |
Promise
<GenericPolymeshTransaction
<void
, void
>>
Note
this method is of type ProcedureMethod, which means you can call setPermissions.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
api/entities/CustomPermissionGroup.ts:67
▸ toHuman(): HumanReadable
Return the Group's static data
api/entities/CustomPermissionGroup.ts:122
▸ Static
generateUuid<Identifiers
>(identifiers
): string
Generate the Entity's UUID from its identifying properties
Name |
---|
Identifiers |
Name | Type |
---|---|
identifiers |
Identifiers |
string
▸ Static
unserialize<Identifiers
>(serialized
): Identifiers
Unserialize a UUID into its Unique Identifiers
Name |
---|
Identifiers |
Name | Type | Description |
---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types