api.entities.common.namespaces.Authorizations.Authorizations - PolymeshAssociation/polymesh-sdk GitHub Wiki
api/entities/common/namespaces/Authorizations.Authorizations
Handles all Authorization related functionality
Name | Type |
---|---|
Parent |
extends Signer
|
-
Namespace
<Parent
>↳
Authorizations
▸ getHistoricalAuthorizations(opts?
): Promise
<ResultSet
<AuthorizationRequest
>>
Fetch all historical Authorization Requests for which this Signer is the target
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 |
Promise
<ResultSet
<AuthorizationRequest
>>
Note
supports pagination
Note
uses the middlewareV2
api/entities/common/namespaces/Authorizations.ts:150
▸ getOne(args
): Promise
<AuthorizationRequest
>
Retrieve a single Authorization Request targeting this Signer by its ID
Name | Type |
---|---|
args |
Object |
args.id |
BigNumber |
Promise
<AuthorizationRequest
>
Throws
if there is no Authorization Request with the passed ID targeting this Signer
api/entities/common/namespaces/Authorizations.ts:80
▸ getReceived(opts?
): Promise
<AuthorizationRequest
[]>
Fetch all pending Authorization Requests for which this Signer is the target
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 |
Promise
<AuthorizationRequest
[]>