public class TemplateDefinitionsClientImpl extends ApiClient implements TemplateDefinitionsClient
baseUrl, httpClient, httpRequestHandler, objectMapper| Constructor and Description |
|---|
TemplateDefinitionsClientImpl(String baseUrl,
kong.unirest.UnirestInstance httpClient,
com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler) |
| Modifier and Type | Method and Description |
|---|---|
WTemplateInfo |
getTemplateDefinitionById(ParametersForGetTemplateDefinitionById parameters)
- Returns a single template definition (including field definitions, if relevant).
- Provide a template definition ID, and get the single template definition associated with that ID. |
ODataValueContextOfIListOfWTemplateInfo |
getTemplateDefinitions(ParametersForGetTemplateDefinitions parameters)
- Returns all template definitions (including field definitions) in the repository.
|
void |
getTemplateDefinitionsForEach(Function<ODataValueContextOfIListOfWTemplateInfo,Boolean> callback,
Integer maxPageSize,
ParametersForGetTemplateDefinitions parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfWTemplateInfo |
getTemplateDefinitionsNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
ODataValueContextOfIListOfTemplateFieldInfo |
getTemplateFieldDefinitions(ParametersForGetTemplateFieldDefinitions parameters)
- Returns the field definitions assigned to a template definition.
- Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. |
ODataValueContextOfIListOfTemplateFieldInfo |
getTemplateFieldDefinitionsByTemplateName(ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)
- Returns the field definitions assigned to a template definition.
- Provide a template definition name, and get a paged listing of the field definitions assigned to that template. |
void |
getTemplateFieldDefinitionsByTemplateNameForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback,
Integer maxPageSize,
ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfTemplateFieldInfo |
getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
void |
getTemplateFieldDefinitionsForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback,
Integer maxPageSize,
ParametersForGetTemplateFieldDefinitions parameters)
Provides the functionality to iteratively (i.e.
|
ODataValueContextOfIListOfTemplateFieldInfo |
getTemplateFieldDefinitionsNextLink(String nextLink,
int maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
public TemplateDefinitionsClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)
public ODataValueContextOfIListOfWTemplateInfo getTemplateDefinitions(ParametersForGetTemplateDefinitions parameters)
TemplateDefinitionsClientgetTemplateDefinitions in interface TemplateDefinitionsClientparameters - An object of type ParametersForGetTemplateDefinitions which encapsulates the parameters of getTemplateDefinitions method.ODataValueContextOfIListOfWTemplateInfo The return valuepublic ODataValueContextOfIListOfWTemplateInfo getTemplateDefinitionsNextLink(String nextLink, int maxPageSize)
TemplateDefinitionsClientgetTemplateDefinitionsNextLink in interface TemplateDefinitionsClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.ODataValueContextOfIListOfWTemplateInfo The return valuepublic void getTemplateDefinitionsForEach(Function<ODataValueContextOfIListOfWTemplateInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateDefinitions parameters)
TemplateDefinitionsClientgetTemplateDefinitions, and apply a function on the response of each iteration.getTemplateDefinitionsForEach in interface TemplateDefinitionsClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForGetTemplateDefinitions which encapsulates the parameters of getTemplateDefinitions method.public ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsByTemplateName(ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)
TemplateDefinitionsClientgetTemplateFieldDefinitionsByTemplateName in interface TemplateDefinitionsClientparameters - An object of type ParametersForGetTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of getTemplateFieldDefinitionsByTemplateName method.ODataValueContextOfIListOfTemplateFieldInfo The return valuepublic ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsByTemplateNameNextLink(String nextLink, int maxPageSize)
TemplateDefinitionsClientgetTemplateFieldDefinitionsByTemplateNameNextLink in interface TemplateDefinitionsClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.ODataValueContextOfIListOfTemplateFieldInfo The return valuepublic void getTemplateFieldDefinitionsByTemplateNameForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateFieldDefinitionsByTemplateName parameters)
TemplateDefinitionsClientgetTemplateFieldDefinitionsByTemplateName, and apply a function on the response of each iteration.getTemplateFieldDefinitionsByTemplateNameForEach in interface TemplateDefinitionsClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForGetTemplateFieldDefinitionsByTemplateName which encapsulates the parameters of getTemplateFieldDefinitionsByTemplateName method.public ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitions(ParametersForGetTemplateFieldDefinitions parameters)
TemplateDefinitionsClientgetTemplateFieldDefinitions in interface TemplateDefinitionsClientparameters - An object of type ParametersForGetTemplateFieldDefinitions which encapsulates the parameters of getTemplateFieldDefinitions method.ODataValueContextOfIListOfTemplateFieldInfo The return valuepublic ODataValueContextOfIListOfTemplateFieldInfo getTemplateFieldDefinitionsNextLink(String nextLink, int maxPageSize)
TemplateDefinitionsClientgetTemplateFieldDefinitionsNextLink in interface TemplateDefinitionsClientnextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.ODataValueContextOfIListOfTemplateFieldInfo The return valuepublic void getTemplateFieldDefinitionsForEach(Function<ODataValueContextOfIListOfTemplateFieldInfo,Boolean> callback, Integer maxPageSize, ParametersForGetTemplateFieldDefinitions parameters)
TemplateDefinitionsClientgetTemplateFieldDefinitions, and apply a function on the response of each iteration.getTemplateFieldDefinitionsForEach in interface TemplateDefinitionsClientcallback - A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.maxPageSize - Optionally specify the maximum number of items to retrieve.parameters - An object of type ParametersForGetTemplateFieldDefinitions which encapsulates the parameters of getTemplateFieldDefinitions method.public WTemplateInfo getTemplateDefinitionById(ParametersForGetTemplateDefinitionById parameters)
TemplateDefinitionsClientgetTemplateDefinitionById in interface TemplateDefinitionsClientparameters - An object of type ParametersForGetTemplateDefinitionById which encapsulates the parameters of getTemplateDefinitionById method.WTemplateInfo The return valueCopyright © 2025. All rights reserved.