Class ActorManager<A>

constructor

• new ActorManager<A>(actorConfig): classes.ActorManager<A>

• Type Parameters

  • A = types.BaseActor

  Parameters

  • actorConfig: types.ActorManagerParameters

  Returns classes.ActorManager<A>

canisterId

actorStore

visitFunction

methodAttributes

getState

subscribeActorState

setState

agentManager

• get agentManager(): classes.AgentManager

• Returns classes.AgentManager

updateMethodState

• updateMethodState(method, hash, newState): void

• Parameters

  • method: Extract<keyof A, string>
  • hash: string
  • newState: Partial<{
        data: undefined | types.ActorMethodReturnType<A[Extract<keyof A, string>]>;
        loading: boolean;
        error: undefined | Error;
    }>

  Returns void

initialize

• initialize(options?): Promise<void>

• Parameters

  • Optional options: types.UpdateAgentParameters

  Returns Promise<void>

extractInterface

• extractInterface(): types.IDL.ServiceClass

• Returns types.IDL.ServiceClass

extractMethodAttributes

• extractMethodAttributes(): types.MethodAttributes<A>

• Returns types.MethodAttributes<A>

extractVisitor

• extractVisitor(): types.VisitService<A>

• Returns types.VisitService<A>

callMethod

• callMethod<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>

• Type Parameters

  • M extends string

  Parameters

  • functionName: M
  • Rest ...args: types.ActorMethodParameters<A[M]>

  Returns Promise<types.ActorMethodReturnType<A[M]>>

callMethodWithOptions

• callMethodWithOptions(options): (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)

• Parameters

  • options: utils.agent.CallConfig

  Returns (<M>(functionName, ...args) => Promise<types.ActorMethodReturnType<A[M]>>)

  • • <M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>

    • Type Parameters

      • M extends string

      Parameters

      • functionName: M
      • Rest ...args: types.ActorMethodParameters<A[M]>

      Returns Promise<types.ActorMethodReturnType<A[M]>>

call

• call<M>(functionName, ...args): Promise<types.ActorMethodReturnType<A[M]>>

• Type Parameters

  • M extends string

  Parameters

  • functionName: M
  • Rest ...args: types.ActorMethodParameters<A[M]>

  Returns Promise<types.ActorMethodReturnType<A[M]>>

getActor

• getActor(): null | A

• Returns null | A

cleanup

• cleanup(): void

• Returns void