AuthorizationRequest

Represents a request made by an Identity to another Identity (or account) for some sort of authorization. This has multiple uses. For example, if Alice wants to transfer ownership of her asset ALICETOKEN to Bob, an authorization request gets emitted to Bob, who then has to accept it in order for the ownership transfer to be complete

Hierarchy

Index

Properties

Methods

Properties

authId

authId: BigNumber

Defined in src/api/entities/AuthorizationRequest.ts:90

internal identifier for the request (used to accept/reject/cancel)

Protected context

context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

data

data: Authorization

Defined in src/api/entities/AuthorizationRequest.ts:79

authorization request data corresponding to type of authorization

expiry

expiry: Date | null

Defined in src/api/entities/AuthorizationRequest.ts:85

date at which the authorization request expires and can no longer be accepted. At this point, a new authorization request must be emitted. Null if the request never expires

issuer

issuer: Identity

Defined in src/api/entities/AuthorizationRequest.ts:62

Identity that emitted the request

target

target: Signer

Defined in src/api/entities/AuthorizationRequest.ts:57

Identity or Account to which the request was emitted

uuid

uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

accept

accept(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/AuthorizationRequest.ts:149

Accept the authorization request. You must be the target of the request to be able to accept it

note this method is of type ProcedureMethod, which means you can call accept.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Returns: boolean

isExpired

isExpired(): boolean

Defined in src/api/entities/AuthorizationRequest.ts:169

Returns whether the Authorization Request has expired

Returns: boolean

remove

remove(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/AuthorizationRequest.ts:162

Remove the authorization request

  • If you are the request issuer, this will cancel the authorization

  • If you are the request target, this will reject the authorization

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable

Overrides Entity.toJson

Defined in src/api/entities/AuthorizationRequest.ts:178

Return the Authorization's static data

Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Returns: Identifiers

Last updated