Class Actor

An actor base class. An actor is an object containing only functions that will return a promise. These functions are derived from the IDL definition.

Hierarchy (view full)

Actor
- utils.agent.AdvancedActor

Index

Constructors

`Protected` constructor

new Actor(metadata): utils.agent.Actor
Parameters
- metadata: ActorMetadata
Returns utils.agent.Actor
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:185

Properties

`Private` [metadataSymbol]

[metadataSymbol]: any

Methods

`Static` agentOf

agentOf(actor): undefined | utils.agent.Agent
Get the Agent class this Actor would call, or undefined if the Actor would use the default agent (global.ic.agent).
Parameters
- actor: utils.agent.Actor
  The actor to get the agent of.
Returns undefined | utils.agent.Agent
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:151

`Static` interfaceOf

interfaceOf(actor): types.IDL.ServiceClass
Get the interface of an actor, in the form of an instance of a Service.
Parameters
- actor: utils.agent.Actor
  The actor to get the interface of.
Returns types.IDL.ServiceClass
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:156

`Static` canisterIdOf

canisterIdOf(actor): types.Principal
Parameters
- actor: utils.agent.Actor
Returns types.Principal
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:157

`Static` install

install(fields, config): Promise<void>
Parameters
- fields: {
      module: ArrayBuffer;
      mode?: canister_install_mode;
      arg?: ArrayBuffer;
  }
  - module: ArrayBuffer
  - Optional mode?: canister_install_mode
  - Optional arg?: ArrayBuffer
- config: utils.agent.ActorConfig
Returns Promise<void>
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:158

`Static` createCanister

createCanister(config?, settings?): Promise<types.Principal>
Parameters
- Optional config: utils.agent.CallConfig
- Optional settings: CreateCanisterSettings
Returns Promise<types.Principal>
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:163

`Static` createAndInstallCanister

createAndInstallCanister(interfaceFactory, fields, config?): Promise<types.ActorSubclass<Record<string, types.ActorMethod<unknown[], unknown>>>>
Parameters
- interfaceFactory: types.IDL.InterfaceFactory
- fields: {
  module: ArrayBuffer;
  arg?: ArrayBuffer;
  }
  - module: ArrayBuffer
  - Optional arg?: ArrayBuffer
- Optional config: utils.agent.CallConfig
Returns Promise<types.ActorSubclass<Record<string, types.ActorMethod<unknown[], unknown>>>>
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:164

`Static` createActorClass

createActorClass(interfaceFactory, options?): utils.agent.ActorConstructor
Parameters
- interfaceFactory: types.IDL.InterfaceFactory
- Optional options: utils.agent.CreateActorClassOpts
Returns utils.agent.ActorConstructor
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:168

`Static` createActor

createActor<T>(interfaceFactory, configuration): types.ActorSubclass<T>
Type Parameters
- T = Record<string, types.ActorMethod<unknown[], unknown>>
Parameters
- interfaceFactory: types.IDL.InterfaceFactory
- configuration: utils.agent.ActorConfig
Returns types.ActorSubclass<T>
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:169

`Static` createActorWithHttpDetails

createActorWithHttpDetails<T>(interfaceFactory, configuration): types.ActorSubclass<utils.agent.ActorMethodMappedWithHttpDetails<T>>
Returns an actor with methods that return the http response details along with the result
Type Parameters
- T = Record<string, types.ActorMethod<unknown[], unknown>>
Parameters
- interfaceFactory: types.IDL.InterfaceFactory
  the interface factory for the actor
- configuration: utils.agent.ActorConfig
  the configuration for the actor
Returns types.ActorSubclass<utils.agent.ActorMethodMappedWithHttpDetails<T>>
Deprecated
- use createActor with actorClassOptions instead
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:176

`Static` createActorWithExtendedDetails

createActorWithExtendedDetails<T>(interfaceFactory, configuration, actorClassOptions?): types.ActorSubclass<utils.agent.ActorMethodMappedExtended<T>>
Returns an actor with methods that return the http response details along with the result
Type Parameters
- T = Record<string, types.ActorMethod<unknown[], unknown>>
Parameters
- interfaceFactory: types.IDL.InterfaceFactory
  the interface factory for the actor
- configuration: utils.agent.ActorConfig
  the configuration for the actor
- Optional actorClassOptions: utils.agent.CreateActorClassOpts
  options for the actor class extended details to return with the result
Returns types.ActorSubclass<utils.agent.ActorMethodMappedExtended<T>>
- Defined in node_modules/@dfinity/agent/lib/cjs/actor.d.ts:183

Class Actor

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

Returns utils.agent.Actor

Properties

Private [metadataSymbol]

Methods

Static agentOf

Parameters

Returns undefined | utils.agent.Agent

Static interfaceOf

Parameters

Returns types.IDL.ServiceClass

Static canisterIdOf

Parameters

Returns types.Principal

Static install

Parameters

module: ArrayBuffer

Optional mode?: canister_install_mode

Optional arg?: ArrayBuffer

Returns Promise<void>

Static createCanister

Parameters

Returns Promise<types.Principal>

Static createAndInstallCanister

Parameters

module: ArrayBuffer

Optional arg?: ArrayBuffer

Returns Promise<types.ActorSubclass<Record<string, types.ActorMethod<unknown[], unknown>>>>

Static createActorClass

Parameters

Returns utils.agent.ActorConstructor

Static createActor

Type Parameters

Parameters

Returns types.ActorSubclass<T>

Static createActorWithHttpDetails

Type Parameters

Parameters

Returns types.ActorSubclass<utils.agent.ActorMethodMappedWithHttpDetails<T>>

Deprecated

Static createActorWithExtendedDetails

Type Parameters

Parameters

Returns types.ActorSubclass<utils.agent.ActorMethodMappedExtended<T>>

Settings

Member Visibility

Theme

On This Page

`Protected` constructor

`Private` [metadataSymbol]

`Static` agentOf

`Static` interfaceOf

`Static` canisterIdOf

`Static` install

`Optional` mode?: canister_install_mode

`Optional` arg?: ArrayBuffer

`Static` createCanister

`Static` createAndInstallCanister

`Optional` arg?: ArrayBuffer

`Static` createActorClass

`Static` createActor

`Static` createActorWithHttpDetails

`Static` createActorWithExtendedDetails