Class AgentManager

Hierarchy (view full)

AgentManager
- types.CreateReactorCoreReturnType

Constructors

constructor

new AgentManager(options?): classes.AgentManager
Parameters
- Optional options: types.AgentManagerParameters
Returns classes.AgentManager
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:65

Properties

`Private` _agent

_agent: types.HttpAgent

`Private` _auth

_auth: null | types.AuthClient = null

`Private` _subscribers

_subscribers: ((agent) => void)[] = []

Type declaration

- (agent): void
- Parameters
  - agent: types.HttpAgent
  Returns void

agentStore

agentStore: types.AgentStore

authStore

authStore: types.AuthStore

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

Methods

`Private` updateAgentState

updateAgentState(newState, action?): void
Parameters
- newState: Partial<types.AgentState>
- Optional action: string
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:46

`Private` updateAuthState

updateAuthState(newState, action?): void
Parameters
- newState: Partial<types.AuthState>
- Optional action: string
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:57

initializeAgent

initializeAgent(): Promise<void>
Returns Promise<void>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:103

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
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:129

unsubscribeAgent

unsubscribeAgent(callback): void
Parameters
- callback: ((agent) => void)
  - - (agent): void
    - Parameters
      agent: types.HttpAgent
      Returns void
Returns void
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:140

logout

logout(options?): Promise<void>
Parameters
- Optional options: {
  returnTo?: string;
  }
  - Optional returnTo?: string
Returns Promise<void>
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:215

getAgent

getAgent(): types.HttpAgent
Returns types.HttpAgent
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:224

getAgentHost

getAgentHost(): undefined | URL
Returns undefined | URL
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:228

getAgentHostName

getAgentHostName(): string
Returns string
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:232

getIsLocal

getIsLocal(): boolean
Returns boolean
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:236

getNetwork

getNetwork(): "ic" | "local" | "remote"
Returns "ic" | "local" | "remote"
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:240

getAuth

getAuth(): null | types.AuthClient
Returns null | types.AuthClient
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:281

getIdentity

getIdentity(): null | types.Identity
Returns null | types.Identity
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:285

getPrincipal

getPrincipal(): null | types.Principal
Returns null | types.Principal
- Defined in work/ic-reactor/ic-reactor/packages/core/src/classes/agent/index.ts:289

Class AgentManager

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns classes.AgentManager

Properties

Private _agent

Private _auth

Private _subscribers

Type declaration

Parameters

Returns void

agentStore

authStore

getAgentState

Type declaration

Returns types.AgentState

subscribeAgentState

Type declaration

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Type Parameters

Parameters

Parameters

Returns U

Parameters

Returns void

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

Parameters

Returns boolean

Optional fireImmediately?: boolean

Returns (() => void)

Returns void

getAuthState

Type declaration

Returns types.AuthState

subscribeAuthState

Type declaration

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Type Parameters

Parameters

Parameters

Returns U

Parameters

Returns void

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

Parameters

Returns boolean

Optional fireImmediately?: boolean

Returns (() => void)

Returns void

Methods

Private updateAgentState

Parameters

Returns void

Private updateAuthState

Parameters

Returns void

initializeAgent

Returns Promise<void>

subscribeAgent

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

unsubscribeAgent

Parameters

`Private` _agent

`Private` _auth

`Private` _subscribers

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

`Optional` fireImmediately?: boolean

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

`Optional` fireImmediately?: boolean

`Private` updateAgentState

`Private` updateAuthState

`Private` notifySubscribers

`Optional` returnTo?: string