ScheduleClient

@hideconstructor

Hierarchy

• ResourceClient
  • ScheduleClient

Index

Constructors

• constructor

Properties

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

Methods

• delete
• get
• getLog
• update

Constructors

constructor

• new ScheduleClient(options): ScheduleClient

• Overrides ResourceClient.constructor

  Parameters

  • options: ApiClientSubResourceOptions

  Returns ScheduleClient

Properties

apifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

baseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

httpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalid

id?: string

Inherited from ResourceClient.id

optionalparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

resourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalsafeId

safeId?: string

Inherited from ResourceClient.safeId

url

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): 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 | actions>>

  Returns Promise<Schedule>