Class ObnizApi

Hierarchy

ObnizApi

Index

Constructors

constructor

Properties

Accessors

apiVersion

Methods

Constructors

constructor

new ObnizApi(obnizId: string, options?: ObnizOptions): ObnizApi

- Defined in src/obniz/ObnizApi.ts:24
Parameters
- obnizId: string
- Optional options: ObnizOptions
Returns ObnizApi

Properties

options

options: any

urlBase

urlBase: any

Accessors

apiVersion

get apiVersion(): string

- Defined in src/obniz/ObnizApi.ts:17
obniz.js major version string

Returns string

Methods

getState

getState(callback: (val: { state: "online" | "offline" }) => void): Promise<any>

- Defined in src/obniz/ObnizApi.ts:41
Get device is online or offline

Parameters
- callback: (val: { state: "online" | "offline" }) => void
  
  with result
  - - (val: { state: "online" | "offline" }): void
    - Parameters
      - val: { state: "online" | "offline" }
        
        state: "online" | "offline"
      Returns void
Returns Promise<any>

getStateWait

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

- Defined in src/obniz/ObnizApi.ts:48
Get device is online or offline

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

postJsonWait

postJsonWait(json: any, callback: (result: any) => void): Promise<any>

- Defined in src/obniz/ObnizApi.ts:59
post data via obniz REST api

Parameters
- json: any
- callback: (result: any) => void
  - - (result: any): void
    - Parameters
      - result: any
      Returns void
Returns Promise<any>

Generated using TypeDoc