ONOTIFY.$setbadgecount()

Function group Execute on client Platform(s)
ONOTIFY NO All

Syntax

ONOTIFY.$setbadgecount(iCount[,&cErrorText,iBadgeColor,iBadgeTextColor])

Description

Sets the badge on the application icon to have the value iCount. Returns Boolean true for success, or false (and cErrorText) if an error occurs.

The parameters are as follows:

Parameter Description
iCount The count to display as the badge. Must be greater than zero. When running on Windows, a value greater than 99 is displayed as 99+.
cErrorText A character variable that receives text describing an error, if $setbadgecount() fails
iBadgeColor Windows only. The background color of the count badge. Defaults to styledbadgebackgroundcolor in the “system” section of appearance.json.
iBadgeTextColor Windows only. The text color of the count badge. Defaults to styledbadgetextcolor in the “system” section of appearance.json.