Class ObnizApp

Hierarchy

ObnizApp

Index

Methods

Methods

Static configs

configs(): any

- Defined in src/obniz/ObnizApp.ts:63
Configration by user for This App. Only Available for BrowserApp

Returns any

Static done

done(arg: { status: "success" | "error"; text: string }): void

- Defined in src/obniz/ObnizApp.ts:49
done call for obniz Cloud execution. Pass arguemnt for update cloud execution status.
```
// JavaScript example
Obniz.App.done({
  status: 'success',  // 'success' | 'error'
  text: 'ex. Door Opened'
});
```
Parameters
- arg: { status: "success" | "error"; text: string }
  - status: "success" | "error"
  - text: string
Returns void

Static isCloudRunning

isCloudRunning(): boolean

- Defined in src/obniz/ObnizApp.ts:14
Determine obniz.js is running on obniz Cloud or not.

Returns boolean

Static req

req(): any

- Defined in src/obniz/ObnizApp.ts:29
request object on obniz Cloud execution for webhook call.
```
// JavaScript example
const req = Obniz.App.req();
console.log(req.query);
console.log(req.body);
```
Returns any

Generated using TypeDoc