plugins.finalcutpro.notifications.imessage.md

docs » plugins.finalcutpro.notifications.imessage

---

iMessage Notifications Plugin.

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
• enabled
• target

API Documentation

Functions

init

Signature	plugins.finalcutpro.notifications.imessage.init() -> none
Type	Function
Description	Initialises the plugin.
Parameters	None
Returns	None

sendNotification

Signature	plugins.finalcutpro.notifications.imessage.sendNotification(message) -> none
Type	Function
Description	Sends a notification.
Parameters	message - The message you want to send as a string.
Returns	None

update

Signature	plugins.finalcutpro.notifications.imessage.update() -> none
Type	Function
Description	Enables or disables iMessage Notifications depending on the user's preferences.
Parameters	None
Returns	None

Fields

enabled

Signature	plugins.finalcutpro.notifications.imessage.enabled <cp.prop: boolean>
Type	Field
Description	Whether or not the plugin has been enabled.

target

Signature	plugins.finalcutpro.notifications.imessage.target <cp.prop: string>
Type	Field
Description	A string containing a mobile number or Apple ID