Platforms to show: All Mac Windows Linux Cross-Platform
GrowlApplicationBridgeMBS.bestRegistrationDictionary as Dictionary
Function:
Obtains a registration dictionary, filled out to the best of GrowlApplicationBridge's knowledge.
Example:
Notes:
This method creates a registration dictionary as best GrowlApplicationBridge knows how.
First, GrowlApplicationBridge contacts the Growl delegate (if there is one) and gets the registration dictionary from that. If no such dictionary was obtained, GrowlApplicationBridge looks in your application's main bundle for an auto-discoverable registration dictionary file. If that doesn't exist either, this method returns nil.
Second, GrowlApplicationBridge calls registrationDictionaryByFillingInDictionary with whatever dictionary was obtained. The result of that method is the result of this method.
GrowlApplicationBridge uses this method when you call registerWithDictionary with nil.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
dim d as Dictionary = GrowlApplicationBridgeMBS.bestRegistrationDictionary
This method creates a registration dictionary as best GrowlApplicationBridge knows how.
First, GrowlApplicationBridge contacts the Growl delegate (if there is one) and gets the registration dictionary from that. If no such dictionary was obtained, GrowlApplicationBridge looks in your application's main bundle for an auto-discoverable registration dictionary file. If that doesn't exist either, this method returns nil.
Second, GrowlApplicationBridge calls registrationDictionaryByFillingInDictionary with whatever dictionary was obtained. The result of that method is the result of this method.
GrowlApplicationBridge uses this method when you call registerWithDictionary with nil.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
GrowlApplicationBridgeMBS.frameworkInfoDictionary as Dictionary
Function:
Returns the info dictionary for the Growl Framework.
Example:
Notes:
You can find e.g. the version in value for the CFBundleVersion key.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
dim d as Dictionary = GrowlApplicationBridgeMBS.frameworkInfoDictionary
break // check values in debugger
GrowlApplicationBridgeMBS.IsFrameworkLoaded as boolean
Function:
Whether the Growl Framework has been loaded.
Example:
Notes:
Returns true if framework is loaded.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
MsgBox str(GrowlApplicationBridgeMBS.IsFrameworkLoaded)
GrowlApplicationBridgeMBS.isGrowlRunning as boolean
Function:
Detects whether GrowlHelperApp is currently running.
Example:
Notes:
Cycles through the process list to find whether GrowlHelperApp is running and returns its findings.
Returns true if GrowlHelperApp is running, false otherwise.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
MsgBox str(GrowlApplicationBridgeMBS.isGrowlRunning)
Cycles through the process list to find whether GrowlHelperApp is running and returns its findings.
Returns true if GrowlHelperApp is running, false otherwise.
GrowlApplicationBridgeMBS.isMistEnabled as boolean
Function:
Gives the caller a fairly good indication of whether or not built-in notifications(Mist) will be used.
Notes:
Since this call makes use of isGrowlRunning it is entirely possible for this value to change between call and executing a notification dispatch
Returns true if Growl isn't reachable and the developer has not opted-out of Mist and the user hasn't set the global mist enable key to false.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
Since this call makes use of isGrowlRunning it is entirely possible for this value to change between call and executing a notification dispatch
Returns true if Growl isn't reachable and the developer has not opted-out of Mist and the user hasn't set the global mist enable key to false.
GrowlApplicationBridgeMBS.LoadFramework(path as folderitem) as boolean
Function:
Loads the growl framework.
Example:
Notes:
Framework should be version 1.3.
Please call this method before you use other Growl methods.
The framework can be inside your application bundle.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
if GrowlApplicationBridgeMBS.LoadFramework(SpecialFolder.Desktop.Child("Growl.framework")) then
MsgBox "OK"
else
MsgBox "Failed."
end if
Framework should be version 1.3.
Please call this method before you use other Growl methods.
The framework can be inside your application bundle.
GrowlApplicationBridgeMBS.notificationDictionaryByFillingInDictionary(notifDict as dictionary) as Dictionary
Function:
Tries to fill in missing keys in a notification dictionary.
Notes:
notifDict: The dictionary to fill in.
Returns the dictionary with the keys filled in. This will be a separate instance from notifDict.
This function examines the \a notifDict for missing keys, and tries to get them from the last known registration dictionary. As of 1.1, the keys that it will look for are: kApplicationName and kApplicationIcon
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
notifDict: The dictionary to fill in.
Returns the dictionary with the keys filled in. This will be a separate instance from notifDict.
This function examines the \a notifDict for missing keys, and tries to get them from the last known registration dictionary. As of 1.1, the keys that it will look for are: kApplicationName and kApplicationIcon
GrowlApplicationBridgeMBS.notifyWithDictionary(userInfo as dictionary)
Function:
Notifies using a userInfo dictionary suitable for passing to NSDistributedNotificationCenter.
Notes:
userInfo: The dictionary to notify with.
Before Growl 0.6, your application would have posted notifications using NSDistributedNotificationCenter by creating a userInfo dictionary with the notification data. This had the advantage of allowing you to add other data to the dictionary for programs besides Growl that might be listening.
This method allows you to use such dictionaries without being restricted to using NSDistributedNotificationCenter. The keys for this dictionary can be found in constants.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
userInfo: The dictionary to notify with.
Before Growl 0.6, your application would have posted notifications using NSDistributedNotificationCenter by creating a userInfo dictionary with the notification data. This had the advantage of allowing you to add other data to the dictionary for programs besides Growl that might be listening.
This method allows you to use such dictionaries without being restricted to using NSDistributedNotificationCenter. The keys for this dictionary can be found in constants.
GrowlApplicationBridgeMBS.notifyWithTitle(title as string, description as string, notificationName as string, iconData as memoryblock = nil, Priority as Integer = 0, isSticky as boolean = false, clickContext as Variant = nil)
Function:
Send a Growl notification.
Notes:
This is the preferred means for sending a Growl notification.
The notification name and at least one of the title and description are required (all three are preferred). All other parameters may be nil (or 0 or false as appropriate) to accept default values.
If using the Growl-WithInstaller framework, if Growl is not installed the user will be prompted to install Growl. If the user cancels, this method will have no effect until the next application session, at which time when it is called the user will be prompted again. The user is also given the option to not be prompted again. If the user does choose to install Growl, the requested notification will be displayed once Growl is installed and running.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
This is the preferred means for sending a Growl notification.
The notification name and at least one of the title and description are required (all three are preferred). All other parameters may be nil (or 0 or false as appropriate) to accept default values.
If using the Growl-WithInstaller framework, if Growl is not installed the user will be prompted to install Growl. If the user cancels, this method will have no effect until the next application session, at which time when it is called the user will be prompted again. The user is also given the option to not be prompted again. If the user does choose to install Growl, the requested notification will be displayed once Growl is installed and running.
title | The title of the notification displayed to the user. | |
description | The full description of the notification displayed to the user. | |
notifName | The internal name of the notification. Should be human-readable, as it will be displayed in the Growl preference pane. | |
iconData | Memoryblock object to show with the notification as its icon. If nil, the application's icon will be used instead. | |
priority | The priority of the notification. The default value is 0; positive values are higher priority and negative values are lower priority. Not all Growl displays support priority. | |
isSticky | If true, the notification will remain on screen until clicked. Not all Growl displays support sticky notifications. | |
clickContext | A context passed back to the Growl delegate if it implements growlNotificationWasClicked and the notification is clicked. Not all display plugins support clicking. The clickContext must be plist-encodable (completely of String, Array, Numbers, Dictionary, and Memoryblock types). |
See also:
Some examples using this method:
GrowlApplicationBridgeMBS.notifyWithTitle(title as string, description as string, notificationName as string, iconData as memoryblock, Priority as Integer, isSticky as boolean, clickContext as Variant, identifier as string)
Function:
Send a Growl notification.
Notes:
This is the preferred means for sending a Growl notification.
The notification name and at least one of the title and description are required (all three are preferred). All other parameters may be nil (or 0 or false as appropriate) to accept default values.
If using the Growl-WithInstaller framework, if Growl is not installed the user will be prompted to install Growl. If the user cancels, this method will have no effect until the next application session, at which time when it is called the user will be prompted again. The user is also given the option to not be prompted again. If the user does choose to install Growl, the requested notification will be displayed once Growl is installed and running.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
This is the preferred means for sending a Growl notification.
The notification name and at least one of the title and description are required (all three are preferred). All other parameters may be nil (or 0 or false as appropriate) to accept default values.
If using the Growl-WithInstaller framework, if Growl is not installed the user will be prompted to install Growl. If the user cancels, this method will have no effect until the next application session, at which time when it is called the user will be prompted again. The user is also given the option to not be prompted again. If the user does choose to install Growl, the requested notification will be displayed once Growl is installed and running.
title | The title of the notification displayed to the user. |
description | The full description of the notification displayed to the user. |
notifName | The internal name of the notification. Should be human-readable, as it will be displayed in the Growl preference pane. |
iconData | Memoryblock to show with the notification as its icon. If nil, the application's icon will be used instead. |
priority | The priority of the notification. The default value is 0; positive values are higher priority and negative values are lower priority. Not all Growl displays support priority. |
isSticky | If true, the notification will remain on screen until clicked. Not all Growl displays support sticky notifications. |
clickContext | A context passed back to the Growl delegate if it implements growlNotificationWasClicked and the notification is clicked. Not all display plugins support clicking. The clickContext must be plist-encodable (completely of String, Array, Numbers, Dictionary, and Memoryblock types). |
identifier | An identifier for this notification. Notifications with equal identifiers are coalesced. |
See also:
GrowlApplicationBridgeMBS.registerWithDictionary(regDict as dictionary = nil) as boolean
Function:
Register your application with Growl without setting a delegate.
Notes:
When you call this method with a dictionary, GrowlApplicationBridge registers your application using that dictionary. If you pass nil, GrowlApplicationBridge will ask the delegate (if there is one) for a dictionary, and if that doesn't work, it will look in your application's bundle for an auto-discoverable plist.
If you pass a dictionary to this method, it must include the kApplicationName key, unless a delegate is set.
This method is mainly an alternative to the delegate system introduced with Growl 0.6. Without a delegate, you cannot receive callbacks such as growlIsReady (since they are sent to the delegate). You can, however, set a delegate after registering without one.
This method was introduced in Growl.framework 0.7.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
When you call this method with a dictionary, GrowlApplicationBridge registers your application using that dictionary. If you pass nil, GrowlApplicationBridge will ask the delegate (if there is one) for a dictionary, and if that doesn't work, it will look in your application's bundle for an auto-discoverable plist.
If you pass a dictionary to this method, it must include the kApplicationName key, unless a delegate is set.
This method is mainly an alternative to the delegate system introduced with Growl 0.6. Without a delegate, you cannot receive callbacks such as growlIsReady (since they are sent to the delegate). You can, however, set a delegate after registering without one.
This method was introduced in Growl.framework 0.7.
GrowlApplicationBridgeMBS.registrationDictionaryByFillingInDictionary(regDict as dictionary) as Dictionary
Function:
Tries to fill in missing keys in a registration dictionary.
Notes:
This method examines the passed-in dictionary for missing keys, and tries to work out correct values for them. As of 0.7, it uses:
Keys are only filled in if missing; if a key is present in the dictionary, its value will not be changed.
This method was introduced in Growl.framework 0.7.
regDict: The dictionary to fill in.
Returns the dictionary with the keys filled in.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
This method examines the passed-in dictionary for missing keys, and tries to work out correct values for them. As of 0.7, it uses:
Key | Value |
kApplicationName | CFBundleExecutableName |
kApplicationIcon | The data of the icon of the application. |
App Location | The location of the application. |
kNotificationsDefault | kNotificationsDefault |
Keys are only filled in if missing; if a key is present in the dictionary, its value will not be changed.
This method was introduced in Growl.framework 0.7.
regDict: The dictionary to fill in.
Returns the dictionary with the keys filled in.
See also:
GrowlApplicationBridgeMBS.registrationDictionaryByFillingInDictionary(regDict as dictionary, restrictToKeys() as string) as Dictionary
Function:
Tries to fill in missing keys in a registration dictionary.
Notes:
This method examines the passed-in dictionary for missing keys, and tries to work out correct values for them. As of 0.7, it uses:
Only those keys that are listed in restrictToKeys array will be filled in. Other missing keys are ignored. Also, keys are only filled in if missing; if a key is present in the dictionary, its value will not be changed.
This method was introduced in Growl.framework 0.7.
regDict: The dictionary to fill in.
restrictToKeys: The keys to fill in. If nil, any missing keys are filled in.
Returns the dictionary with the keys filled in.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
This method examines the passed-in dictionary for missing keys, and tries to work out correct values for them. As of 0.7, it uses:
Key | Value |
kApplicationName | CFBundleExecutableName |
kApplicationIcon | The data of the icon of the application. |
App Location | The location of the application. |
kNotificationsDefault | kNotificationsDefault |
Only those keys that are listed in restrictToKeys array will be filled in. Other missing keys are ignored. Also, keys are only filled in if missing; if a key is present in the dictionary, its value will not be changed.
This method was introduced in Growl.framework 0.7.
regDict: The dictionary to fill in.
restrictToKeys: The keys to fill in. If nil, any missing keys are filled in.
Returns the dictionary with the keys filled in.
See also:
GrowlApplicationBridgeMBS.registrationDictionaryFromBundle(bundle as Variant = nil) as Dictionary
Function:
Looks in a bundle for a registration dictionary.
Example:
Notes:
Bundle must be an instance of NSBundleMBS class.
This method looks in a bundle for an auto-discoverable registration dictionary file using NSBundle methods. If it finds one, it loads the file using dictionaryWithContentsOfFile and returns the result.
If you pass nil as the bundle, the main bundle is examined.
This method does not attempt to clean up the dictionary in any way - for example, if it is missing the <code>GROWL_APP_NAME</code> key, the result will be missing it too. Use registrationDictionaryByFillingInDictionary to try to fill in missing keys.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Example:
dim d as Dictionary = GrowlApplicationBridgeMBS.registrationDictionaryFromBundle(NSBundleMBS.mainBundle)
Bundle must be an instance of NSBundleMBS class.
This method looks in a bundle for an auto-discoverable registration dictionary file using NSBundle methods. If it finds one, it loads the file using dictionaryWithContentsOfFile and returns the result.
If you pass nil as the bundle, the main bundle is examined.
This method does not attempt to clean up the dictionary in any way - for example, if it is missing the <code>GROWL_APP_NAME</code> key, the result will be missing it too. Use registrationDictionaryByFillingInDictionary to try to fill in missing keys.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
GrowlApplicationBridgeMBS.registrationDictionaryFromDelegate as Dictionary
Function:
Asks the delegate for a registration dictionary.
Notes:
If no delegate is set, or if the delegate's registrationDictionaryForGrowl method returns nil, this method returns nil.
This method does not attempt to clean up the dictionary in any way - for example, if it is missing the kApplicationName key, the result will be missing it too. Use registrationDictionaryByFillingInDictionary to try to fill in missing keys.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
If no delegate is set, or if the delegate's registrationDictionaryForGrowl method returns nil, this method returns nil.
This method does not attempt to clean up the dictionary in any way - for example, if it is missing the kApplicationName key, the result will be missing it too. Use registrationDictionaryByFillingInDictionary to try to fill in missing keys.
This method was introduced in Growl.framework 0.7.
Returns a registration dictionary.
GrowlApplicationBridgeMBS.reregisterGrowlNotifications
Function:
Reregister the notifications for this application.
Notes:
This method does not normally need to be called. If your application changes what notifications it is registering with Growl, call this method to have the Growl delegate's registrationDictionaryForGrowl method called again and the Growl registration information updated.
This method is now implemented using egisterWithDictionary.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
This method does not normally need to be called. If your application changes what notifications it is registering with Growl, call this method to have the Growl delegate's registrationDictionaryForGrowl method called again and the Growl registration information updated.
This method is now implemented using egisterWithDictionary.
GrowlApplicationBridgeMBS.shouldUseBuiltInNotifications as boolean
Function:
The current opt-in state of the framework's use of the Mist display style.
Notes:
Opt-out mechanism for the mist notification style in the event growl can't be reached.
If growl is unavailable due to not being installed or as a result of being turned off then this option can enable/disable a built-in fire and forget display style
Specifies whether or not the developer wants to opt-in (default) or opt out of the built-in Mist style in the event Growl is unreachable.
(Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
Opt-out mechanism for the mist notification style in the event growl can't be reached.
If growl is unavailable due to not being installed or as a result of being turned off then this option can enable/disable a built-in fire and forget display style
Specifies whether or not the developer wants to opt-in (default) or opt out of the built-in Mist style in the event Growl is unreachable.
(Read and Write computed property)
GrowlApplicationBridgeMBS.willRegisterWhenGrowlIsReady as boolean
Function:
Whether to register with Growl when Growl launches (or not).
Notes:
When Growl has started listening for notifications, it posts a GROWL_IS_READY notification on the Distributed Notification Center. GrowlApplicationBridge listens for this notification, using it to perform various tasks (such as calling your delegate's growlIsReady method, if it has one). If this method is called with true, one of those tasks will be to reregister with Growl (in the manner of reregisterGrowlNotifications).
This attribute is automatically set back to false (the default) after every GROWL_IS_READY notification.
Value: True, if you want GrowlApplicationBridge to register with Growl when next it is ready; false if not.
(Read and Write computed property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Growl | MBS MacExtras Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
When Growl has started listening for notifications, it posts a GROWL_IS_READY notification on the Distributed Notification Center. GrowlApplicationBridge listens for this notification, using it to perform various tasks (such as calling your delegate's growlIsReady method, if it has one). If this method is called with true, one of those tasks will be to reregister with Growl (in the manner of reregisterGrowlNotifications).
This attribute is automatically set back to false (the default) after every GROWL_IS_READY notification.
Value: True, if you want GrowlApplicationBridge to register with Growl when next it is ready; false if not.
(Read and Write computed property)
The items on this page are in the following plugins: MBS MacExtras Plugin.