com.hcl.domino.keep.dbrequests.pim

Class GetLabels

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

com.hcl.domino.keep.dbrequests.pim.GetLabels

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.json.JsonObject>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.json.JsonObject>

@MinimumAcl(value=READER)
 @AclAttributes(value=ReadPublicDocuments)
public class GetLabels
extends AsyncDominoJNXJson

Implements OperationId: getLabels Retrieve list folder label, document count, system labels and unread count Example Payload: { "includeSystemLabels":false, "includeUnreadCount":true, "UUID":"d4c8f5a9-57a2-472e-a74a-f441e6d94791", "headers":{ "jwtclaim":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 .eyJpc3MiOiJUaGUgRGVtbyBXaXp6YXJkIiwic3ViIjoiTWFudWVsIExvcmVuem8gTGVybWEvUGhpbGlwcGluZXMvUE5QSENMIiwiaWF0I joxNTk3MTU4ODQ3LCJleHAiOjE1OTcxODA0NDcsImF1ZCI6IkRvbWlubyJ9.Ykv3ZZqy7nQqFNPiEVAsTm0fXiI4to4IUJ_BCTKaSMI", "db":"MAIL", "operationId":"getLabels", "mergeChunks":"true", "sourceForEventBus":"com.hcl.domino.keep.handlers.pim.DefaultPimHandler", "tags":"mail" }, "replicaid":"482585590040A750", "apiName":"MAIL", "filepath":"DemoMail.nsf", "title":"DemoMail" } Example Result: [ { "FolderId": "A4D87D90E1B19842852564FF006DED4E", "View": "($All)", "DocumentCount": 32, "UnreadCount": 26, "DisplayName": "All Documents" }, { "FolderId": "38D46BF5E8F08834852564B500129B2C", "View": "($Inbox)", "DocumentCount": 8, "UnreadCount": 7, "DisplayName": "Inbox" }, { "FolderId": "0AE756FA362D1B654825859900480D26", "View": "Sample Folder", "DocumentCount": 2, "UnreadCount": 1, "DisplayName": "Sample Folder" } ]

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

AsyncDominoBase.RequestType

Field Summary

Fields inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

apiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx

Constructor Summary

Constructors

Constructor and Description
GetLabels()

Method Summary

Modifier and Type	Method and Description
void	process(DbRequestParameters<io.vertx.core.json.JsonObject> request) Process request collectedFolders - map for all collected folders systemFolderNames - map for system folders to show external name systemLabels - map for system folders to be shown if includeSystemLabels, true

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

getDbRequestParameters

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

accessControlCheck, dontCallProcessPayload, emitterToObserver, getActualDatabaseName, getApiName, getAppTags, getBarbican, getEventbusId, getKeepDbInfo, getRequestType, getSubscriber, getUser, getUserForMetrics, isProcessPayloadRequired, isWorkInProgress, processDominoRequest, recordAppMetrics, setApiName, setBarbican, setDbFileName, setKeepDbInfo, setProcessPayloadRequired, setRequestParams, setRequestType, setSubscriber, setUser, setVertx, subscribe, validateDqlAccess, validateOpenAccess, validationCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

customValidator, preflight

Constructor Detail

GetLabels

public GetLabels()

Method Detail

process

public void process(DbRequestParameters<io.vertx.core.json.JsonObject> request)
             throws java.lang.Exception

Process request collectedFolders - map for all collected folders systemFolderNames - map for system folders to show external name systemLabels - map for system folders to be shown if includeSystemLabels, true

Parameters:

request - DbRequestParameters granting access to session and database

Throws:

java.lang.Exception