#cp.apple.finalcutpro.workflowextensions.CommandPostWindow

The CommandPost Workflow Extension Window.

#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

Fields - Variables which can only be accessed from an object returned by a constructor

Methods - API calls which can only be made on an object returned by a constructor


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow.matches(element) -> boolean`
Type	Function
Description	Checks to see if an element matches what we think it should be.
Parameters	element - An `axuielementObject` to check.
Returns	`true` if matches otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 27


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow(app) -> CommandPostWindow`
Type	Constructor
Description	Creates a new CommandPost Workflow Extension window object.
Parameters	app - The `cp.apple.finalcutpro` object.
Returns	A new `CommandPostWindow` object.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 41


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow.reloadButton <cp.ui.Button>`
Type	Field
Description	The Reload Button within a stalled Workflow Extension.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 60


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:doHide() -> cp.rx.go.Statement`
Type	Method
Description	A `Statement` that attempts to hide the CommandPost Workflow Extension window.
Parameters	None
Returns	The `Statement`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 162


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A `Statement` that attempts to show the CommandPost Workflow Extension window.
Parameters	None
Returns	The `Statement`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 126


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:hasStalled() -> boolean`
Type	Method
Description	Has the Workflow Extension stalled?
Parameters	None
Returns	`true` if stalled, otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 86


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:hide() -> CommandPostWindow`
Type	Method
Description	Attempts to hide the CommandPost Workflow Extension window.
Parameters	None
Returns	The same `CommandPostWindow`, for chaining.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 143


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:reload() -> none`
Type	Method
Description	Press the Reload Button.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 71


Signature	`cp.apple.finalcutpro.workflowextensions.CommandPostWindow:show() -> CommandPostWindow`
Type	Method
Description	Attempts to show the CommandPost Workflow Extension window.
Parameters	None
Returns	The same `CommandPostWindow`, for chaining.
Notes	If the Workflow Extension has stalled, this method will restart it.
Examples	None
Source	src/extensions/cp/apple/finalcutpro/workflowextensions/CommandPostWindow.lua line 99