ScheduleCollectionClient

@hideconstructor

Hierarchy

• ResourceCollectionClient
  • ScheduleCollectionClient

Index

Constructors

• constructor

Properties

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

Methods

• create
• list

Constructors

constructor

• new ScheduleCollectionClient(options: ApiClientSubResourceOptions): ScheduleCollectionClient

• Overrides ResourceCollectionClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  Returns ScheduleCollectionClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceCollectionClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceCollectionClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceCollectionClient.httpClient

optionalid

id?: string

Inherited from ResourceCollectionClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceCollectionClient.params

resourcePath

resourcePath: string

Inherited from ResourceCollectionClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceCollectionClient.safeId

url

url: string

Inherited from ResourceCollectionClient.url

Methods

create

• create(schedule?: Partial<Pick<Schedule, name | description | title | cronExpression | timezone | isEnabled | isExclusive | actions>>): Promise<Schedule>

• https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule

  ---

  Parameters

  • optionalschedule: Partial<Pick<Schedule, name | description | title | cronExpression | timezone | isEnabled | isExclusive | actions>>

  Returns Promise<Schedule>

list

• list(options?: ScheduleCollectionListOptions): Promise<PaginatedList<Schedule>>

• https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules

  ---

  Parameters

  • options: ScheduleCollectionListOptions = {}

  Returns Promise<PaginatedList<Schedule>>