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. Collections

CollectionsApi

PreviousCollectionsNextCollectionDto

Last updated 2 years ago

Summary

Members
Descriptions

It returns a list of all the collections in the database.

It takes a CollectionsUriParameterBuilder object as a parameter, builds an HttpRequestMessage object, sends it to the API, and returns a CollectionsDto object.

This function will return a collection object from the API.

This function will return a StatsDto object that contains the stats for the collection specified in the collectionName parameter.

This function will return a list of logs for a given collection.

This function returns a list of logs for a given collection.

It returns a Uri object that represents the URL for the collections endpoint.

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

Given a collection name, return a Uri object that represents the collection's endpoint.

It returns a URI that points to the stats endpoint for a given collection.

It returns a URI for the collection logs endpoint.

It returns a Uri object that represents the URL for the collection logs endpoint.

Members

public ()

It returns a list of all the collections in the database.

Returns

A list of collections

It takes a CollectionsUriParameterBuilder object as a parameter, builds an HttpRequestMessage object, sends it to the API, and returns a CollectionsDto object.

Parameters

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

Returns

A collection of collections.

This function will return a collection object from the API.

Parameters

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

Returns

A collection of documents.

This function will return a StatsDto object that contains the stats for the collection specified in the collectionName parameter.

Parameters

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

Returns

A StatsDto object

This function will return a list of logs for a given collection.

Parameters

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

Returns

A LogsDto object

This function returns a list of logs for a given collection.

Parameters

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

  • CollectionsUriParameterBuilder This is a class that allows you to build the query string parameters for the request.

Returns

A LogsDto object

It returns a Uri object that represents the URL for the collections endpoint.

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

Parameters

  • CollectionsUriParameterBuilder A class that builds the query string parameters for the collections endpoint.

Given a collection name, return a Uri object that represents the collection's endpoint.

Parameters

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

It returns a URI that points to the stats endpoint for a given collection.

Parameters

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

It returns a URI for the collection logs endpoint.

Parameters

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

It returns a Uri object that represents the URL for the collection logs endpoint.

Parameters

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

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

public ()

public ( collectionsUriParameterBuilder)

public (string collectionName)

public (string collectionName)

public (string collectionName)

public (string collectionName, collectionsUriParameterBuilder)

private readonly string

private Uri ()

private Uri ( collectionsUriParameterBuilder)

private Uri (string collectionName)

private Uri (string collectionName)

private Uri (string collectionName)

private Uri (string collectionName, collectionsUriParameterBuilder)

public ( collectionsUriParameterBuilder)

public (string collectionName)

public (string collectionName)

public (string collectionName)

public (string collectionName, collectionsUriParameterBuilder)

private readonly string

private Uri ()

private Uri ( collectionsUriParameterBuilder)

private Uri (string collectionName)

private Uri (string collectionName)

private Uri (string collectionName)

private Uri (string collectionName, collectionsUriParameterBuilder)

CollectionsDto
Collections
CollectionsDto
CollectionsUriParameterBuilder
Collections
CollectionDto
Collection
StatsDto
CollectionStats
LogsDto
CollectionLogs
LogsDto
CollectionsUriParameterBuilder
CollectionLogs
_requestUriBase
CollectionsUri
CollectionsUriParameterBuilder
CollectionsUri
CollectionUri
CollectionStatsUri
CollectionLogsUri
CollectionsUriParameterBuilder
CollectionLogsUri
CollectionsDto
Collections
CollectionsDto
CollectionsUriParameterBuilder
Collections
CollectionDto
Collection
StatsDto
CollectionStats
LogsDto
CollectionLogs
LogsDto
CollectionsUriParameterBuilder
CollectionLogs
_requestUriBase
CollectionsUri
CollectionsUriParameterBuilder
CollectionsUri
CollectionUri
CollectionStatsUri
CollectionLogsUri
CollectionsUriParameterBuilder
CollectionLogsUri