ScheduleClient

Hierarchy

• ResourceClient
  • ScheduleClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• resourcePath
• safeId
• url

Methods

• delete
• get
• getLog
• update

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule

  ---

  Returns Promise<void>

get

• get(): Promise<undefined | Schedule>

• https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule

  ---

  Returns Promise<undefined | Schedule>

getLog

• getLog(): Promise<undefined | string>

• https://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log

  ---

  Returns Promise<undefined | string>

update

• update(newFields: Partial<Pick<Schedule, name | description | title | cronExpression | timezone | isEnabled | isExclusive | notifications> & { actions: DistributiveOptional<ScheduleAction, id>[] }>): Promise<Schedule>

• https://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule

  ---

  Parameters

  • newFields: Partial<Pick<Schedule, name | description | title | cronExpression | timezone | isEnabled | isExclusive | notifications> & { actions: DistributiveOptional<ScheduleAction, id>[] }>

  Returns Promise<Schedule>