Description
Sets or appends to the user's comments for a page in your app's layout.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| comments | Text | Yes | Comments to assign to page |
| [append] | Boolean | No | Whether or not to append comments to any existing comments (default = false) |
| [index] | Number | No | Page index (default is the current page) |
Returns
No return value.
Examples
// set the user's comments for the current page
user.setComments("Some comments.");
// append additional comments on the 2nd page
// note: page indexes are zero-based
user.setComments("Some comments.", true, 1);
Remarks
Attention
You should always be careful not to replace any user comments.