public class GetPublicPeople extends GetCollection
Implements GetPublicPeople Retrieves list of people in a shared directory Example incoming { "headers": { "jwtclaim": "a claim", "db": "MAIL",
"operationId": "getPublicPeople" }, "replicaid": "4825858200514BB3",
"apiName": "MAIL", "filepath": "DemoMail.nsf", "title": "Demo Mail" } Example result (one entry in array) { "@unid":
"AB1D2BBAA300928D482585920051153F", "@noteid": 2794, "@index": "3.2", "$3":
"P", "FullName": "[Peter Pan, sample]" }
AsyncDominoBase.RequestTypeapiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx| Constructor and Description |
|---|
GetPublicPeople() |
| Modifier and Type | Method and Description |
|---|---|
void |
process(DbRequestParameters<io.vertx.core.json.JsonObject> request)
processPayload returns a list of Contacts.
|
getDbRequestParametersaccessControlCheck, 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, validationCheckclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcustomValidator, preflightpublic void process(DbRequestParameters<io.vertx.core.json.JsonObject> request) throws java.lang.Exception
processPayload returns a list of Contacts. The API takes four optional parameters passed in through the incoming object.
count How many Contacts to return skip How many Contact entries to skip (for paging) startswith Filter Contact entries by beginning of the name directoryid Name of the directory that contains the entry. If omitted main addressbook is used
process in interface AsyncDominoBase<io.vertx.core.json.JsonObject>process in class GetCollectionrequest - java.lang.Exception - Anything that can go wrong, will go wrong