Interface AgentContext

interface AgentContext {
    agentManager: types.AgentManager;
    useAgent: (() => undefined | types.HttpAgent);
    useAgentState: (() => types.AgentState);
    useAuth: ((options?) => UseAuthReturnType);
    useAuthState: (() => types.AuthState);
    useUserPrincipal: (() => undefined | types.Principal);
}

Hierarchy (view full)

AgentHooksReturnType
AuthHooksReturnType
- AgentContext

Index

Properties

agentManager useAgent useAgentState useAuth useAuthState useUserPrincipal

Properties

agentManager

agentManager: types.AgentManager

useAgent

useAgent: (() => undefined | types.HttpAgent)

Type declaration

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

useAgentState

useAgentState: (() => types.AgentState)

Type declaration

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

useAuth

useAuth: ((options?) => UseAuthReturnType)

Type declaration

- (options?): UseAuthReturnType
- Parameters
  - Optional options: UseAuthParameters
  Returns UseAuthReturnType

useAuthState

useAuthState: (() => types.AuthState)

Type declaration

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

useUserPrincipal

useUserPrincipal: (() => undefined | types.Principal)

Type declaration

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