ActorClient

Hierarchy

• ResourceClient
  • ActorClient

Index

Properties

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

Methods

• build
• builds
• call
• delete
• get
• lastRun
• runs
• start
• update
• version
• versions
• webhooks

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

build

• build(versionNumber: string, options?: ActorBuildOptions): Promise<Build>

• https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor

  ---

  Parameters

  • versionNumber: string

  • options: ActorBuildOptions = {}

  Returns Promise<Build>

builds

• builds(): BuildCollectionClient

• https://docs.apify.com/api/v2#/reference/actors/build-collection

  ---

  Returns BuildCollectionClient

call

• call(input?: unknown, options?: ActorCallOptions): Promise<ActorRun>

• Starts an actor and waits for it to finish before returning the Run object. It waits indefinitely, unless the waitSecs option is provided. https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor

  ---

  Parameters

  • optionalinput: unknown

  • options: ActorCallOptions = {}

  Returns Promise<ActorRun>

delete

• delete(): Promise<void>

• https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor

  ---

  Returns Promise<void>

get

• get(): Promise<undefined | Actor>

• https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor

  ---

  Returns Promise<undefined | Actor>

lastRun

• lastRun(options?: ActorLastRunOptions): RunClient

• https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages

  ---

  Parameters

  • options: ActorLastRunOptions = {}

  Returns RunClient

runs

• runs(): RunCollectionClient

• https://docs.apify.com/api/v2#/reference/actors/run-collection

  ---

  Returns RunCollectionClient

start

• start(input?: unknown, options?: ActorStartOptions): Promise<ActorRun>

• Starts an actor and immediately returns the Run object. https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor

  ---

  Parameters

  • optionalinput: unknown

  • options: ActorStartOptions = {}

  Returns Promise<ActorRun>

update

• update(newFields: Partial<Pick<Actor, name | description | isPublic | isDeprecated | seoTitle | seoDescription | title | restartOnError | versions | categories | defaultRunOptions | actorStandby>>): Promise<Actor>

• https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor

  ---

  Parameters

  • newFields: Partial<Pick<Actor, name | description | isPublic | isDeprecated | seoTitle | seoDescription | title | restartOnError | versions | categories | defaultRunOptions | actorStandby>>

  Returns Promise<Actor>

version

• version(versionNumber: string): ActorVersionClient

• https://docs.apify.com/api/v2#/reference/actors/version-object

  ---

  Parameters

  • versionNumber: string

  Returns ActorVersionClient

versions

• versions(): ActorVersionCollectionClient

• https://docs.apify.com/api/v2#/reference/actors/version-collection

  ---

  Returns ActorVersionCollectionClient

webhooks

• webhooks(): WebhookCollectionClient

• https://docs.apify.com/api/v2#/reference/actors/webhook-collection

  ---

  Returns WebhookCollectionClient