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

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

Signature

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

Type

Function

Description

Validates a Pushover User & Application API Key

Parameters

Returns

Fields

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.

Signature

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

Type

Field

Description

User API Key