← Back to branch summary

~xibo-maintainers/xibo/tempel

« back to all changes in this revision

Viewing changes to lib/Widget/Embedded.php

  • Committer: GitHub
  • Author(s): Dan Garner
  • Date: 2017-02-23 11:57:51 UTC
  • mfrom: (551.3.19)
  • Revision ID: git-v1:3dd6e41bcc903d9c60a0023623a01142526950c2
Merge pull request #236 from PeterMis/feature/test-suite-2

Feature/test suite 2

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/Widget/Embedded.php
34
34
    }
35
35
 
36
36
    /**
37
 
     * Add Media to the Database
 
37
     * Adds an Embedded Widget
 
38
     * @SWG\Post(
 
39
     *  path="/playlist/widget/embedded/{playlistId}",
 
40
     *  operationId="WidgetEmbeddedAdd",
 
41
     *  tags={"Widget"},
 
42
     *  summary="Add a Embedded Widget",
 
43
     *  description="Add a new Embedded Widget to the specified playlist",
 
44
     *  @SWG\Parameter(
 
45
     *      name="playlistId",
 
46
     *      in="path",
 
47
     *      description="The playlist ID to add an Embedded Widget",
 
48
     *      type="integer",
 
49
     *      required=true
 
50
     *   ),
 
51
     *  @SWG\Parameter(
 
52
     *      name="name",
 
53
     *      in="formData",
 
54
     *      description="Optional Widget Name",
 
55
     *      type="string",
 
56
     *      required=false
 
57
     *  ),
 
58
     *  @SWG\Parameter(
 
59
     *      name="duration",
 
60
     *      in="formData",
 
61
     *      description="The Widget Duration",
 
62
     *      type="integer",
 
63
     *      required=false
 
64
     *  ),
 
65
     *  @SWG\Parameter(
 
66
     *      name="useDuration",
 
67
     *      in="formData",
 
68
     *      description="(0, 1) Select 1 only if you will provide duration parameter as well",
 
69
     *      type="integer",
 
70
     *      required=false
 
71
     *  ),
 
72
     *  @SWG\Parameter(
 
73
     *      name="transparency",
 
74
     *      in="formData",
 
75
     *      description="Flag (0,1) - Should the HTML be shown with transparent background? - not available on Windows Clients",
 
76
     *      type="integer",
 
77
     *      required=false
 
78
     *   ),
 
79
     *  @SWG\Parameter(
 
80
     *      name="scaleContent",
 
81
     *      in="formData",
 
82
     *      description="Flag (0,1) - Should the embedded content be scaled along with the layout?",
 
83
     *      type="integer",
 
84
     *      required=false
 
85
     *   ),
 
86
     *  @SWG\Parameter(
 
87
     *      name="embedHtml",
 
88
     *      in="formData",
 
89
     *      description="HTML to embed",
 
90
     *      type="string",
 
91
     *      required=false
 
92
     *   ),
 
93
     *  @SWG\Parameter(
 
94
     *      name="embedScript",
 
95
     *      in="formData",
 
96
     *      description="HEAD content to Embed (including script tags)",
 
97
     *      type="string",
 
98
     *      required=false
 
99
     *   ),
 
100
     *  @SWG\Parameter(
 
101
     *      name="embedStyle",
 
102
     *      in="formData",
 
103
     *      description="Custom Style Sheets (CSS)",
 
104
     *      type="string",
 
105
     *      required=false
 
106
     *   ),
 
107
     *  @SWG\Response(
 
108
     *      response=201,
 
109
     *      description="successful operation",
 
110
     *      @SWG\Schema(ref="#/definitions/Widget"),
 
111
     *      @SWG\Header(
 
112
     *          header="Location",
 
113
     *          description="Location of the new widget",
 
114
     *          type="string"
 
115
     *      )
 
116
     *  )
 
117
     * )
38
118
     */
39
119
    public function add()
40
120
    {