Interface IAuthAgent

The authenticated agent interface.

interface IAuthAgent {
    type: Agent;
    getId(): string;
    onConfigurationChange(callback: (() => Promise<void>)): Unsubscribe;
    setReportCapacity(reportCapacity: (() => Promise<IAgentCapacity>)): Unsubscribe;
}

Hierarchy (view full)

IAuthNode
- IAuthAgent

Index

Properties

Methods

getId onConfigurationChange setReportCapacity

Properties

type

type: Agent

The type of the node.

Methods

getId

getId(): string
Get the ID of the node.

Returns string
The ID of the node.

Inherited from IAuthNode.getId

onConfigurationChange

onConfigurationChange(callback): Unsubscribe
Subscribe to when the agent configuration changes.
Parameters
- callback: (() => Promise<void>)
  The callback to invoke when the agent configuration changes.
  - - (): Promise<void>
    - Returns Promise<void>
Returns Unsubscribe
The unsubscribe function.

setReportCapacity

setReportCapacity(reportCapacity): Unsubscribe
Set the report capacity callback.
Parameters
- reportCapacity: (() => Promise<IAgentCapacity>)
  The report capacity callback.
  - - (): Promise<IAgentCapacity>
    - Returns Promise<IAgentCapacity>
Returns Unsubscribe
The unsubscribe function.