Introduction

Prev Next

Description

The user object provides direct communication with the user of your app's visual layout experience.


Properties

Below is a list of properties supported by this object.

Name Description UWP Web Avatars
roles Returns an array of all security roles the user belongs to Yes Yes No
rolesAvailable Returns an array of all security roles supported by the runtime Yes Yes No
isPrep Returns whether or not the current user has the prep role Yes Yes No
isReader Returns whether or not the current user has the reader role Yes Yes No

Functions

Below is a list of functions supported by this object.

Name Description UWP Web Avatars
alert Displays a popup message to the user Yes Yes No
hasRole Returns whether or not the user belongs to a specified security role Yes Yes No
blockIfEmpty Blocks the user from continuing if value(s) are missing Yes Yes No
blockIfValue Blocks the user from continuing if a specific value is entered Yes Yes No
block Blocks the user from continuing for a specified reason Yes Yes No
getComments Returns the user's comments for a page in your app's layout Yes Yes No
setComments Sets or appends to the user's comments for a page in your app's layout Yes Yes No

Remarks

Use the alert function if you need to abruptly interrupt the user for some reason. They will not be able to continue until they recognize and dismiss your notification. This should be used cautiously.

The alert function is also a useful alternative to debug.log when building and testing your apps.