ApprovalQueue
Defined in: approvals.ts:106
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ApprovalQueue(
window,newId?,options?):ApprovalQueue
Defined in: approvals.ts:112
Parameters
Section titled “Parameters”window
Section titled “window”newId?
Section titled “newId?”() => string
options?
Section titled “options?”ApprovalQueueOptions = {}
Returns
Section titled “Returns”ApprovalQueue
Accessors
Section titled “Accessors”current
Section titled “current”Get Signature
Section titled “Get Signature”get current():
ApprovalRequest<unknown> |null
Defined in: approvals.ts:155
The request currently shown (the window asks for it by id on load).
Returns
Section titled “Returns”ApprovalRequest<unknown> | null
queued
Section titled “queued”Get Signature
Section titled “Get Signature”get queued():
number
Defined in: approvals.ts:159
Returns
Section titled “Returns”number
Methods
Section titled “Methods”decline()
Section titled “decline()”decline(
requestId,error?):boolean
Defined in: approvals.ts:167
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
error?
Section titled “error?”Error = ...
Returns
Section titled “Returns”boolean
declineAll()
Section titled “declineAll()”declineAll(
error?):void
Defined in: approvals.ts:172
Lock, disconnect, shutdown: everything pending is declined.
Parameters
Section titled “Parameters”error?
Section titled “error?”Error = ...
Returns
Section titled “Returns”void
onChange()
Section titled “onChange()”onChange(
listener): () =>void
Defined in: approvals.ts:180
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”() => void
pendingFor()
Section titled “pendingFor()”pendingFor(
origin):number
Defined in: approvals.ts:150
Requests waiting for origin (current + queued).
Parameters
Section titled “Parameters”origin
Section titled “origin”string
Returns
Section titled “Returns”number
request()
Section titled “request()”request<
T>(input):Promise<T>
Defined in: approvals.ts:117
Enqueue and wait for the user’s answer. Refuses (never queues) past the per-origin limits.
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”Omit<ApprovalRequest, "id" | "createdAt" | "originWarnings" | "via">
Returns
Section titled “Returns”Promise<T>
resolve()
Section titled “resolve()”resolve(
requestId,value):boolean
Defined in: approvals.ts:163
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
unknown
Returns
Section titled “Returns”boolean
setVia()
Section titled “setVia()”setVia(
origin,via):void
Defined in: approvals.ts:139
Attach (or clear) the transport note every later request from origin carries.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
OriginVia | null
Returns
Section titled “Returns”void
viaFor()
Section titled “viaFor()”viaFor(
origin):OriginVia|undefined
Defined in: approvals.ts:145
The transport note later requests from origin carry (WalletConnect Verify’s verdict for wc:<topic>), if any.
Parameters
Section titled “Parameters”origin
Section titled “origin”string
Returns
Section titled “Returns”OriginVia | undefined