Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • checkPermissions
  • enabledAt
  • enabledAtV2
  • get
  • getGroup
  • getOperationHistory
  • getOperationHistoryV2
  • hasPermissions
  • setGroup
  • waive

Was this helpful?

  1. Classes

AssetPermissions

PreviousAssetHoldersNextAssets

Last updated 2 years ago

Was this helpful?

Handles all Asset Permissions (External Agents) related functionality on the Identity side

Hierarchy

  • Namespace‹›

    ↳ AssetPermissions

Index

Properties

Methods

Properties

Protected context

• context: Context

Inherited from void


Protected parent

Inherited from void

Methods

checkPermissions

Check whether this Identity has specific transaction Permissions over an Asset

Parameters:

â–ª args: object

Name
Type

asset

transactions

TxTag[] | null


enabledAt

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this Identity was enabled/added as an Agent with permissions over a specific Asset

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Parameters:

â–ª __namedParameters: object

Name
Type

asset


enabledAtV2

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this Identity was enabled/added as an Agent with permissions over a specific Asset

note uses the middlewareV2

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Parameters:

â–ª __namedParameters: object

Name
Type

asset


get

Retrieve all the Assets over which this Identity has permissions, with the corresponding Permission Group


getGroup

Retrieve this Identity's Permission Group for a specific Asset

Parameters:

â–ª __namedParameters: object

Name
Type

asset


getOperationHistory

Retrieve all Events triggered by Operations this Identity has performed on a specific Asset

note uses the middleware

note supports pagination

Parameters:

â–ª opts: object

Name
Type
Description

asset

-

eventId?

EventId

filters results by event

moduleId?

ModuleId

filters results by module

size?

BigNumber

page size

start?

BigNumber

page offset


getOperationHistoryV2

Retrieve all Events triggered by Operations this Identity has performed on a specific Asset

note uses the middlewareV2

note supports pagination

Parameters:

â–ª opts: object

Name
Type
Description

asset

-

eventId?

EventId

filters results by event

moduleId?

ModuleId

filters results by module

size?

BigNumber

page size

start?

BigNumber

page offset


hasPermissions

▸ hasPermissions(args: object): Promise‹boolean›

Check whether this Identity has specific transaction Permissions over an Asset

deprecated in favor of checkPermissions

Parameters:

â–ª args: object

Name
Type

asset

transactions

TxTag[] | null

Returns: Promise‹boolean›


setGroup

Assign this Identity to a different Permission Group for a given Asset

Parameters:

Name
Type

args

opts?


waive

Abdicate from the current Permissions Group for a given Asset. This means that this Identity will no longer have any permissions over said Asset

Parameters:

Name
Type

args

opts?

Defined in

• parent:

Defined in

▸ checkPermissions(args: object): Promise‹‹››

Defined in

| string

Returns: Promise‹‹››

▸ enabledAt(__namedParameters: object): Promise‹ | null›

Defined in

string | ‹›

Returns: Promise‹ | null›

▸ enabledAtV2(__namedParameters: object): Promise‹ | null›

Defined in

string | ‹›

Returns: Promise‹ | null›

▸ get(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getGroup(__namedParameters: object): Promise‹ | ›

Defined in

string | ‹›

Returns: Promise‹ | ›

▸ getOperationHistory(opts: object): Promise‹‹››

Defined in

string |

Returns: Promise‹‹››

▸ getOperationHistoryV2(opts: object): Promise‹‹››

Defined in

string |

Returns: Promise‹‹››

Defined in

| string

▸ setGroup(args: , opts?: ): Promise‹‹ | ››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹ | ››

▸ waive(args: , opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹void››

src/api/entities/Namespace.ts:11
Identity
src/api/entities/Namespace.ts:9
CheckPermissionsResult
Identity
src/api/entities/Identity/AssetPermissions.ts:136
CheckPermissionsResult
Identity
EventIdentifier
src/api/entities/Identity/AssetPermissions.ts:340
EventIdentifier
EventIdentifier
src/api/entities/Identity/AssetPermissions.ts:365
EventIdentifier
AssetWithGroup
src/api/entities/Identity/AssetPermissions.ts:107
AssetWithGroup
CustomPermissionGroup
KnownPermissionGroup
src/api/entities/Identity/AssetPermissions.ts:300
CustomPermissionGroup
KnownPermissionGroup
ResultSet
EventIdentifier
src/api/entities/Identity/AssetPermissions.ts:415
ResultSet
EventIdentifier
ResultSet
EventIdentifier
src/api/entities/Identity/AssetPermissions.ts:500
ResultSet
EventIdentifier
src/api/entities/Identity/AssetPermissions.ts:288
SetPermissionGroupParams
ProcedureOpts
TransactionQueue
CustomPermissionGroup
KnownPermissionGroup
src/api/entities/Identity/AssetPermissions.ts:400
ProcedureMethod
setGroup.checkAuthorization
TransactionQueue
CustomPermissionGroup
KnownPermissionGroup
WaivePermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/AssetPermissions.ts:390
ProcedureMethod
waive.checkAuthorization
TransactionQueue
Identity
context
parent
checkPermissions
enabledAt
enabledAtV2
get
getGroup
getOperationHistory
getOperationHistoryV2
hasPermissions
setGroup
waive
Asset
Asset
Asset
Asset
Asset
Asset
Asset
SetPermissionGroupParams
ProcedureOpts
WaivePermissionsParams
ProcedureOpts