---
title: "Introduction"
slug: "user-intro"
updated: 2025-11-06T18:46:06Z
published: 2025-11-06T18:46:06Z
canonical: "docs.doc-know.com/user-intro"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doc-know.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

### user

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 | Desktop | Web | Avatars |
| --- | --- | --- | --- | --- |
| [roles](http://docs.doc-know.com/v1/docs/user-roles) | Returns an array of all security roles the user belongs to | Yes | Yes | No |
| [rolesAvailable](http://docs.doc-know.com/v1/docs/user-rolesavailable) | Returns an array of all security roles supported by the runtime | Yes | Yes | No |
| [isPrep](http://docs.doc-know.com/v1/docs/user-isprep) | Returns whether or not the current user has the **prep** role | Yes | Yes | No |
| [isReader](http://docs.doc-know.com/v1/docs/user-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 | Desktop | Web | Avatars |
| --- | --- | --- | --- | --- |
| [alert](http://docs.doc-know.com/v1/docs/user-alert) | Displays a popup message to the user | Yes | Yes | No |
| [hasRole](http://docs.doc-know.com/v1/docs/user-hasrole) | Returns whether or not the user belongs to a specified security role | Yes | Yes | No |
| [blockIfEmpty](http://docs.doc-know.com/v1/docs/user-blockifempty) | Blocks the user from continuing if value(s) are missing | Yes | Yes | No |
| [blockIfValue](http://docs.doc-know.com/v1/docs/user-blockifvalue) | Blocks the user from continuing if a specific value is entered | Yes | Yes | No |
| [block](http://docs.doc-know.com/v1/docs/user-block) | Blocks the user from continuing for a specified reason | Yes | Yes | No |
| [getComments](http://docs.doc-know.com/v1/docs/user-getcomments) | Returns the user's comments for a page in your app's layout | Yes | Yes | No |
| [setComments](http://docs.doc-know.com/v1/docs/user-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.