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.

Index

Constructors

constructor

Methods

agentOf interfaceOf canisterIdOf createActorClass createActor createActorWithHttpDetails createActorWithExtendedDetails

Constructors

`Protected`constructor

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

Methods

`Static`agentOf

agentOf(actor: utils.agent.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/esm/actor.d.ts:133

`Static`interfaceOf

interfaceOf(actor: utils.agent.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/esm/actor.d.ts:138

`Static`canisterIdOf

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

`Static`createActorClass

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

`Static`createActor

createActor<T = Record<string, types.ActorMethod<unknown[], unknown>>>(
interfaceFactory: types.IDL.InterfaceFactory,
configuration: utils.agent.ActorConfig,
): 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/esm/actor.d.ts:141

`Static`createActorWithHttpDetails

createActorWithHttpDetails<
    T = Record<string, types.ActorMethod<unknown[], unknown>>,
>(
    interfaceFactory: types.IDL.InterfaceFactory,
    configuration: utils.agent.ActorConfig,
): 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/esm/actor.d.ts:148

`Static`createActorWithExtendedDetails

createActorWithExtendedDetails<
    T = Record<string, types.ActorMethod<unknown[], unknown>>,
>(
    interfaceFactory: types.IDL.InterfaceFactory,
    configuration: utils.agent.ActorConfig,
    actorClassOptions?: utils.agent.CreateActorClassOpts,
): 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
- OptionalactorClassOptions: 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/esm/actor.d.ts:155

Class Actor

Index

Constructors

Methods

Constructors

`Protected`constructor

Parameters

Returns utils.agent.Actor

Methods

`Static`agentOf

Parameters

Returns undefined | utils.agent.Agent

`Static`interfaceOf

Parameters

Returns types.IDL.ServiceClass

`Static`canisterIdOf

Parameters

Returns types.Principal

`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

On This Page

Class Actor

Index

Constructors

Methods

Constructors

Protectedconstructor

Parameters

Returns utils.agent.Actor

Methods

StaticagentOf

Parameters

Returns undefined | utils.agent.Agent

StaticinterfaceOf

Parameters

Returns types.IDL.ServiceClass

StaticcanisterIdOf

Parameters

Returns types.Principal

StaticcreateActorClass

Parameters

Returns utils.agent.ActorConstructor

StaticcreateActor

Type Parameters

Parameters

Returns types.ActorSubclass<T>

StaticcreateActorWithHttpDetails

Type Parameters

Parameters

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

Deprecated

StaticcreateActorWithExtendedDetails

Type Parameters

Parameters

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

Settings

On This Page

`Protected`constructor

`Static`agentOf

`Static`interfaceOf

`Static`canisterIdOf

`Static`createActorClass

`Static`createActor

`Static`createActorWithHttpDetails

`Static`createActorWithExtendedDetails