Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PayloadRequestBuilder

PayloadRequestBuilder is a helper class to ease construction of payload requests.

export
class

PayloadRequestBuilder

Hierarchy

  • PayloadRequestBuilder

Index

Methods

withGet

  • Assigns get to the PayloadRequest.

    Parameters

    • get: string[]

      An array of identifiers for data to retrieve from the device.

    Returns PayloadRequestBuilder

withSet

  • Assigns set to the PayloadRequest.

    Parameters

    • set: object

      A dictionary of (identifier, data) to store on the device.

      • [key: string]: string

    Returns PayloadRequestBuilder

Static build

  • Build a new PayloadRequest. Builder methods can be called on the PayloadRequestBuilder instance passed to the block.

    static

    Parameters

    Returns PayloadRequest

Generated using TypeDoc