#plugins.finalcutpro.notifications.ifttt

IFTTT Notifications Plugin.

Author: JFtechOfficial


#API Overview

Functions - API calls offered directly by the extension

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


#API Documentation

#Functions

Signatureplugins.finalcutpro.notifications.ifttt.init() -> none
TypeFunction
DescriptionInitialises the plugin.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 63

Signatureplugins.finalcutpro.notifications.ifttt.sendNotification(message, [title]) -> none
TypeFunction
DescriptionSends 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
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 77

Signatureplugins.finalcutpro.notifications.ifttt.update() -> none
TypeFunction
DescriptionEnables or disables ifttt Notifications depending on the user's preferences.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 38

#Fields

Signatureplugins.finalcutpro.notifications.ifttt.appAPIKey <cp.prop: string>
TypeField
DescriptionApplication API Key
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 28

Signatureplugins.finalcutpro.notifications.ifttt.enabled <cp.prop: boolean>
TypeField
DescriptionWhether or not the plugin has been enabled.
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 33

Signatureplugins.finalcutpro.notifications.ifttt.userAPIKey <cp.prop: string>
TypeField
DescriptionUser API Key
NotesNone
Sourcesrc/plugins/finalcutpro/notifications/ifttt.lua line 23