| All Verbs | /ShowQuantityMultiple/{Keys}/{Color}/{Quantity}/{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 ShowQuantityMultiple extends ShowCommon {
/** @param {{Keys?:string[],Quantity?:number,ForceBlink?:boolean,Effect?:number,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 Keys array identifying the locations */
Keys = [];
/**
* @type {number}
* @description Quantity: number of LED to show */
Quantity;
/**
* @type {?boolean}
* @description Optional: Force blinking */
ForceBlink;
/**
* @type {?number}
* @description Animated effect selection: 0 = Always ON (no effect), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW */
Effect;
}
JavaScript ShowQuantityMultiple DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowQuantityMultiple/{Keys}/{Color}/{Quantity}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Keys":["String"],"Quantity":0,"ForceBlink":false,"Effect":0,"Color":"String","Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false,"DisplayHeader":false}