Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

NSUserNotificationMBS.actionButtonTitle as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies the title of the action button displayed in the notification.
Notes:
This value should localized as it will be presented to the user. The string will be truncated to a length appropriate for display and the property will be modified to reflect the truncation.

Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.activationType as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies what caused a user notification to occur.
Notes:
This property specifies why the user notification was sent to to the NSUserNotificationCenterDelegateMBS didActivateNotification event. The supported values are described in constants.

Available in OS X v10.8 and later.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.actualDeliveryDate as date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: The date this notification was actually delivered.
Notes:
The notification center will set this value if a notification is put in the scheduled list and the delivery time arrives.

If the notification is delivered directly using the deliverNotification: method of the NSUserNotificationCenterMBS class, this value will be set to the deliveryDate value. If the deliveryDate value nil this value is set to the current date.

This value is used to sort the list of notifications in the user interface.

Available in OS X v10.8 and later.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.additionalActivationAction as NSUserNotificationActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 14.3 Yes No No Yes, macOS only No
Function: Queries which additional action was selected.
Notes:
For Mac OS X 10.10 and newer. Will not cause exception if called on older versions, but always return nil.

When a user selects an additional action that action will be set on the notification's additionalActivationAction property when passed into the delegate event didActivateNotification.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.contentImage as NSImageMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 13.5 Yes No No Yes, macOS only No
Function: Image shown in the content of the notification.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.deliveryDate as date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies when the notification should be delivered.
Notes:
The delivery date is specified in an absolute time.
After a notification is delivered, it may be presented to the user.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.deliveryRepeatInterval as NSDateComponentsMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies the date components that control how often a user notification is repeated.
Notes:
This value may be nil if the notification should not repeat.

The date component values are relative to the date the notification was delivered.

If the calendar value of the deliveryRepeatInterval is nil, the current calendar will be used to calculate the repeat interval. For example, if a notification should repeat every hour, set the hour property of the deliveryRepeatInterval to 1.

This value is ignored unless the user notification is scheduled with the NSUserNotificationCenterMBS object.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.deliveryTimeZone as NSTimeZoneMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specify the time zone to interpret the delivery date in.
Notes:
If this value is nil and the user switches time zones, the notification center will adjust the time of presentation to account for the time zone change.

If a notification should be delivered at a time in a specific time zone (regardless of whether the user switches time zones), set this value to the specific time zone, for example the current time zone.

Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.description as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Description of notification object for debugging.
Notes: (Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: The internal object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.hasActionButton as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies whether the notification displays an action button.
Notes:
Set to false if the notification has no action button. This will be the case for notifications that are purely for informational purposes and have no user action.

The default value is true.

Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.hasReplyButton as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 13.5 Yes No No Yes, macOS only No
Function: Set to true if the notification has a reply button.
Notes:
The default value is false. If both this and hasActionButton are true, the reply button will be shown.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.identifier as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 13.5 Yes No No Yes, macOS only No
Function: This identifier is used to uniquely identify a notification.
Notes:
A notification delivered with the same identifier as an existing notification will replace that notification, rather then display a new one.

Available in OS X 10.9 and newer.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.informativeText as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: The body text of the notification.
Notes:
This value should localized as it will be presented to the user. The string will be truncated to a length appropriate for display and the property will be modified to reflect the truncation.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.otherButtonTitle as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies a custom title for the close button in an alert-style notification.
Notes:
This value should localized as it will be presented to the user. The string will be truncated to a length appropriate for display and the property will be modified to reflect the truncation.

An empty string will cause the default localized text to be used.

Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.Presented as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies whether the user notification has been presented.
Notes:
In some cases, for example when your application is frontmost, the notification center may decide not to actually present a delivered notification. In that case, the value of this property will be false. It will be set to true if the notification was presented according to user preferences.

Available in OS X v10.8 and later.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.remote as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies whether the remote was generated by a push notification.
Notes:
If this property is true then the user notification was generated by a push notification (that is, remotely); if false it was generated locally.
Available in OS X v10.8 and later.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.response as NSAttributedStringMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 13.5 Yes No No Yes, macOS only No
Function: The response text.
Notes:
When a notification has been responded to, the NSUserNotificationCenter event didActivateNotification will be called with the notification with the activationType set to NSUserNotificationActivationTypeReplied and the response set on the response property.
(Read only property)

Feedback, Comments & Corrections

NSUserNotificationMBS.responsePlaceholder as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 13.5 Yes No No Yes, macOS only No
Function: Optional placeholder for inline reply field.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.soundName as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies the name of the sound to play when the notification is delivered.
Notes:
Passing the NSUserNotificationDefaultSoundName constant causes the default notification center sound to be played.
A value of nil means no sound is played.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.subtitle as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies the subtitle of the notification.
Notes:
This value should localized as it will be presented to the user. The string will be truncated to a length appropriate for display and the property will be modified to reflect the truncation.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.title as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Specifies the title of the notification.
Notes:
This value should localized as it will be presented to the user. The string will be truncated to a length appropriate for display and the property will be modified to reflect the truncation.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

NSUserNotificationMBS.userInfo as dictionary
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property User Notifications MBS MacFrameworks Plugin 12.3 Yes No No Yes, macOS only No
Function: Application-specific user info that can be attached to the notification.
Example:
dim u as new NSUserNotificationMBS
dim d as new dictionary
d.value("Key") = "Value"
u.userinfo = d
Notes:
All items must be property list types or an exception will be thrown.
The userInfo content must be of reasonable serialized size (less than 1k) or an exception will be thrown.
Available in OS X v10.8 and later.
(Read and Write property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS MacFrameworks Plugin.




Links
MBS Xojo blog