CreateUserAgentNotification()

Deprecated in 5.0.

Please use createUserAgentNotification() method of NetObj class instead.

CreateUserAgentNotification(object, message, startTime, endTime, showOnStartup): int

Creates user agent notification.

Table 1. Parameters

object

NetObj

Node or root object to send notification

message

String

Message to be sent to clients

startTime

Integer

Start time of notification delivery (UNIX timestamp)

endTime

Integer

End time of notification delivery (UNIX timestamp)

showOnStartup

Boolean

Optional. true to show notification on user agent startup. Defaults to false.

Return

New user agent notification id, or null if the script has no access to user agent notifications.

>>> CreateUserAgentNotification($node, "One time notification text", 0, 0);
14

>>> CreateUserAgentNotification($node, "Interval user agent notification text", time(), time()+86400);
15

>>> $node.createUserAgentNotification("Interval user agent notification text", time(), time()+86400);
16