getComments

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

Returns the user's comments for a page in your app's layout.

Input Parameters

Name	Type	Required	Description
[index]	Number	No	Page index (default is the current page)

Returns

Type: Text

Returns the user's comments for the specified page in your app's layout.

Examples

// display the user's comments for the current page in the debugger
debug.log(user.getComments());

// display the user's comments for the 2nd page in the debugger
// note: page indexes are zero-based
debug.log(user.getComments(1));

Remarks

Reasons for getting the user's comments include:

Page indexes are zero-based. This means the first page will have an index value of 0 and the third page will have an index value of 2.

Zero-Based Indexing

Zero-based indexing seems strange at first, but it's how programming languages (i.e. Javascript) work with collections of things.