| All Verbs | /ShowQuantityMultipleEx |
|---|
"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 KeyQuantityColorInfo {
/** @param {{Key?:string,Quantity?:number,Color?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Key identifying a location */
Key;
/**
* @type {number}
* @description Quantity to show on display */
Quantity;
/**
* @type {string}
* @description HTML Color code (e.g. FF00FF) */
Color;
}
export class ShowQuantityMultipleEx extends ShowCommon {
/** @param {{Values?:KeyQuantityColorInfo[],ForceBlink?: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 {KeyQuantityColorInfo[]}
* @description Objects of what has to displayed */
Values = [];
/**
* @type {?boolean}
* @description Optional: Force blinking */
ForceBlink;
}
JavaScript ShowQuantityMultipleEx DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowQuantityMultipleEx HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowQuantityMultipleEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<DisplayHeader>false</DisplayHeader>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<ForceBlink>false</ForceBlink>
<Values>
<KeyQuantityColorInfo>
<Color>String</Color>
<Key>String</Key>
<Quantity>0</Quantity>
</KeyQuantityColorInfo>
</Values>
</ShowQuantityMultipleEx>