ScheduleClient

Client for managing a specific Schedule.

Schedules are used to automatically start Actors or tasks at specified times. This client provides methods to get, update, and delete schedules, as well as retrieve schedule logs.

@example

const client = new ApifyClient({ token: 'my-token' });
const scheduleClient = client.schedule('my-schedule-id');

// Get schedule details
const schedule = await scheduleClient.get();

// Update schedule
await scheduleClient.update({
  cronExpression: '0 12 * * *',
  isEnabled: true
});

@see

https://docs.apify.com/platform/schedules

Hierarchy

• ResourceClient
  • ScheduleClient

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• 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

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceClient.publicBaseUrl

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>

• Deletes the schedule.

  @see

  https://docs.apify.com/api/v2/schedule-delete

  ---

  Returns Promise<void>

get

• get(): Promise<undefined | Schedule>

• Retrieves the schedule.

  @see

  https://docs.apify.com/api/v2/schedule-get

  ---

  Returns Promise<undefined | Schedule>

  The schedule object, or undefined if it does not exist.

getLog

• getLog(): Promise<undefined | string>

• Retrieves the schedule's log.

  @see

  https://docs.apify.com/api/v2/schedule-log-get

  ---

  Returns Promise<undefined | string>

  The schedule log as a string, or undefined if it does not exist.

update

• update(newFields): Promise<Schedule>

• Updates the schedule with the specified fields.

  @see

  https://docs.apify.com/api/v2/schedule-put

  ---

  Parameters

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

    Fields to update.

  Returns Promise<Schedule>

  The updated schedule object.