AsyncTask
Defined in: src/models/asyncTask.model.ts:12
AsyncTask model class with helper methods.
Represents a long-running operation, for example an async markdown write. Poll the task until it reaches a terminal status.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AsyncTask(
data):AsyncTask
Defined in: src/models/asyncTask.model.ts:13
Parameters
Section titled “Parameters”created_time
Section titled “created_time”string = notionDateStringSchema
error?
Section titled “error?”{ code: string; message: string; object: "error"; status: number; } = ...
error.code
Section titled “error.code”string = ...
error.message
Section titled “error.message”string = ...
error.object
Section titled “error.object”"error" = ...
error.status
Section titled “error.status”number = ...
string = ...
object
Section titled “object”"async_task" = ...
operation
Section titled “operation”{ name: string; surface: "rest" | "mcp"; } = asyncTaskOperationSchema
operation.name
Section titled “operation.name”string = ...
operation.surface
Section titled “operation.surface”"rest" | "mcp" = ...
poll_after_seconds?
Section titled “poll_after_seconds?”number = ...
result?
Section titled “result?”unknown = ...
status
Section titled “status”"queued" | "running" | "retrying" | "succeeded" | "failed" = ...
status_url
Section titled “status_url”string = ...
Returns
Section titled “Returns”AsyncTask
Overrides
Section titled “Overrides”BaseModel<NotionAsyncTask>.constructor
Accessors
Section titled “Accessors”createdTime
Section titled “createdTime”Get Signature
Section titled “Get Signature”get createdTime():
Date
Defined in: src/models/asyncTask.model.ts:48
Returns the task creation time as a Date object.
Returns
Section titled “Returns”Date
Get Signature
Section titled “Get Signature”get error(): {
code:string;message:string;object:"error";status:number; } |undefined
Defined in: src/models/asyncTask.model.ts:76
Returns the error details, present only when the task failed.
Returns
Section titled “Returns”{ code: string; message: string; object: "error"; status: number; } | undefined
Get Signature
Section titled “Get Signature”get id():
string
Defined in: src/models/asyncTask.model.ts:27
Returns the task ID.
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”object
Section titled “object”Get Signature
Section titled “Get Signature”get object():
"async_task"
Defined in: src/models/asyncTask.model.ts:20
Returns “async_task” - the object type.
Returns
Section titled “Returns”"async_task"
Overrides
Section titled “Overrides”operation
Section titled “operation”Get Signature
Section titled “Get Signature”get operation():
object
Defined in: src/models/asyncTask.model.ts:55
Returns the operation that created this task.
Returns
Section titled “Returns”object
name:
string
surface
Section titled “surface”surface:
"rest"|"mcp"
pollAfterSeconds
Section titled “pollAfterSeconds”Get Signature
Section titled “Get Signature”get pollAfterSeconds():
number|undefined
Defined in: src/models/asyncTask.model.ts:62
Returns the minimum number of seconds to wait before polling again, if provided.
Returns
Section titled “Returns”number | undefined
result
Section titled “result”Get Signature
Section titled “Get Signature”get result():
unknown
Defined in: src/models/asyncTask.model.ts:69
Returns the operation-specific result, present only when the task succeeded.
Returns
Section titled “Returns”unknown
status
Section titled “status”Get Signature
Section titled “Get Signature”get status():
"queued"|"running"|"retrying"|"succeeded"|"failed"
Defined in: src/models/asyncTask.model.ts:34
Returns the task status.
Returns
Section titled “Returns”"queued" | "running" | "retrying" | "succeeded" | "failed"
statusUrl
Section titled “statusUrl”Get Signature
Section titled “Get Signature”get statusUrl():
string
Defined in: src/models/asyncTask.model.ts:41
Returns the URL to poll for the task status.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”isFailed()
Section titled “isFailed()”isFailed():
boolean
Defined in: src/models/asyncTask.model.ts:90
Returns whether the task failed.
Returns
Section titled “Returns”boolean
isSucceeded()
Section titled “isSucceeded()”isSucceeded():
boolean
Defined in: src/models/asyncTask.model.ts:83
Returns whether the task completed successfully.
Returns
Section titled “Returns”boolean
isTerminal()
Section titled “isTerminal()”isTerminal():
boolean
Defined in: src/models/asyncTask.model.ts:97
Returns whether the task has reached a terminal status (succeeded or failed).
Returns
Section titled “Returns”boolean
toJSON()
Section titled “toJSON()”toJSON():
object
Defined in: src/models/base.model.ts:20
Returns the raw validated data as a plain object.
Returns
Section titled “Returns”object
created_time
Section titled “created_time”created_time:
string=notionDateStringSchema
error?
Section titled “error?”
optionalerror?:object
error.code
Section titled “error.code”code:
string
error.message
Section titled “error.message”message:
string
error.object
Section titled “error.object”object:
"error"
error.status
Section titled “error.status”status:
number
id:
string
object
Section titled “object”object:
"async_task"
operation
Section titled “operation”operation:
object=asyncTaskOperationSchema
operation.name
Section titled “operation.name”name:
string
operation.surface
Section titled “operation.surface”surface:
"rest"|"mcp"
poll_after_seconds?
Section titled “poll_after_seconds?”
optionalpoll_after_seconds?:number
result?
Section titled “result?”
optionalresult?:unknown
status
Section titled “status”status:
"queued"|"running"|"retrying"|"succeeded"|"failed"
status_url
Section titled “status_url”status_url:
string