public interface TagDefinitionsClient
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<WTagInfo> |
getTagDefinitionById(String repoId,
Integer tagId,
String culture,
String select)
- Returns a single tag definition.
|
CompletableFuture<ODataValueContextOfIListOfWTagInfo> |
getTagDefinitions(String repoId,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
- Returns all tag definitions in the repository.
|
CompletableFuture<Void> |
getTagDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback,
Integer maxPageSize,
String repoId,
String prefer,
String culture,
String select,
String orderby,
Integer top,
Integer skip,
Boolean count)
Provides the functionality to iteratively (i.e.
|
CompletableFuture<ODataValueContextOfIListOfWTagInfo> |
getTagDefinitionsNextLink(String nextLink,
Integer maxPageSize)
Returns the next subset of the requested collection, using a nextlink url.
|
CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagDefinitions(String repoId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
repoId - The requested repository ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.CompletableFuture<ODataValueContextOfIListOfWTagInfo> getTagDefinitionsNextLink(String nextLink, Integer maxPageSize)
nextLink - A url that allows retrieving the next subset of the requested collection.maxPageSize - Optionally specify the maximum number of items to retrieve.CompletableFuture<Void> getTagDefinitionsForEach(Function<CompletableFuture<ODataValueContextOfIListOfWTagInfo>,CompletableFuture<Boolean>> callback, Integer maxPageSize, String repoId, String prefer, String culture, String select, String orderby, Integer top, Integer skip, Boolean count)
callback - 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.repoId - The requested repository ID.prefer - An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag.select - Limits the properties returned in the result.orderby - Specifies the order in which items are returned. The maximum number of expressions is 5.top - Limits the number of items returned from a collection.skip - Excludes the specified number of items of the queried collection from the result.count - Indicates whether the total count of items within a collection are returned in the result.CompletableFuture<WTagInfo> getTagDefinitionById(String repoId, Integer tagId, String culture, String select)
repoId - The requested repository ID.tagId - The requested tag definition ID.culture - An optional query parameter used to indicate the locale that should be used for formatting.
The value should be a standard language tag.select - Limits the properties returned in the result.Copyright © 2022. All rights reserved.