Name

notify period, notifications.notifyperiod, kPMRPCNotificationsNotifyPeriod, kPMObserveNotificationsNotifyPeriod — Seconds to display notifications.

Synopsis

integer notifications.notifyperiod( );

Description

Seconds to display notifications.

Seconds before a queued trigger that a notification should be presented.

Changing the notify period does not affect notifications issued for currently queued triggers.

Returns

notify period is an integer. If notify period is omitted, the default 900 is used. notify period must be between 0 and 86400, inclusive.

Observable

Changes to notify period can be observed, without polling, using notifications.notifyperiod, kPMObserveNotificationsNotifyPeriod.

Security

notify period can be requested by any authenticated client.

Unauthenticated clients are authorized using the uk.co.dssw.powermanager.notifications.notifyperiod right. By default, any local process can request notify period.

Availablility

pmdctl

Examples

Example 92. C: notifications.notifyperiod

CFMutableDictionaryRef myRequest = PMRequestCreate(kCFAllocatorDefault,kPMRPCNotificationsNotifyPeriod);

Example 93. Objective-C: notifications.notifyperiod

DSSWPMRequest* myRequest = [DSSWPMRequest requestWithRequest:kPMRPCNotificationsNotifyPeriod];

Example 94. AppleScript: notifications.notifyperiod

tell application "Power Manager Scripting"
    set myResult to notify period of Notifications
end tell

Example 95. Shell: notifications.notifyperiod

./pmctl notifications.notifyperiod