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

Actor

Index

Constructors

constructor

Properties

[metadataSymbol]

Methods

Constructors

Protected constructor

new Actor(metadata: ActorMetadata): Actor

- Defined in packages/agent/src/actor.ts:384
Parameters
- metadata: ActorMetadata
Returns Actor

Properties

Private [metadataSymbol]

[metadataSymbol]: ActorMetadata

Methods

Static agentOf

agentOf(actor: Actor): undefined | Agent

- Defined in packages/agent/src/actor.ts:227
Get the Agent class this Actor would call, or undefined if the Actor would use the default agent (global.ic.agent).

Parameters
- actor: Actor
  
  The actor to get the agent of.
Returns undefined | Agent

Static canisterIdOf

canisterIdOf(actor: Actor): Principal

- Defined in packages/agent/src/actor.ts:239
Parameters
- actor: Actor
Returns Principal

Static createActor

createActor<T>(interfaceFactory: InterfaceFactory, configuration: ActorConfig): ActorSubclass<T>

- Defined in packages/agent/src/actor.ts:359
Type Parameters
- T = Record<string, ActorMethod<unknown[], unknown>>
Parameters
- interfaceFactory: InterfaceFactory
- configuration: ActorConfig
Returns ActorSubclass<T>

Static createActorClass

createActorClass(interfaceFactory: InterfaceFactory, options?: CreateActorClassOpts): ActorConstructor

- Defined in packages/agent/src/actor.ts:318
Parameters
- interfaceFactory: InterfaceFactory
- Optional options: CreateActorClassOpts
Returns ActorConstructor

Static createActorWithHttpDetails

createActorWithHttpDetails<T>(interfaceFactory: InterfaceFactory, configuration: ActorConfig): ActorSubclass<ActorMethodMappedWithHttpDetails<T>>

- Defined in packages/agent/src/actor.ts:373
Type Parameters
- T = Record<string, ActorMethod<unknown[], unknown>>
Parameters
- interfaceFactory: InterfaceFactory
- configuration: ActorConfig
Returns ActorSubclass<ActorMethodMappedWithHttpDetails<T>>

Static createAndInstallCanister

createAndInstallCanister(interfaceFactory: InterfaceFactory, fields: { arg?: ArrayBuffer; module: ArrayBuffer }, config?: CallConfig): Promise<ActorSubclass<Record<string, ActorMethod<unknown[], unknown>>>>

- Defined in packages/agent/src/actor.ts:299
Parameters
- interfaceFactory: InterfaceFactory
- fields: { arg?: ArrayBuffer; module: ArrayBuffer }
  - Optional arg?: ArrayBuffer
  - module: ArrayBuffer
- Optional config: CallConfig
Returns Promise<ActorSubclass<Record<string, ActorMethod<unknown[], unknown>>>>

Static createCanister

createCanister(config?: CallConfig, settings?: CreateCanisterSettings): Promise<Principal>

- Defined in packages/agent/src/actor.ts:270
Parameters
- Optional config: CallConfig
- Optional settings: CreateCanisterSettings
Returns Promise<Principal>

Static install

install(fields: { arg?: ArrayBuffer; mode?: CanisterInstallMode; module: ArrayBuffer }, config: ActorConfig): Promise<void>

- Defined in packages/agent/src/actor.ts:243
Parameters
- fields: { arg?: ArrayBuffer; mode?: CanisterInstallMode; module: ArrayBuffer }
  - Optional arg?: ArrayBuffer
  - Optional mode?: CanisterInstallMode
  - module: ArrayBuffer
- config: ActorConfig
Returns Promise<void>

Static interfaceOf

interfaceOf(actor: Actor): ServiceClass

- Defined in packages/agent/src/actor.ts:235
Get the interface of an actor, in the form of an instance of a Service.

Parameters
- actor: Actor
  
  The actor to get the interface of.
Returns ServiceClass

Generated using TypeDoc