docs » cp.apple.finalcutpro.export.ReplaceAlert


Replace Alert

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

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.export.ReplaceAlert.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`

Constructors

new

Signature cp.apple.finalcutpro.export.ReplaceAlert.new(app) -> ReplaceAlert
Type Constructor
Description Creates a new Replace Alert object.
Parameters
  • app - The `cp.apple.finalcutpro` object.
Returns
  • A new ReplaceAlert object.

Fields

isShowing

Signature cp.apple.finalcutpro.export.ReplaceAlert.isShowing <cp.prop: boolean; read-only>
Type Field
Description Is the Replace File alert showing?

Methods

app

Signature cp.apple.finalcutpro.export.ReplaceAlert:app() -> App
Type Method
Description Returns the App instance representing Final Cut Pro.
Parameters
  • None
Returns
  • App

getTitle

Signature `cp.apple.finalcutpro.export.ReplaceAlert:getTitle() -> string nil` </span>
Type Method
Description The title of the Replace Alert window or nil.
Parameters
  • None
Returns
  • The title of the Replace Alert window as a string or `nil`.

hide

Signature cp.apple.finalcutpro.export.ReplaceAlert:hide() -> none
Type Method
Description Hides the Replace Alert.
Parameters
  • None
Returns
  • None

parent

Signature cp.apple.finalcutpro.export.ReplaceAlert:parent() -> object
Type Method
Description Returns the Parent object.
Parameters
  • None
Returns
  • The parent object.

pressCancel

Signature cp.apple.finalcutpro.export.ReplaceAlert:pressCancel() -> cp.apple.finalcutpro.export.ReplaceAlert
Type Method
Description Presses the Cancel button.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ReplaceAlert` object for method chaining.

pressReplace

Signature cp.apple.finalcutpro.export.ReplaceAlert:pressReplace() -> cp.apple.finalcutpro.export.ReplaceAlert
Type Method
Description Presses the Replace button.
Parameters
  • None
Returns
  • The `cp.apple.finalcutpro.export.ReplaceAlert` object for method chaining.

UI

Signature cp.apple.finalcutpro.export.ReplaceAlert:UI() -> axuielementObject
Type Method
Description Returns the Replace Alert Accessibility Object
Parameters
  • None
Returns
  • An `axuielementObject` or `nil`

results matching ""

    No results matching ""