| All Verbs | /Show/{Key}/{Color}/{Blink}/{Persistant} |
|---|
"use strict";
export class ShowCommon {
/** @param {{Color?:string,Persistant?:boolean,Delay?:number,Duration?:number,StockroomName?:string,Owner?:string,Unreliable?:boolean,DisplayHeader?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {boolean}
* @description When set to false, it turns off the same color in a previous position */
Persistant;
/**
* @type {?number}
* @description Optional: delay the execution of the command (in seconds) */
Delay;
/**
* @type {?number}
* @description Optional: duration of the show in seconds */
Duration;
/**
* @type {string}
* @description Optional: name of the stockroom where to show the position */
StockroomName;
/**
* @type {string}
* @description Optional: name of the owner of the color/command to allow color sharing */
Owner;
/**
* @type {?boolean}
* @description Optional: indicates if message shall be delivered in an unreliable way (faster) */
Unreliable;
/**
* @type {?boolean}
* @description Optional: indicates if the header shall be displayed */
DisplayHeader;
}
export class Show extends ShowCommon {
/** @param {{Key?:string,Blink?:boolean,Color?:string,Persistant?:boolean,Delay?:number,Duration?:number,StockroomName?:string,Owner?:string,Unreliable?:boolean,DisplayHeader?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Key identifying a location */
Key;
/**
* @type {boolean}
* @description Blinking or not */
Blink;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Show/{Key}/{Color}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Key: String,
Blink: False,
Color: String,
Persistant: False,
Delay: 0,
Duration: 0,
StockroomName: String,
Owner: String,
Unreliable: False,
DisplayHeader: False
}