Index (para-client 1.54.5 API)

A C D F G I L M N P R S T U V
All Classes and Interfaces|All Packages

A

addAppSetting(String, Object) - Method in class com.erudika.para.client.ParaClient: Adds or overwrites an app-specific setting.
addAppSettingAsync(String, Object) - Method in class com.erudika.para.client.ParaClient: Adds or overwrites an app-specific setting asynchronously.
addValidationConstraint(String, String, Constraint) - Method in class com.erudika.para.client.ParaClient: Add a new constraint for a given field.
addValidationConstraintAsync(String, String, Constraint) - Method in class com.erudika.para.client.ParaClient: Add a new constraint for a given field asynchronously.
approximately(long) - Method in class com.erudika.para.client.ParaClient: Returns the number of minutes, hours, months elapsed for a time delta (milliseconds).
approximatelyAsync(long) - Method in class com.erudika.para.client.ParaClient: Returns the number of minutes, hours, months elapsed for a time delta (milliseconds) asynchronously.
appSettings() - Method in class com.erudika.para.client.ParaClient: Returns the map containing app-specific settings.
appSettings(String) - Method in class com.erudika.para.client.ParaClient: Returns the value of a specific app setting (property).
appSettingsAsync() - Method in class com.erudika.para.client.ParaClient: Returns the map containing app-specific settings asynchronously.
appSettingsAsync(String) - Method in class com.erudika.para.client.ParaClient: Returns the value of a specific app setting (property) asynchronously.

C

