TemplatesApi

Summary

Members	Descriptions
public TemplatesDto Templates()	This function will return a list of templates that are available to the user.
public TemplatesDto Templates( TemplatesUriParameterBuilder templatesUriParameterBuilder)	This function will return a TemplatesDto object that contains a list of templates that match the criteria specified in the TemplatesUriParameterBuilder object.
public TemplateDto Template(string collectionName, string templateId)	This function will return a TemplateDto object from the API.
public StatsDto TemplateStats(string collectionName, string templateId)	This function will return a StatsDto object that contains the number of documents that have been indexed using the specified template.
public LogsDto TemplateLogs(string collectionName, string templateId)	This function returns a list of logs for a specific template.
public LogsDto TemplateLogs(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)	This function returns a list of logs for a specific template.
private readonly string _requestUriBase
private Uri TemplatesUri()	It returns a new Uri object that is the base URI for the templates endpoint
private Uri TemplatesUri( TemplatesUriParameterBuilder templatessUriParameterBuilder)	It takes a TemplatesUriParameterBuilder object as a parameter and returns a Uri object.
private Uri TemplateUri(string collectionName, string templateId)	It returns a URI for a specific template in a specific collection
private Uri TemplateStatsUri(string collectionName, string templateId)	This function returns a Uri that can be used to get the stats for a template
private Uri TemplateLogsUri(string collectionName, string templateId)	This function returns a Uri for the logs of a template
private Uri TemplateLogsUri(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)	This function returns a Uri for the logs of a template

Members

public TemplatesDto Templates()

This function will return a list of templates that are available to the user.

Returns

A TemplatesDto object

public TemplatesDto Templates( TemplatesUriParameterBuilder templatesUriParameterBuilder)

This function will return a TemplatesDto object that contains a list of templates that match the criteria specified in the TemplatesUriParameterBuilder object.

Parameters

• TemplatesUriParameterBuilder This is a class that contains all the parameters that can be passed to the API.

Returns

A TemplatesDto object.

public TemplateDto Template(string collectionName, string templateId)

This function will return a TemplateDto object from the API.

Parameters

• collectionName The name of the collection you want to create the template in.

• templateId The id of the template you want to retrieve.

Returns

A TemplateDto object

public StatsDto TemplateStats(string collectionName, string templateId)

This function will return a StatsDto object that contains the number of documents that have been indexed using the specified template.

Parameters

• collectionName The name of the collection you want to get the stats for.

• templateId The id of the template you want to get stats for.

Returns

A StatsDto object

public LogsDto TemplateLogs(string collectionName, string templateId)

This function returns a list of logs for a specific template.

Parameters

• collectionName The name of the collection you want to get the logs for.

• templateId The id of the template you want to get the logs for.

Returns

A list of logs for a specific template.

public LogsDto TemplateLogs(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)

This function returns a list of logs for a specific template.

Parameters

• collectionName The name of the collection you want to get the logs for.

• templateId The id of the template you want to get the logs for.

• TemplatesUriParameterBuilder This is a class that contains all the parameters that can be passed to the API.

Returns

A LogsDto object

private readonly string _requestUriBase

private Uri TemplatesUri()

It returns a new Uri object that is the base URI for the templates endpoint

private Uri TemplatesUri( TemplatesUriParameterBuilder templatessUriParameterBuilder)

It takes a TemplatesUriParameterBuilder object as a parameter and returns a Uri object.

Parameters

• TemplatesUriParameterBuilder A class that builds the query string parameters for the templates endpoint.

private Uri TemplateUri(string collectionName, string templateId)

It returns a URI for a specific template in a specific collection

Parameters

• collectionName The name of the collection that the template belongs to.

• templateId The name of the template you want to use.

private Uri TemplateStatsUri(string collectionName, string templateId)

This function returns a Uri that can be used to get the stats for a template

Parameters

• collectionName The name of the collection you want to use.

• templateId The template ID of the template you want to get stats for.

private Uri TemplateLogsUri(string collectionName, string templateId)

This function returns a Uri for the logs of a template

Parameters

• collectionName The name of the collection that the template belongs to.

• templateId The ID of the template you want to get logs for.

private Uri TemplateLogsUri(string collectionName, string templateId, TemplatesUriParameterBuilder templatesUriParameterBuilder)

This function returns a Uri for the logs of a template

Parameters

• collectionName The name of the collection that the template belongs to.

• templateId The id of the template you want to get logs for.

• TemplatesUriParameterBuilder This is a class that builds the query string parameters for the request.