WAX Unity Web3 Suite
AtomicAssets
AtomicAssets
  • Getting Started
  • Installation
    • WebGL Installation
  • Examples
    • Unity Example
    • Filtered assets avilable for trading
    • AccountExample
    • BurnsExample
    • CollectionsExample
    • OffersExample
    • SchemasExample
    • TemplatesExample
    • TransfersExample
  • API Docs
    • AtomicAssetsApiFactory
    • Accounts
      • AccountsApi
        • AccountCollectionDto
          • DataDto
            • SchemasDto
            • TemplatesDto
        • AccountDto
          • DataDto
            • CollectionsDto
            • TemplatesDto
        • AccountsDto
          • DataDto
      • AccountsUriParameterBuilder
    • Assets
      • AssetsApi
        • AssetDto
          • DataDto
            • BackedTokensDto
            • CollectionDto
            • FormatDto
            • SchemaDto
            • ImmutableDataDto
            • TemplateDto
        • AssetsDto
          • DataDto
            • BackedTokensDto
            • CollectionDto
            • SchemaDto
              • FormatDto
            • TemplateDto
              • ImmutableDataDto
      • AssetsUriParameterBuilder
    • Burns
      • BurnsApi
        • BurnDto
          • DataDto
            • CollectionsDto
            • TemplatesDto
        • BurnsDto
          • DataDto
      • BurnsUriParameterBuilder
    • Collections
      • CollectionsApi
        • CollectionDto
          • DataDto
        • CollectionsDto
          • DataDto
      • CollectionsUriParameterBuilder
    • Config
      • ConfigApi
        • ConfigDto
    • Offers
      • OffersApi
        • OfferDto
          • DataDto
            • AssetDto
              • BackedTokensDto
              • CollectionDto
              • SchemaDto
                • FormatDto
              • TemplateDto
                • ImmutableDataDto
        • OffersDto
          • DataDto
            • AssetDto
              • BackedTokensDto
              • CollectionDto
              • SchemaDto
                • FormatDto
              • TemplateDto
                • ImmutableDataDto
      • OffersUriParameterBuilder
    • Schemas
      • SchemasApi
        • SchemaDto
          • DataDto
            • CollectionDto
            • FormatDto
        • SchemasDto
          • DataDto
            • CollectionDto
            • FormatDto
      • SchemasUriParameterBuilder
    • Templates
      • TemplatesApi
        • TemplateDto
          • DataDto
            • CollectionDto
            • SchemaDto
              • FormatDto
        • TemplatesDto
          • DataDto
            • CollectionDto
            • SchemaDto
              • FormatDto
      • TemplatesUriParameterBuilder
    • Transfers
      • TransfersApi
        • TransfersDto
          • DataDto
            • AssetDto
              • BackedTokensDto
              • CollectionDto
              • SchemaDto
                • FormatDto
              • TemplateDto
                • ImmutableDataDto
      • TransfersUriParameterBuilder
    • StatsDto
      • DataDto
    • LogsDto
      • DataDto
    • Core
      • HttpRequestBuilder
      • HttpResponseMessageExtension
Powered by GitBook
On this page
  • Summary
  • Members
Edit on GitHub
  1. API Docs
  2. Templates

TemplatesApi

PreviousTemplatesNextTemplateDto

Last updated 2 years ago

Summary

Members
Descriptions

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

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

This function will return a TemplateDto object from the API.

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

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

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

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

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

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

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

This function returns a Uri for the logs of a template

This function returns a Uri for the logs of a template

Members

public ()

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

Returns

A TemplatesDto object

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.

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

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

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.

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

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

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.

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.

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.

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.

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.

public ()

public ( templatesUriParameterBuilder)

public (string collectionName, string templateId)

public (string collectionName, string templateId)

public (string collectionName, string templateId)

public (string collectionName, string templateId, templatesUriParameterBuilder)

private readonly string

private Uri ()

private Uri ( templatessUriParameterBuilder)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId, templatesUriParameterBuilder)

public ( templatesUriParameterBuilder)

public (string collectionName, string templateId)

public (string collectionName, string templateId)

public (string collectionName, string templateId)

public (string collectionName, string templateId, templatesUriParameterBuilder)

private readonly string

private Uri ()

private Uri ( templatessUriParameterBuilder)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId)

private Uri (string collectionName, string templateId, templatesUriParameterBuilder)

TemplatesDto
Templates
TemplatesDto
TemplatesUriParameterBuilder
Templates
TemplateDto
Template
StatsDto
TemplateStats
LogsDto
TemplateLogs
LogsDto
TemplatesUriParameterBuilder
TemplateLogs
_requestUriBase
TemplatesUri
TemplatesUriParameterBuilder
TemplatesUri
TemplateUri
TemplateStatsUri
TemplateLogsUri
TemplatesUriParameterBuilder
TemplateLogsUri
TemplatesDto
Templates
TemplatesDto
TemplatesUriParameterBuilder
Templates
TemplateDto
Template
StatsDto
TemplateStats
LogsDto
TemplateLogs
LogsDto
TemplatesUriParameterBuilder
TemplateLogs
_requestUriBase
TemplatesUri
TemplatesUriParameterBuilder
TemplatesUri
TemplateUri
TemplateStatsUri
TemplateLogsUri
TemplatesUriParameterBuilder
TemplateLogsUri