postUICommand

Execute a command in the context of tv setup

Requires authentication as user

postUICommand

Request

post /UI/Command

Parameters

Name	In	Type	Default	Notes
*body	body	RunUICommand		RunUICommand

Responses

Status Code	Type	Description	Samples
200	UIViewInfo	Operation successful. Returning a UIViewInfo object.
400		Bad Request. Server cannot process request.
401		Unauthorized. Client needs to authenticate.
403		Forbidden. No permission for the reqested operation.
404		Resource not found or unavailable.
500		Server error.

Definitions

RunUICommand

Emby.Web.GenericUI.Api.Endpoints.RunUICommand

Name	Type	Notes
PageId	string
CommandId	string
Data	string
ItemId	string
ClientLocale	string

UIViewInfo

Emby.Web.GenericUI.Model.UIViewInfo

Name	Type	Notes
ViewId	string
PageId	string
Caption	string
SubCaption	string
PluginId	string
ViewType	UIViewType
ShowDialogFullScreen	boolean
IsInSequence	boolean
RedirectViewUrl	string
EditObjectContainer	IEditObjectContainer[]
Commands	UICommand[]
TabPageInfos	UITabPageInfo[]
IsPageChangeInfo	boolean

UIViewType

Emby.Web.GenericUI.Model.Enums.UIViewType

Enum Values

• RegularPage
• Dialog
• Wizard

IEditObjectContainer

see also MediaBrowser.Model.GenericEdit.IEditObjectContainer

Name	Type	Notes
Object	object
DefaultObject	object
TypeName	string

UICommand

Emby.Web.GenericUI.Model.UICommand

Name	Type	Notes
CommandType	UICommandType
CommandId	string
IsVisible	boolean
IsEnabled	boolean
Caption	string
SetFocus	boolean
ConfirmationPrompt	string

UICommandType

Emby.Web.GenericUI.Model.Enums.UICommandType

Enum Values

• Custom
• WizardCancel
• WizardBack
• WizardNext
• WizardFinish
• DialogCancel
• DialogOk
• PageSave
• PageBack
• WizardButton1
• WizardButton2
• WizardButton3

UITabPageInfo

Emby.Web.GenericUI.Model.UITabPageInfo

Name	Type	Notes
PageId	string
DisplayName	string
PluginId	string
Href	string
NavKey	string
Index	integer (int32)