Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (39 loc) · 2.91 KB

plugins.finalcutpro.notifications.manager.md

File metadata and controls

50 lines (39 loc) · 2.91 KB
Raw

docs » plugins.finalcutpro.notifications.manager

Notifications Manager Plugin.

API Overview

  • Constants - Useful values which cannot be changed
  • manager
  • Variables - Configurable values
  • watchers
  • Functions - API calls offered directly by the extension
  • unwatch
  • watch

API Documentation

Constants

manager

Signature plugins.finalcutpro.notifications.manager -> table
Type Constant
Description Event Types

Variables

watchers

Signature plugins.finalcutpro.notifications.manager.watchers -> watcher
Type Variable
Description Watchers

Functions

unwatch

Signature plugins.finalcutpro.notifications.manager.unwatch(id) -> none
Type Function
Description Start Watchers
Parameters
  • id - The ID of the watcher to unwatch as string
Returns
  • None

watch

Signature plugins.finalcutpro.notifications.manager.watch(event) -> string
Type Function
Description Start Watchers
Parameters
  • events - Events to watch
Returns
  • The ID of the watcher as string