Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PingRequest

The ping command returns an acknowledgement, so that clients can test the connection status and latency. Expects a response in the form of a PingResponse.

Hierarchy

  • BaseRequest
    • PingRequest

Index

Properties

api_version?: number

The API version to use. If omitted, use version 1.

command: "ping"
id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Generated using TypeDoc