Deep Trekker BRIDGE API - v1.0.3
    Preparing search index...

    Type Alias TransferPayload<T>

    TransferPayload

    TransferPayload represents the payload structure that should be used via an API to send a payload with a specific load type.

    {
      "apiVersion": "1.0.0",
      "method": "SET",
      "payload": {
        "devices": {
          "001A2B3C4D5E": {
             "model": 13,
             "auxLight": {
               "intensity": 100
             }
           }
        }
      }
    }
    type TransferPayload<T> = {
        apiVersion: string;
        error?: TransferError;
        method: TransferMethodType;
        payload: T;
    }

    Type Parameters

    • T
    Index

    Properties

    apiVersion error? method payload

    Properties

    apiVersion: string

    API target version (defaults to the latest). The server's version will not reflect the API version.

    (^[0-9]{1,3}[.][0-9]{1,3}([.][0-9]{1,3})?.*$)

    error?: TransferError

    Transfer error type that the server sends for a variety of reasons.

    TransferError

    method: TransferMethodType

    The action type for the payload. Indicates whether it's sent or received, and how the payload should be handled.

    TransferMethodType

    payload: T

    The payload that the API expects to receive. .

    Settings

    Member Visibility

    On This Page

    Properties