| All Verbs | /ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant} |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class ShowOnLedControllerEx implements JsonSerializable
{
public function __construct(
/** @description Led Controller Address */
// @ApiMember(Description="Led Controller Address", IsRequired=true)
/** @var string */
public string $LCAddress='',
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
/** @var string */
public string $Color='',
/** @description Pixel number */
// @ApiMember(Description="Pixel number", IsRequired=true)
/** @var int */
public int $Pixel=0,
/** @description Pixel width */
// @ApiMember(Description="Pixel width", IsRequired=true)
/** @var int */
public int $Width=0,
/** @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 */
// @ApiMember(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", IsRequired=true)
/** @var int */
public int $Effect=0,
/** @description When set to false, it turns off the same color in a previous position */
// @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
/** @var bool|null */
public ?bool $Persistant=null,
/** @description Optional: delay the execution of the command (in seconds) */
// @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
/** @var int|null */
public ?int $Delay=null,
/** @description Optional: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
/** @var int|null */
public ?int $Duration=null,
/** @description Optional: name of the stockroom where the area is located */
// @ApiMember(Description="Optional: name of the stockroom where the area is located")
/** @var string */
public string $StockroomName='',
/** @description Optional: name of the owner of the color/command to allow color sharing */
// @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
/** @var string */
public string $Owner='',
/** @description Optional: indicates if message shall be delivered in an unreliable way (faster) */
// @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
/** @var bool|null */
public ?bool $Unreliable=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['LCAddress'])) $this->LCAddress = $o['LCAddress'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['Pixel'])) $this->Pixel = $o['Pixel'];
if (isset($o['Width'])) $this->Width = $o['Width'];
if (isset($o['Effect'])) $this->Effect = $o['Effect'];
if (isset($o['Persistant'])) $this->Persistant = $o['Persistant'];
if (isset($o['Delay'])) $this->Delay = $o['Delay'];
if (isset($o['Duration'])) $this->Duration = $o['Duration'];
if (isset($o['StockroomName'])) $this->StockroomName = $o['StockroomName'];
if (isset($o['Owner'])) $this->Owner = $o['Owner'];
if (isset($o['Unreliable'])) $this->Unreliable = $o['Unreliable'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->LCAddress)) $o['LCAddress'] = $this->LCAddress;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->Pixel)) $o['Pixel'] = $this->Pixel;
if (isset($this->Width)) $o['Width'] = $this->Width;
if (isset($this->Effect)) $o['Effect'] = $this->Effect;
if (isset($this->Persistant)) $o['Persistant'] = $this->Persistant;
if (isset($this->Delay)) $o['Delay'] = $this->Delay;
if (isset($this->Duration)) $o['Duration'] = $this->Duration;
if (isset($this->StockroomName)) $o['StockroomName'] = $this->StockroomName;
if (isset($this->Owner)) $o['Owner'] = $this->Owner;
if (isset($this->Unreliable)) $o['Unreliable'] = $this->Unreliable;
return empty($o) ? new class(){} : $o;
}
}
PHP ShowOnLedControllerEx 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 /ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowOnLedControllerEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Effect>0</Effect>
<LCAddress>String</LCAddress>
<Owner>String</Owner>
<Persistant>false</Persistant>
<Pixel>0</Pixel>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<Width>0</Width>
</ShowOnLedControllerEx>