Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

ShowEffect

import 'package:servicestack/servicestack.dart';

class ShowCommon implements IConvertible
{
    /**
    * HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    String? Color;

    /**
    * 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)
    bool? Persistant;

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    // @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    int? Delay;

    /**
    * Optional: duration of the show in seconds
    */
    // @ApiMember(Description="Optional: duration of the show in seconds")
    int? Duration;

    /**
    * Optional: name of the stockroom where to show the position
    */
    // @ApiMember(Description="Optional: name of the stockroom where to show the position")
    String? StockroomName;

    /**
    * 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")
    String? Owner;

    /**
    * 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)")
    bool? Unreliable;

    /**
    * Optional: indicates if the header shall be displayed
    */
    // @ApiMember(Description="Optional: indicates if the header shall be displayed")
    bool? DisplayHeader;

    ShowCommon({this.Color,this.Persistant,this.Delay,this.Duration,this.StockroomName,this.Owner,this.Unreliable,this.DisplayHeader});
    ShowCommon.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Color = json['Color'];
        Persistant = json['Persistant'];
        Delay = json['Delay'];
        Duration = json['Duration'];
        StockroomName = json['StockroomName'];
        Owner = json['Owner'];
        Unreliable = json['Unreliable'];
        DisplayHeader = json['DisplayHeader'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Color': Color,
        'Persistant': Persistant,
        'Delay': Delay,
        'Duration': Duration,
        'StockroomName': StockroomName,
        'Owner': Owner,
        'Unreliable': Unreliable,
        'DisplayHeader': DisplayHeader
    };

    getTypeName() => "ShowCommon";
    TypeContext? context = _ctx;
}

class ShowEffect extends ShowCommon implements IConvertible
{
    /**
    * Key identifying a location
    */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    String? Key;

    /**
    * 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)
    int? Effect;

    ShowEffect({this.Key,this.Effect});
    ShowEffect.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Key = json['Key'];
        Effect = json['Effect'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Key': Key,
        'Effect': Effect
    });

    getTypeName() => "ShowEffect";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'clouddemo.pickeos.com', types: <String, TypeInfo> {
    'ShowCommon': TypeInfo(TypeOf.Class, create:() => ShowCommon()),
    'ShowEffect': TypeInfo(TypeOf.Class, create:() => ShowEffect()),
});

Dart ShowEffect DTOs

POST /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowEffect 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>
  <Effect>0</Effect>
  <Key>String</Key>
</ShowEffect>