Laserfiche.Repository.Api.Client.V2  1.0.2
Classes | Public Member Functions | Properties | List of all members
TagDefinitionsClient Class Reference

The Laserfiche Repository Tag Definitions API client. More...

Inheritance diagram for TagDefinitionsClient:
BaseClient ITagDefinitionsClient

Public Member Functions

virtual async Task< TagDefinition > GetTagDefinitionAsync (GetTagDefinitionParameters parameters, CancellationToken cancellationToken=default(CancellationToken))
 Returns a single tag definition object. More...
 
virtual async Task< TagDefinitionCollectionResponse > ListTagDefinitionsAsync (ListTagDefinitionsParameters parameters, CancellationToken cancellationToken=default(CancellationToken))
 Returns the tag definitions associated with a repository. More...
 
async Task ListTagDefinitionsForEachAsync (Func< TagDefinitionCollectionResponse, Task< bool >> callback, ListTagDefinitionsParameters parameters, int? maxPageSize=null, CancellationToken cancellationToken=default)
 Returns a collection of tag definitions using paging. Page results are returned to the callback . More...
 
async Task< TagDefinitionCollectionResponse > ListTagDefinitionsNextLinkAsync (string nextLink, int? maxPageSize=null, CancellationToken cancellationToken=default)
 Returns a collection of tag definitions using a nextlink. More...
 
 TagDefinitionsClient (HttpClient httpClient)
 

Properties

bool ReadResponseAsString [get, set]
 

Detailed Description

The Laserfiche Repository Tag Definitions API client.

Member Function Documentation

◆ GetTagDefinitionAsync()

virtual async Task<TagDefinition> GetTagDefinitionAsync ( GetTagDefinitionParameters  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinevirtual

Returns a single tag definition object.

  • Returns a single tag definition.
  • Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.
  • Allowed OData query options: Select
  • Required OAuth scope: repository.Read
Parameters
parametersParameters for the request.
cancellationTokenA cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
A single tag definition.
Exceptions
ApiExceptionA server side error occurred.

Implements ITagDefinitionsClient.

◆ ListTagDefinitionsAsync()

virtual async Task<TagDefinitionCollectionResponse> ListTagDefinitionsAsync ( ListTagDefinitionsParameters  parameters,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinevirtual

Returns the tag definitions associated with a repository.

  • Returns all tag definitions in the repository.
  • Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry.
  • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
  • Required OAuth scope: repository.Read
Parameters
parametersParameters for the request.
cancellationTokenA cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
A collection of tag definitions.
Exceptions
ApiExceptionA server side error occurred.

Implements ITagDefinitionsClient.

◆ ListTagDefinitionsForEachAsync()

async Task ListTagDefinitionsForEachAsync ( Func< TagDefinitionCollectionResponse, Task< bool >>  callback,
ListTagDefinitionsParameters  parameters,
int?  maxPageSize = null,
CancellationToken  cancellationToken = default 
)
inline

Returns a collection of tag definitions using paging. Page results are returned to the callback .

Parameters
callbackA 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.
parametersParameters for the request.
maxPageSizeOptionally specify the maximum number of items to retrieve.
cancellationTokenA cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exceptions
ApiExceptionA server side error occurred.

Implements ITagDefinitionsClient.

◆ ListTagDefinitionsNextLinkAsync()

async Task<TagDefinitionCollectionResponse> ListTagDefinitionsNextLinkAsync ( string  nextLink,
int?  maxPageSize = null,
CancellationToken  cancellationToken = default 
)
inline

Returns a collection of tag definitions using a nextlink.

Parameters
nextLinkA url that allows retrieving the next subset of the requested collection.
maxPageSizeOptionally specify the maximum number of items to retrieve.
cancellationTokenOptional cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
A collection of tag definitions.
Exceptions
ApiExceptionA server side error occurred.

Implements ITagDefinitionsClient.

The documentation for this class was generated from the following files: