@polymeshassociation/polymesh-sdk / api/entities/common/namespaces/Authorizations

Defined in: api/entities/common/namespaces/Authorizations.ts:35

Handles all Authorization related functionality

• Namespace<Parent>

• IdentityAuthorizations

Type Parameter
Parent extends Signer

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

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

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

Parameter	Type	Description
opts	{ size?: BigNumber; start?: BigNumber; status?: AuthorizationStatusEnum; type?: AuthTypeEnum; }	-
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

Promise<ResultSet<AuthorizationRequest>>

supports pagination

uses the middlewareV2

getOne(args): Promise<AuthorizationRequest>

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

Retrieve a single Authorization Request targeting this Signer by its ID

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Promise<AuthorizationRequest>

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

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

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

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

Parameter	Type	Description
opts?	{ includeExpired?: boolean; type?: AuthorizationType; }	-
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

Promise<AuthorizationRequest[]>