# plugins.finalcutpro.notifications.ifttt

IFTTT Notifications Plugin.

Author: JFtechOfficial


# API Overview

Functions - API calls offered directly by the extension

  • init
  • sendNotification
  • update

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

  • appAPIKey
  • enabled
  • userAPIKey

# API Documentation

# Functions

# init

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

# sendNotification

Signature plugins.finalcutpro.notifications.ifttt.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/ifttt.lua line 77

# update

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

# Fields

# appAPIKey

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

# enabled

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

# userAPIKey

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