api.entities.types.CheckPermissionsResult

Interface: CheckPermissionsResult<Type>

api/entities/types.CheckPermissionsResult

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

Name	Type
Type	extends SignerType

Table of contents

Properties

• message
• missingPermissions
• result

Properties

message

• Optional message: string

optional message explaining the reason for failure in special cases

Defined in

api/entities/types.ts:737

---

missingPermissions

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

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

Defined in

api/entities/types.ts:729

---

result

• result: boolean

whether the signer complies with the required permissions or not

Defined in

api/entities/types.ts:733