plugins.finalcutpro.notifications.prowl.md

docs » plugins.finalcutpro.notifications.prowl

---

Prowl Notifications Plugin.

API Overview

• Functions - API calls offered directly by the extension
• init
• sendNotification
• update
• validateAPIKey
• Fields - Variables which can only be accessed from an object returned by a constructor
• apiKey
• apiValidated
• enabled

API Documentation

Functions

init

Signature	plugins.finalcutpro.notifications.prowl.init() -> none
Type	Function
Description	Initialises the plugin.
Parameters	None
Returns	None

sendNotification

Signature	plugins.finalcutpro.notifications.prowl.sendNotification(message, [title]) -> none
Type	Function
Description	Sends 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

update

Signature	plugins.finalcutpro.notifications.prowl.update() -> none
Type	Function
Description	Enables or disables Prowl Notifications depending on the user's preferences.
Parameters	None
Returns	None

validateAPIKey

Signature	plugins.finalcutpro.notifications.prowl.validateAPIKey(key) -> success, errorMessage
Type	Function
Description	Validates 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

Fields

apiKey

Signature	plugins.finalcutpro.notifications.prowl.apiKey <cp.prop: string>
Type	Field
Description	Prowl API Key

apiValidated

Signature	plugins.finalcutpro.notifications.prowl.apiValidated <cp.prop: boolean>
Type	Field
Description	Whether or not the API key has been validated.

enabled

Signature	plugins.finalcutpro.notifications.prowl.enabled <cp.prop: boolean>
Type	Field
Description	Whether or not the plugin has been enabled.