close() - Method in class com.erudika.para.client.ParaClient: Closes the underlying Jersey client and releases resources.
com.erudika.para.client - package com.erudika.para.client
countChildren(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Count the total number of child objects for this object.
countChildrenAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Count the total number of child objects for this object asynchronously.
countLinks(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Count the total number of links between this object and another type of object.
countLinksAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Count the total number of links between this object and another type of object asynchronously.
create(P) - Method in class com.erudika.para.client.ParaClient: Persists an object to the data store.
createAll(List) - Method in class com.erudika.para.client.ParaClient: Saves multiple objects to the data store.
createAllAsync(List) - Method in class com.erudika.para.client.ParaClient: Saves multiple objects to the data store asynchronously.
createAsync(P) - Method in class com.erudika.para.client.ParaClient: Persists an object to the data store asynchronously.

D

delete(P) - Method in class com.erudika.para.client.ParaClient: Deletes an object permanently.
deleteAll(List) - Method in class com.erudika.para.client.ParaClient: Deletes multiple objects.
deleteAllAsync(List) - Method in class com.erudika.para.client.ParaClient: Deletes multiple objects asynchronously.
deleteAsync(P) - Method in class com.erudika.para.client.ParaClient: Deletes an object permanently asynchronously.
deleteChildren(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Deletes all child objects permanently.
deleteChildrenAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Deletes all child objects permanently asynchronously.

F

findById(String) - Method in class com.erudika.para.client.ParaClient: Simple id search.
findByIdAsync(String) - Method in class com.erudika.para.client.ParaClient: Simple id search asynchronously.
findByIds(List) - Method in class com.erudika.para.client.ParaClient: Simple multi id search.
findByIdsAsync(List) - Method in class com.erudika.para.client.ParaClient: Simple multi id search asynchronously.
findChildren(ParaObject, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Search through all child objects.
findChildrenAsync(ParaObject, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Search through all child objects.
findLinkedObjects(ParaObject, String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches through all linked objects in many-to-many relationships.
findLinkedObjectsAsync(ParaObject, String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches through all linked objects in many-to-many relationships asynchronously.
findNearby(String, String, int, double, double, Pager...) - Method in class com.erudika.para.client.ParaClient: Search for Address objects in a radius of X km from a given point.
findNearbyAsync(String, String, int, double, double, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects of a given type in a given radius asynchronously.
findNestedQuery(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches within a nested field.
findNestedQueryAsync(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches within a nested field.
findPrefix(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have a property which value starts with a given prefix.
findPrefixAsync(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have a property which value starts with a given prefix asynchronously.
findQuery(String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Simple query string search.
findQueryAsync(String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Simple query string search.
findSimilar(String, String, String[], String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have similar property values to a given text.
findSimilarAsync(String, String, String[], String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have similar property values to a given text.
findTagged(String, String[], Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects tagged with one or more tags.
findTaggedAsync(String, String[], Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects tagged with one or more tags asynchronously.
findTags(String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for Tag objects.
findTagsAsync(String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for Tag objects asynchronously.
findTermInList(String, String, List, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects having a property value that is in list of possible values.
findTermInListAsync(String, String, List, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects having a property value that is in list of possible values asynchronously.
findTerms(String, Map, boolean, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have properties matching some given values.
findTermsAsync(String, Map, boolean, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have properties matching some given values.
findWildcard(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have a property with a value matching a wildcard query.
findWildcardAsync(String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Searches for objects that have a property with a value matching a wildcard query asynchronously.
formatDate(String, Locale) - Method in class com.erudika.para.client.ParaClient: Formats a date in a specific format.
formatDateAsync(String, Locale) - Method in class com.erudika.para.client.ParaClient: Formats a date in a specific format asynchronously.

G

getAccessToken() - Method in class com.erudika.para.client.ParaClient: Returns the JWT access token if any.
getApiPath() - Method in class com.erudika.para.client.ParaClient: Returns the API request path.
getApp() - Method in class com.erudika.para.client.ParaClient: Returns the App for the current access key (appid).
getAppAsync() - Method in class com.erudika.para.client.ParaClient: Returns the App for the current access key (appid) asynchronously.
getChildren(ParaObject, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all child objects linked to this object.
getChildren(ParaObject, String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all child objects linked to this object.
getChildrenAsync(ParaObject, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all child objects linked to this object asynchronously.
getChildrenAsync(ParaObject, String, String, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all child objects linked to this object asynchronously.
getChunkSize() - Method in class com.erudika.para.client.ParaClient: Returns the batch chunk size.
getCount(String) - Method in class com.erudika.para.client.ParaClient: Counts indexed objects.
getCount(String, Map) - Method in class com.erudika.para.client.ParaClient: Counts indexed objects matching a set of terms/values.
getCountAsync(String) - Method in class com.erudika.para.client.ParaClient: Counts indexed objects asynchronously.
getCountAsync(String, Map) - Method in class com.erudika.para.client.ParaClient: Counts indexed objects matching a set of terms/values asynchronously.
getEndpoint() - Method in class com.erudika.para.client.ParaClient: Returns the endpoint URL.
getItems(String, Map, Pager...) - Method in class com.erudika.para.client.ParaClient: Converts a list of Maps to a List of ParaObjects, at a given path within the JSON tree structure.
getItemsFromList(List) - Method in class com.erudika.para.client.ParaClient: Deserializes ParaObjects from a JSON array (the "items:[]" field in search results).
getLinkedObjects(ParaObject, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all objects linked to the given one.
getLinkedObjectsAsync(ParaObject, String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns all objects linked to the given one.
getServerVersion() - Method in class com.erudika.para.client.ParaClient: Returns the Para server version.
getServerVersionAsync() - Method in class com.erudika.para.client.ParaClient: Returns the Para server version asynchronously.
getTimestamp() - Method in class com.erudika.para.client.ParaClient: Returns the current timestamp.
getTimestampAsync() - Method in class com.erudika.para.client.ParaClient: Returns the current timestamp asynchronously.
grantResourcePermission(String, String, EnumSet) - Method in class com.erudika.para.client.ParaClient: Grants a permission to a subject that allows them to call the specified HTTP methods on a given resource.
grantResourcePermission(String, String, EnumSet, boolean) - Method in class com.erudika.para.client.ParaClient: Grants a permission to a subject that allows them to call the specified HTTP methods on a given resource.
grantResourcePermissionAsync(String, String, EnumSet) - Method in class com.erudika.para.client.ParaClient: Grants a permission to a subject that allows them to call the specified HTTP methods on a given resource asynchronously.
grantResourcePermissionAsync(String, String, EnumSet, boolean) - Method in class com.erudika.para.client.ParaClient: Grants a permission to a subject that allows them to call the specified HTTP methods on a given resource asynchronously.

I

invokeDelete(String, Map, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a DELETE request to the Para API.
invokeDeleteAsync(String, Map, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a DELETE request to the Para API asynchronously.
invokeGet(String, Map, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a GET request to the Para API.
invokeGetAsync(String, Map, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a GET request to the Para API asynchronously.
invokePatch(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a PATCH request to the Para API.
invokePatchAsync(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a PATCH request to the Para API asynchronously.
invokePost(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a POST request to the Para API.
invokePostAsync(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a POST request to the Para API asynchronously.
invokePut(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a PUT request to the Para API.
invokePutAsync(String, Object, Class) - Method in class com.erudika.para.client.ParaClient: Invoke a PUT request to the Para API asynchronously.
isAllowedTo(String, String, String) - Method in class com.erudika.para.client.ParaClient: Checks if a subject is allowed to call method X on resource Y.
isAllowedToAsync(String, String, String) - Method in class com.erudika.para.client.ParaClient: Checks if a subject is allowed to call method X on resource Y asynchronously.
isLinked(ParaObject, ParaObject) - Method in class com.erudika.para.client.ParaClient: Checks if a given object is linked to this one.
isLinked(ParaObject, String, String) - Method in class com.erudika.para.client.ParaClient: Checks if this object is linked to another.
isLinkedAsync(ParaObject, ParaObject) - Method in class com.erudika.para.client.ParaClient: Checks if a given object is linked to this one asynchronously.
isLinkedAsync(ParaObject, String, String) - Method in class com.erudika.para.client.ParaClient: Checks if this object is linked to another asynchronously.

L

link(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Links an object to this one in a many-to-many relationship.
linkAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Links an object to this one in a many-to-many relationship asynchronously.
list(String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns a list all objects found for the given type.
listAsync(String, Pager...) - Method in class com.erudika.para.client.ParaClient: Returns a list all objects found for the given type asynchronously.

M

markdownToHtml(String) - Method in class com.erudika.para.client.ParaClient: Converts Markdown to HTML.
markdownToHtmlAsync(String) - Method in class com.erudika.para.client.ParaClient: Converts Markdown to HTML asynchronously.
me() - Method in class com.erudika.para.client.ParaClient: Returns a User or an App that is currently authenticated.
me(String) - Method in class com.erudika.para.client.ParaClient: Verifies a given JWT and returns the authenticated subject.
meAsync() - Method in class com.erudika.para.client.ParaClient: Returns a User or an App that is currently authenticated asynchronously.
meAsync(String) - Method in class com.erudika.para.client.ParaClient: Verifies a given JWT and returns the authenticated subject.

N

newId() - Method in class com.erudika.para.client.ParaClient: Generates a new unique id.
newIdAsync() - Method in class com.erudika.para.client.ParaClient: Generates a new unique id asynchronously.
newKeys() - Method in class com.erudika.para.client.ParaClient: Generates a new set of access/secret keys.
newKeysAsync() - Method in class com.erudika.para.client.ParaClient: Generates a new set of access/secret keys asynchronously.
noSpaces(String, String) - Method in class com.erudika.para.client.ParaClient: Converts spaces to dashes.
noSpacesAsync(String, String) - Method in class com.erudika.para.client.ParaClient: Converts spaces to dashes asynchronously.

P

pagerToParams(Pager...) - Method in class com.erudika.para.client.ParaClient: Converts a Pager object to query parameters.
ParaClient - Class in com.erudika.para.client: The Java REST client for communicating with a Para API server.
ParaClient(String, String) - Constructor for class com.erudika.para.client.ParaClient: Default constructor.

R

read(String) - Method in class com.erudika.para.client.ParaClient: Retrieves an object from the data store.
read(String, String) - Method in class com.erudika.para.client.ParaClient: Retrieves an object from the data store.
readAll(List) - Method in class com.erudika.para.client.ParaClient: Retrieves multiple objects from the data store.
readAllAsync(List) - Method in class com.erudika.para.client.ParaClient: Retrieves multiple objects from the data store asynchronously.
readAsync(String) - Method in class com.erudika.para.client.ParaClient: Retrieves an object from the data store asynchronously.
readAsync(String, String) - Method in class com.erudika.para.client.ParaClient: Retrieves an object from the data store asynchronously.
readEverything(Function) - Method in class com.erudika.para.client.ParaClient: Paginates through all objects and executes the provided function on the results.
readEverything(Function, int) - Method in class com.erudika.para.client.ParaClient: Paginates through all objects and executes the provided function on the results.
rebuildIndex() - Method in class com.erudika.para.client.ParaClient: Rebuilds the entire search index.
rebuildIndex(String) - Method in class com.erudika.para.client.ParaClient: Rebuilds the entire search index.
rebuildIndexAsync() - Method in class com.erudika.para.client.ParaClient: Rebuilds the entire search index asynchronously.
rebuildIndexAsync(String) - Method in class com.erudika.para.client.ParaClient: Rebuilds the entire search index asynchronously.
removeAppSetting(String) - Method in class com.erudika.para.client.ParaClient: Removes an app-specific setting.
removeAppSettingAsync(String) - Method in class com.erudika.para.client.ParaClient: Removes an app-specific setting asynchronously.
removeValidationConstraint(String, String, String) - Method in class com.erudika.para.client.ParaClient: Removes a validation constraint for a given field.
removeValidationConstraintAsync(String, String, String) - Method in class com.erudika.para.client.ParaClient: Removes a validation constraint for a given field asynchronously.
resourcePermissions() - Method in class com.erudika.para.client.ParaClient: Returns the permissions for all subjects and resources for current app.
resourcePermissions(String) - Method in class com.erudika.para.client.ParaClient: Returns only the permissions for a given subject (user) of the current app.
resourcePermissionsAsync() - Method in class com.erudika.para.client.ParaClient: Returns the permissions for all subjects and resources for current app asynchronously.
resourcePermissionsAsync(String) - Method in class com.erudika.para.client.ParaClient: Returns only the permissions for a given subject (user) of the current app asynchronously.
revokeAllResourcePermissions(String) - Method in class com.erudika.para.client.ParaClient: Revokes all permission for a subject.
revokeAllResourcePermissionsAsync(String) - Method in class com.erudika.para.client.ParaClient: Revokes all permission for a subject asynchronously.
revokeAllTokens() - Method in class com.erudika.para.client.ParaClient: Revokes all user tokens for a given user id.
revokeAllTokensAsync() - Method in class com.erudika.para.client.ParaClient: Revokes all user tokens for a given user id asynchronously.
revokeResourcePermission(String, String) - Method in class com.erudika.para.client.ParaClient: Revokes a permission for a subject, meaning they no longer will be able to access the given resource.
revokeResourcePermissionAsync(String, String) - Method in class com.erudika.para.client.ParaClient: Revokes a permission for a subject, meaning they no longer will be able to access the given resource asynchronously.

S

sendEmail(List, String, String, String, String) - Method in class com.erudika.para.client.ParaClient: Endpoint for sending transactional emails.
sendEmail(List, String, String, String, String, boolean, boolean, InputStream, String) - Method in class com.erudika.para.client.ParaClient: Endpoint for sending transactional emails.
sendEmailAsync(List, String, String, String, String) - Method in class com.erudika.para.client.ParaClient: Endpoint for sending transactional emails asynchronously.
sendEmailAsync(List, String, String, String, String, boolean, boolean, InputStream, String) - Method in class com.erudika.para.client.ParaClient: Endpoint for sending transactional emails asynchronously.
setAccessToken(String) - Method in class com.erudika.para.client.ParaClient: Sets the JWT access token.
setApiPath(String) - Method in class com.erudika.para.client.ParaClient: Sets the API request path.
setAppSettings(Map) - Method in class com.erudika.para.client.ParaClient: Overwrites all app-specific settings.
setAppSettingsAsync(Map) - Method in class com.erudika.para.client.ParaClient: Overwrites all app-specific settings asynchronously.
setChunkSize(int) - Method in class com.erudika.para.client.ParaClient: Sets the chunk size for batch CRUD operations.
setEndpoint(String) - Method in class com.erudika.para.client.ParaClient: Sets the host URL of the Para server.
signIn(String, String) - Method in class com.erudika.para.client.ParaClient: Takes an identity provider access token and fetches the user data from that provider.
signIn(String, String, boolean) - Method in class com.erudika.para.client.ParaClient: Takes an identity provider access token and fetches the user data from that provider.
signInAsync(String, String) - Method in class com.erudika.para.client.ParaClient: Takes an identity provider access token and fetches the user data from that provider asynchronously.
signInAsync(String, String, boolean) - Method in class com.erudika.para.client.ParaClient: Takes an identity provider access token and fetches the user data from that provider asynchronously.
signOut() - Method in class com.erudika.para.client.ParaClient: Clears the JWT access token but token is not revoked.
stripAndTrim(String) - Method in class com.erudika.para.client.ParaClient: Strips all symbols, punctuation, whitespace and control chars from a string.
stripAndTrimAsync(String) - Method in class com.erudika.para.client.ParaClient: Strips all symbols, punctuation, whitespace and control chars from a string asynchronously.

T

throwExceptionOnHTTPError(boolean) - Method in class com.erudika.para.client.ParaClient: Enable/disable exception throwing in ParaClient.
types() - Method in class com.erudika.para.client.ParaClient: Returns all registered types for this App.
typesAsync() - Method in class com.erudika.para.client.ParaClient: Returns all registered types for this App asynchronously.
typesCount() - Method in class com.erudika.para.client.ParaClient: Returns the number of objects for each existing type in this App.
typesCountAsync() - Method in class com.erudika.para.client.ParaClient: Returns the number of objects for each existing type in this App asynchronously.

U

unlink(ParaObject, String, String) - Method in class com.erudika.para.client.ParaClient: Unlinks an object from this one.
unlinkAll(ParaObject) - Method in class com.erudika.para.client.ParaClient: Unlinks all objects that are linked to this one.
unlinkAllAsync(ParaObject) - Method in class com.erudika.para.client.ParaClient: Unlinks all objects that are linked to this one asynchronously.
unlinkAsync(ParaObject, String, String) - Method in class com.erudika.para.client.ParaClient: Unlinks an object from this one asynchronously.
update(P) - Method in class com.erudika.para.client.ParaClient: Updates an object permanently.
updateAll(List) - Method in class com.erudika.para.client.ParaClient: Updates multiple objects.
updateAllAsync(List) - Method in class com.erudika.para.client.ParaClient: Updates multiple objects asynchronously.
updateAllPartially(BiFunction) - Method in class com.erudika.para.client.ParaClient: Performs a partial batch update (async) on all objects of given type.
updateAllPartially(BiFunction, int, int) - Method in class com.erudika.para.client.ParaClient: Performs a partial batch update on all objects of given type.
updateAsync(P) - Method in class com.erudika.para.client.ParaClient: Updates an object permanently asynchronously.

V

validationConstraints() - Method in class com.erudika.para.client.ParaClient: Returns the validation constraints map.
validationConstraints(String) - Method in class com.erudika.para.client.ParaClient: Returns the validation constraints map.
validationConstraintsAsync() - Method in class com.erudika.para.client.ParaClient: Returns the validation constraints map asynchronously.
validationConstraintsAsync(String) - Method in class com.erudika.para.client.ParaClient: Returns the validation constraints map asynchronously.
voteDown(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Downvote an object and register the vote in DB.
voteDown(ParaObject, String, Integer, Integer) - Method in class com.erudika.para.client.ParaClient: Downvote an object and register the vote in DB.
voteDownAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Downvote an object and register the vote in DB asynchronously.
voteDownAsync(ParaObject, String, Integer, Integer) - Method in class com.erudika.para.client.ParaClient: Downvote an object and register the vote in DB asynchronously.
voteUp(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Upvote an object and register the vote in DB.
voteUp(ParaObject, String, Integer, Integer) - Method in class com.erudika.para.client.ParaClient: Upvote an object and register the vote in DB.
voteUpAsync(ParaObject, String) - Method in class com.erudika.para.client.ParaClient: Upvote an object and register the vote in DB asynchronously.
voteUpAsync(ParaObject, String, Integer, Integer) - Method in class com.erudika.para.client.ParaClient: Upvote an object and register the vote in DB asynchronously.

A C D F G I L M N P R S T U V
All Classes and Interfaces|All Packages