Class AgentManager

Hierarchy (view full)

AgentManager
- types.CreateReactorCoreReturnType

Constructors

constructor

new AgentManager(options?): types.AgentManager
Parameters
- Optional options: types.AgentManagerParameters
Returns types.AgentManager
- Defined in work/ic-reactor/ic-reactor/.yarn/__virtual__/@ic-reactor-core-virtual-8912d6d033/1/packages/core/dist/classes/agent/index.d.ts:13

Properties

`Private` _agent

_agent: any

`Private` _auth

_auth: any

`Private` _subscribers

_subscribers: any

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

`Private` updateAgentState

updateAgentState: any

`Private` updateAuthState

updateAuthState: any

initializeAgent

initializeAgent: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

subscribeAgent

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

Type declaration

- (callback, initialize?): (() => void)
- Parameters
  - callback: ((agent) => void)
    - (agent): void
      Parameters
      agent: types.HttpAgent
      Returns void
  - Optional initialize: boolean
  Returns (() => void)
  - - (): void
    - Returns void

unsubscribeAgent

unsubscribeAgent: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((agent) => void)
    - (agent): void
      Parameters
      agent: types.HttpAgent
      Returns void
  Returns void

`Private` notifySubscribers

notifySubscribers: any

updateAgent

updateAgent: ((options?) => Promise<void>)

Type declaration

- (options?): Promise<void>
- Parameters
  - Optional options: types.UpdateAgentParameters
  Returns Promise<void>

authenticate

authenticate: (() => Promise<types.Identity>)

Type declaration

- (): Promise<types.Identity>
- Returns Promise<types.Identity>

login

Type declaration

- (options?): Promise<void>
- Parameters
  - Optional options: types.AuthClientLoginOptions
  Returns Promise<void>

logout

logout: ((options?) => Promise<void>)

Type declaration

- (options?): Promise<void>
- Parameters
  - Optional options: {
    returnTo?: string;
    }
    - Optional returnTo?: string
  Returns Promise<void>

getAgent

getAgent: (() => types.HttpAgent)

Type declaration

- (): types.HttpAgent
- Returns types.HttpAgent

getAgentHost

getAgentHost: (() => undefined | URL)

Type declaration

- (): undefined | URL
- Returns undefined | URL

getAgentHostName

getAgentHostName: (() => string)

Type declaration

- (): string
- Returns string

getIsLocal

getIsLocal: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

getNetwork

getNetwork: (() => "local" | "remote" | "ic")

Type declaration

- (): "local" | "remote" | "ic"
- Returns "local" | "remote" | "ic"

getAgentState

getAgentState: (() => types.AgentState)

Type declaration

- (): types.AgentState
- Returns types.AgentState

subscribeAgentState

subscribeAgentState: {
(listener): (() => void);
<U>(selector, listener, options?): (() => void);
}

Type declaration

- (listener): (() => void)
- Parameters
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: types.AgentState
      previousSelectedState: types.AgentState
      Returns void
  Returns (() => void)
  - - (): void
    - Returns void
- <U>(selector, listener, options?): (() => void)
- Type Parameters
  - U
  Parameters
  - selector: ((state) => U)
    - (state): U
      Parameters
      state: types.AgentState
      Returns U
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: U
      previousSelectedState: U
      Returns void
  - Optional options: {
    equalityFn?: ((a, b) => boolean);
    fireImmediately?: boolean;
    }
    - Optional equalityFn?: ((a, b) => boolean)
      (a, b): boolean
      Parameters
      a: U
      b: U
      Returns boolean
    - Optional fireImmediately?: boolean
  Returns (() => void)
  - - (): void
    - Returns void

getAuthState

getAuthState: (() => types.AuthState)

Type declaration

- (): types.AuthState
- Returns types.AuthState

subscribeAuthState

subscribeAuthState: {
(listener): (() => void);
<U>(selector, listener, options?): (() => void);
}

Type declaration

- (listener): (() => void)
- Parameters
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: types.AuthState
      previousSelectedState: types.AuthState
      Returns void
  Returns (() => void)
  - - (): void
    - Returns void
- <U>(selector, listener, options?): (() => void)
- Type Parameters
  - U
  Parameters
  - selector: ((state) => U)
    - (state): U
      Parameters
      state: types.AuthState
      Returns U
  - listener: ((selectedState, previousSelectedState) => void)
    - (selectedState, previousSelectedState): void
      Parameters
      selectedState: U
      previousSelectedState: U
      Returns void
  - Optional options: {
    equalityFn?: ((a, b) => boolean);
    fireImmediately?: boolean;
    }
    - Optional equalityFn?: ((a, b) => boolean)
      (a, b): boolean
      Parameters
      a: U
      b: U
      Returns boolean
    - Optional fireImmediately?: boolean
  Returns (() => void)
  - - (): void
    - Returns void

getAuth

getAuth: (() => null | types.AuthClient)

Type declaration

- (): null | types.AuthClient
- Returns null | types.AuthClient

getIdentity

getIdentity: (() => null | types.Identity)

Type declaration

- (): null | types.Identity
- Returns null | types.Identity

getPrincipal

getPrincipal: (() => null | types.Principal)

Type declaration

- (): null | types.Principal
- Returns null | types.Principal

Class AgentManager

Hierarchy (view full)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns types.AgentManager

Properties

Private _agent

Private _auth

Private _subscribers

agentStore

authStore

Private updateAgentState

Private updateAuthState

initializeAgent

Type declaration

Returns Promise<void>

subscribeAgent

Type declaration

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

unsubscribeAgent

Type declaration

Parameters

Parameters

Returns void

Returns void

Private notifySubscribers

updateAgent

Type declaration

Parameters

Returns Promise<void>

authenticate

Type declaration

Returns Promise<types.Identity>

login

Type declaration

Parameters

Returns Promise<void>

logout

Type declaration

Parameters

Optional returnTo?: string

Returns Promise<void>

getAgent

Type declaration

Returns types.HttpAgent

getAgentHost

Type declaration

Returns undefined | URL

getAgentHostName

Type declaration

Returns string

getIsLocal

Type declaration

Returns boolean

getNetwork

Type declaration

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

getAgentState

Type declaration

Returns types.AgentState

subscribeAgentState

Type declaration

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Type Parameters

Parameters

Parameters

Returns U

Parameters

`Private` _agent

`Private` _auth

`Private` _subscribers

`Private` updateAgentState

`Private` updateAuthState

`Private` notifySubscribers

`Optional` returnTo?: string

`Optional` equalityFn?: ((a, b) => boolean)

`Optional` fireImmediately?: boolean

`Optional` equalityFn?: ((a, b) => boolean)

`Optional` fireImmediately?: boolean