Class AgentManager

constructor

• new AgentManager(options?): classes.AgentManager

• Parameters

  • Optional options: types.AgentManagerParameters

  Returns classes.AgentManager

agentStore

authStore

getAgentState

subscribeAgentState

getAuthState

subscribeAuthState

subscribeAgent

• subscribeAgent(callback, initialize?): (() => void)

• Parameters

  • callback: ((agent) => void)
    • • (agent): void

      • Parameters

        • agent: types.HttpAgent

        Returns void

  • initialize: boolean = true

  Returns (() => void)

  • • (): void

    • Returns void

unsubscribeAgent

• unsubscribeAgent(callback): void

• Parameters

  • callback: ((agent) => void)
    • • (agent): void

      • Parameters

        • agent: types.HttpAgent

        Returns void

  Returns void

updateAgent

• updateAgent(options?): Promise<void>

• Parameters

  • Optional options: types.UpdateAgentParameters

  Returns Promise<void>

authenticate

• authenticate(): Promise<types.Identity>

• Returns Promise<types.Identity>

login

• login(options?): Promise<void>

• Parameters

  • Optional options: types.AuthClientLoginOptions

  Returns Promise<void>

logout

• logout(options?): Promise<void>

• Parameters

  • Optional options: {
        returnTo?: string;
    }

    • Optional returnTo?: string

  Returns Promise<void>

getAgent

• getAgent(): types.HttpAgent

• Returns types.HttpAgent

getAgentHost

• getAgentHost(): undefined | URL

• Returns undefined | URL

getAgentHostName

• getAgentHostName(): string

• Returns string

getIsLocal

• getIsLocal(): boolean

• Returns boolean

getNetwork

• getNetwork(): "ic" | "local" | "remote"

• Returns "ic" | "local" | "remote"

getAuth

• getAuth(): null | types.AuthClient

• Returns null | types.AuthClient

getIdentity

• getIdentity(): null | types.Identity

• Returns null | types.Identity

getPrincipal

• getPrincipal(): null | types.Principal

• Returns null | types.Principal