api.entities.common.namespaces.Authorizations.Authorizations - PolymeshAssociation/polymesh-sdk GitHub Wiki

Class: Authorizations<Parent>

api/entities/common/namespaces/Authorizations.Authorizations

Handles all Authorization related functionality

Type parameters

Name Type
Parent extends Signer

Hierarchy

Table of contents

Methods

Methods

getHistoricalAuthorizations

getHistoricalAuthorizations(opts?): Promise<ResultSet<AuthorizationRequest>>

Fetch all historical Authorization Requests for which this Signer is the target

Parameters

Name Type Description
opts Object -
opts.size? BigNumber page size
opts.start? BigNumber page offset
opts.status? AuthorizationStatusEnum fetch only authorizations with this status. Fetches all statuses if not passed
opts.type? AuthTypeEnum fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<ResultSet<AuthorizationRequest>>

Note

supports pagination

Note

uses the middlewareV2

Defined in

api/entities/common/namespaces/Authorizations.ts:150


getOne

getOne(args): Promise<AuthorizationRequest>

Retrieve a single Authorization Request targeting this Signer by its ID

Parameters

Name Type
args Object
args.id BigNumber

Returns

Promise<AuthorizationRequest>

Throws

if there is no Authorization Request with the passed ID targeting this Signer

Defined in

api/entities/common/namespaces/Authorizations.ts:80


getReceived

getReceived(opts?): Promise<AuthorizationRequest[]>

Fetch all pending Authorization Requests for which this Signer is the target

Parameters

Name Type Description
opts? Object -
opts.includeExpired? boolean whether to include expired authorizations. Defaults to true
opts.type? AuthorizationType fetch only authorizations of this type. Fetches all types if not passed

Returns

Promise<AuthorizationRequest[]>

Defined in

api/entities/common/namespaces/Authorizations.ts:42

⚠️ **GitHub.com Fallback** ⚠️