plugins.finalcutpro.notifications.pushover

Pushover Notifications Plugin.

---

API Overview

Functions - API calls offered directly by the extension

• init
• sendNotification
• update
• validateAPIKeys

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

• apiValidated
• appAPIKey
• enabled
• userAPIKey

---

API Documentation

Functions

init

Signature	plugins.finalcutpro.notifications.pushover.init() -> none
Type	Function
Description	Initialises the plugin.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 107

---

sendNotification

Signature	plugins.finalcutpro.notifications.pushover.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
Notes	None
Examples	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 121

---

update

Signature	plugins.finalcutpro.notifications.pushover.update() -> none
Type	Function
Description	Enables or disables Pushover Notifications depending on the user's preferences.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 82

---

validateAPIKeys

Signature	plugins.finalcutpro.notifications.pushover.validateAPIKeys(userKey, appKey) -> success, errorMessage
Type	Function
Description	Validates a Pushover User & Application API Key
Parameters	userKey - The User API Key as a string appKey - The Application API Key as a string
Returns	success - true if successful otherwise false errorMessage - a string containing any error messages
Notes	None
Examples	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 40

---

Fields

apiValidated

Signature	plugins.finalcutpro.notifications.pushover.apiValidated <cp.prop: boolean>
Type	Field
Description	Whether or not the API keys have been validated.
Notes	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 30

---

appAPIKey

Signature	plugins.finalcutpro.notifications.pushover.appAPIKey <cp.prop: string>
Type	Field
Description	Application API Key
Notes	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 25

---

enabled

Signature	plugins.finalcutpro.notifications.pushover.enabled <cp.prop: boolean>
Type	Field
Description	Whether or not the plugin has been enabled.
Notes	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 35

---

userAPIKey

Signature	plugins.finalcutpro.notifications.pushover.userAPIKey <cp.prop: string>
Type	Field
Description	User API Key
Notes	None
Source	src/plugins/finalcutpro/notifications/pushover.lua line 20

---

---