Class ScreenController
The Screen Controller is a controller that allows data to be retrieved and updated within the Ayuda Platform.
Namespace: Ayuda.BMS.Splash.Areas.Pi.Controllers
Remarks
This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/Juice/Pi/Screen
Methods
GetAll()
Returns information about all screens.
Declaration
public JsonResult GetAll()Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array of instances of ScreenModel ScreenModels. |
GetByFaceIDs(Guid[])
Returns information about the screens attached to one or more faces.
Declaration
public JsonResult GetByFaceIDs(Guid[] faceIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | faceIds |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array of key value pairs. For each pair, the key is a guid, the value is an instance of the ScreenModel type with information about the screens, including the attached player's id. |
Update(Guid, String, String, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, String, String, Nullable<Boolean>, Nullable<Guid>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)
Updates a screen with the specified parameters.
Declaration
public JsonResult Update(Guid id, string name, string code, Guid? playerID, Guid? faceID, Guid? screenModelID, string deviceName, string manufacturer, bool? enablePlayback, Guid? screenCommandConfigurationID, int? pixelWidth, int? pixelHeight, int? xOrigin, int? yOrigin)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | Guid: The id of the screen to be updated. |
| System.String | name | String: The name of the screen (Optional). |
| System.String | code | String: The screen's code (Optional). |
| System.Nullable<System.Guid> | playerID | Guid: The id of the player associated to the screen (Optional). |
| System.Nullable<System.Guid> | faceID | Guid: The id of the face associated to the screen (Optional). |
| System.Nullable<System.Guid> | screenModelID | Guid: The id of the model associated to the screen (Optional). |
| System.String | deviceName | String: The name of the device (Optional). |
| System.String | manufacturer | String: The name of the manufacturer (Optional). |
| System.Nullable<System.Boolean> | enablePlayback | Boolean: Should screen allow playback (Optional). |
| System.Nullable<System.Guid> | screenCommandConfigurationID | Guid: Screen command configuration id (Optional). |
| System.Nullable<System.Int32> | pixelWidth | Integer: Width of the screen greater than zero (Optional). |
| System.Nullable<System.Int32> | pixelHeight | |
| System.Nullable<System.Int32> | xOrigin | Integer: The offset magnitude in x direction (Optional). |
| System.Nullable<System.Int32> | yOrigin | Integer: The offset magnitude in y direction (Optional). |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
|