CommandPost Developer Guide
CommandPost Developer Guide
Download
User Guide
Facebook Group
Introduction
Getting Started
Introduction
Installation & Setup
Lua
Lua Overview
Memory Management
Contributing
Naming Conventions
CommandPost-App
CommandPost
Control CommandPost
AppleScript
URL Handler
Command Line Tool
Plugins
Plugins Overview
Internationalisation
Translating CommandPost
Final Cut Pro
Package Contents
FCPXML
Bundled Extensions
i18n
mimetypes
moses
resty
semver
slaxml
CommandPost API
cp
Bundled Plugins API
plugins
tangent
accessibility
console
language
quit
setup
webapp
commands
console
hud
language
administrator
advancedfeatures
finalcutpro
mediaimport
menuaction
pasteboard
proxyicon
timeline
tools
top
viewer
showtimecode
colorboard
colorwheels
video
zoom
manager
imessage
manager
prowl
pushover
open
streamdeck
text2speech
pasteboard
window
Hammerspoon API
hs
Powered by GitBook

pushover

Pushover Notifications Plugin.

API Overview

API Documentation

Functions

​init​

Signature

plugins.finalcutpro.notifications.pushover.init() -> none

Type

Function

Description

Initialises the plugin.

Parameters

​

Returns

​

​sendNotification​

Signature

plugins.finalcutpro.notifications.pushover.sendNotification(message, [title]) -> none

Type

Function

Description

Sends a notification.

Parameters

​

Returns

​

​update​

Signature

plugins.finalcutpro.notifications.pushover.update() -> none

Type

Function

Description

Enables or disables Pushover Notifications depending on the user's preferences.

Parameters

​

Returns

​

​validateAPIKeys​

Signature

plugins.finalcutpro.notifications.pushover.validateAPIKeys(userKey, appKey) -> success, errorMessage

Type

Function

Description

Validates a Pushover User & Application API Key

Parameters

​

Returns

​

Fields

​apiValidated​

Signature

plugins.finalcutpro.notifications.pushover.apiValidated <cp.prop: boolean>

Type

Field

Description

Whether or not the API keys have been validated.

​appAPIKey​

Signature

plugins.finalcutpro.notifications.pushover.appAPIKey <cp.prop: string>

Type

Field

Description

Application API Key

​enabled​

Signature

plugins.finalcutpro.notifications.pushover.enabled <cp.prop: boolean>

Type

Field

Description

Whether or not the plugin has been enabled.

​userAPIKey​

Signature

plugins.finalcutpro.notifications.pushover.userAPIKey <cp.prop: string>

Type

Field

Description

User API Key

Previous
prowl
Next
open
Last updated 3 years ago
Edit on GitHub
Contents
API Overview
API Documentation
Functions
Fields