Interface: CheckPermissionsResult<Type>

Defined in: src/api/entities/types.ts:722

Result of a checkPermissions call. If Type is Account, represents whether the Account has all the necessary secondary key Permissions. If Type is Identity, represents whether the Identity has all the necessary external agent Permissions

Type Parameters

Type Parameter
Type extends SignerType

Properties

message?

optional message: string

Defined in: src/api/entities/types.ts:734

optional message explaining the reason for failure in special cases

---

missingPermissions?

optional missingPermissions: Type extends Account ? SimplePermissions : null | TxTag[]

Defined in: src/api/entities/types.ts:726

required permissions which the signer DOESN'T have. Only present if result is false

---

result

result: boolean

Defined in: src/api/entities/types.ts:730

whether the signer complies with the required permissions or not