UGC comment filtering and pagination options
To paginate or filter a list of flat or threaded comments, use the SimpleCommentsFilter class in the Java Content Interaction Libraries (CIL) for UGC.
| Filter method | Description | Use in flat comments? | Use in threaded comments? |
|---|---|---|---|
withTop | Filters the number of root-level comments to return to the number specified. Do not use this filter to count comments. | yes | yes, but only applies to the root level |
withSkip | Skips the specified number of root-level comments. This filter is intended for pagination purposes. Do not use this filter to count comments. | yes | yes, but only applies to the root level |
withDepth | Expands the specified number of reply levels in threaded comments. A value less than zero causes all reply levels to be expanded. | no | yes |
withStatuses | Filters comments to only comments that have one of the specified statuses. | yes | yes |
withMetaValues | Filters comments to only comments that have all of the specified metadata key-value pairs. | yes | yes |
withStartCreationDate | Filters root-level comments to only comments that were created on or after the specified date. | yes | yes, but only applies to the root level |
withEndCreationDate | Filters root-level comments to only comments that were created on or before the specified date. | yes | yes, but only applies to the root level |
withStartModificationDate | Filters root-level comments to only comments that were last modified on or after the specified date. | yes | yes, but only applies to the root level |
withEndModificationDate | Filters root-level comments to only comments that were last modified on or before the specified date. | yes | yes, but only applies to the root level |
withStartModerationDate | Filters root-level comments to only comments that were last moderated on or after the specified date. | yes | yes, but only applies to the root level |
withEndModerationDate | Filters root-level comments to only comments that were last moderated on or before the specified date. | yes | yes, but only applies to the root level |
withUserId | Filters root-level comments to only comments created by the user with the specified ID. | yes | yes, but only applies to the root level |