Class ObnizApi

constructor

• new ObnizApi(obnizId, options?): ObnizApi

• Parameters

  • obnizId: string

  • Optional options: ObnizOptions

  Returns ObnizApi

options

urlBase

apiVersion

• get apiVersion(): string

• obniz.js major version string

  Returns string

getState

• getState(callback): Promise<any>

• Get device is online or offline

  Parameters

  • callback: ((val) => void)

    with result

    • • (val): void

      • Parameters

        • val: {
              state: "offline" | "online";
          }

          • state: "offline" | "online"

        Returns void

  Returns Promise<any>

getStateWait

• getStateWait(): Promise<{
      state: "offline" | "online";
  }>

• Get device is online or offline

  Returns Promise<{
      state: "offline" | "online";
  }>

postJsonWait

• postJsonWait(json, callback): Promise<any>

• post data via obniz REST api

  Parameters

  • json: any

  • callback: ((result) => void)

    • • (result): void

      • Parameters

        • result: any

        Returns void

  Returns Promise<any>