ScheduleCollectionClient

Client for managing the collection of Schedules in your account.

Schedules are used to automatically start Actors or tasks at specified times. This client provides methods to list and create schedules.

@example

const client = new ApifyClient({ token: 'my-token' });
const schedulesClient = client.schedules();

// List all schedules
const { items } = await schedulesClient.list();

// Create a new schedule
const newSchedule = await schedulesClient.create({
  actorId: 'my-actor-id',
  cronExpression: '0 9 * * *',
  isEnabled: true
});

@see

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

Hierarchy

• ResourceCollectionClient
  • ScheduleCollectionClient

Index

Properties

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

Methods

• create
• list

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceCollectionClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceCollectionClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceCollectionClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceCollectionClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceCollectionClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceCollectionClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceCollectionClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceCollectionClient.safeId

inheritedurl

url: string

Inherited from ResourceCollectionClient.url

Methods

create

• create(schedule): Promise<Schedule>

• Creates a new schedule.

  @see

  https://docs.apify.com/api/v2/schedules-post

  ---

  Parameters

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

    The schedule data.

  Returns Promise<Schedule>

  The created schedule object.

list

• list(options): PaginatedIterator<Schedule>

• Lists all schedules.

  Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched items in a single API call is limited.

  const paginatedList = await client.list(options);

  Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are retrieved.

  for await (const singleItem of client.list(options)) {...}

  @see

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

  ---

  Parameters

  • options: ScheduleCollectionListOptions = {}

    Pagination and sorting options.

  Returns PaginatedIterator<Schedule>

  A paginated iterator of schedules.