Class ExplorationService

Embedded exploration API service

Hierarchy (View Summary)

BaseEmbedService
- ExplorationService

Index

Constructors

Methods

buildOptionsWithRequest enumerate morePeripheralsInformation peripheralInformation

Constructors

constructor

new ExplorationService(): ExplorationService
Returns ExplorationService
Inherited from BaseEmbedService.constructor

Methods

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`enumerate

enumerate(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Perform peripheral exploration
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/ExplorationService.ts:18

`Static`morePeripheralsInformation

morePeripheralsInformation(
    shared: EmbedSharedParams,
    params: PeripheralInformationParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Get information about more peripherals
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: PeripheralInformationParams
  More peripheral information request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/ExplorationService.ts:34

`Static`peripheralInformation

peripheralInformation(
    shared: EmbedSharedParams,
    params: PeripheralInformationParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Get information abotu peripheral
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: PeripheralInformationParams
  Peripheral information request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/ExplorationService.ts:50