prowl

Last updated last month

Prowl Notifications Plugin.

API Overview

API Documentation

Functions

init

Signature

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

Type

Function

Description

Initialises the plugin.

Parameters

Returns

Signature

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

Type

Function

Description

Sends a notification.

Parameters

Returns

update

Signature

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

Type

Function

Description

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

Parameters

Returns

Signature

plugins.finalcutpro.notifications.prowl.validateAPIKey(key) -> success, errorMessage

Type

Function

Description

Validates a Growl API Key

Parameters

Returns

Fields

apiKey

Signature

plugins.finalcutpro.notifications.prowl.apiKey <cp.prop: string>

Type

Field

Description

Prowl API Key

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.