NotificationProgressHandle
Class: NotificationProgressHandle
Section titled “Class: NotificationProgressHandle”Defined in: notifications.ts:130
Mutable handle returned for a running progress item.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NotificationProgressHandle(
manager,options):NotificationProgressHandle
Defined in: notifications.ts:137
Parameters
Section titled “Parameters”manager
Section titled “manager”options
Section titled “options”Returns
Section titled “Returns”NotificationProgressHandle
Properties
Section titled “Properties”
readonlyid:string
Defined in: notifications.ts:131
signal
Section titled “signal”
readonlysignal:AbortSignal
Defined in: notifications.ts:132
Implementation of
Section titled “Implementation of”NotificationProgressToken.signal
Accessors
Section titled “Accessors”currentSnapshot
Section titled “currentSnapshot”Get Signature
Section titled “Get Signature”get currentSnapshot():
NotificationProgressSnapshot
Defined in: notifications.ts:164
Returns
Section titled “Returns”isCancellationRequested
Section titled “isCancellationRequested”Get Signature
Section titled “Get Signature”get isCancellationRequested():
boolean
Defined in: notifications.ts:160
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”NotificationProgressToken.isCancellationRequested
Methods
Section titled “Methods”cancel()
Section titled “cancel()”cancel():
void
Defined in: notifications.ts:231
Request cancellation for the running progress item.
Returns
Section titled “Returns”void
cancelled()
Section titled “cancelled()”cancelled(
message?):void
Defined in: notifications.ts:271
Mark the progress item as cancelled.
Parameters
Section titled “Parameters”message?
Section titled “message?”string = "Cancelled"
Optional terminal message shown after cancellation.
Returns
Section titled “Returns”void
complete()
Section titled “complete()”complete(
message?):void
Defined in: notifications.ts:251
Mark the progress item as completed.
Parameters
Section titled “Parameters”message?
Section titled “message?”string
Optional terminal message shown to the user.
Returns
Section titled “Returns”void
fail()
Section titled “fail()”fail(
error):void
Defined in: notifications.ts:261
Mark the progress item as failed.
Parameters
Section titled “Parameters”unknown
Failure value to surface in the final progress state.
Returns
Section titled “Returns”void
report()
Section titled “report()”report(
report):void
Defined in: notifications.ts:174
Update the current progress state.
Parameters
Section titled “Parameters”report
Section titled “report”Partial progress information to merge into the live state.
Returns
Section titled “Returns”void
throwIfCancellationRequested()
Section titled “throwIfCancellationRequested()”throwIfCancellationRequested():
void
Defined in: notifications.ts:280
Throw an abort error when cancellation has been requested.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”NotificationProgressToken.throwIfCancellationRequested
update()
Section titled “update()”update(
report):void
Defined in: notifications.ts:222
Alias for report.
Parameters
Section titled “Parameters”report
Section titled “report”Partial progress information to merge into the live state.
Returns
Section titled “Returns”void