#plugins.finalcutpro.notifications.prowl

Prowl Notifications Plugin.

#API Overview

Functions - API calls offered directly by the extension

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

#API Documentation

#Functions

Signatureplugins.finalcutpro.notifications.prowl.init() -> none
TypeFunction
DescriptionInitialises the plugin.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 89
Signatureplugins.finalcutpro.notifications.prowl.sendNotification(message, [title]) -> none
TypeFunction
DescriptionSends a notification.
Parameters
  • message - The message you want to send as a string.
  • [title] - An optional Title for the message as a string.
Returns
  • success - true if successful otherwise false
  • errorMessage - a string containing any error messages
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 103
Signatureplugins.finalcutpro.notifications.prowl.update() -> none
TypeFunction
DescriptionEnables or disables Prowl Notifications depending on the user's preferences.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 64
Signatureplugins.finalcutpro.notifications.prowl.validateAPIKey(key) -> success, errorMessage
TypeFunction
DescriptionValidates a Growl API Key
Parameters
  • key - The API key as string
Returns
  • success - true if successful otherwise false
  • errorMessage - a string containing any error messages
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 25

#Fields

Signatureplugins.finalcutpro.notifications.prowl.apiKey <cp.prop: string>
TypeField
DescriptionProwl API Key
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 59
Signatureplugins.finalcutpro.notifications.prowl.apiValidated <cp.prop: boolean>
TypeField
DescriptionWhether or not the API key has been validated.
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 20
Signatureplugins.finalcutpro.notifications.prowl.enabled <cp.prop: boolean>
TypeField
DescriptionWhether or not the plugin has been enabled.
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/prowl.lua line 54

© Copyright 2025 LateNite Films Pty Ltd. All rights reserved.