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

OffersUriParameterBuilder

Summary

Members
Descriptions

WithAccountWhitelist sets the accountWhiteList parameter

WithAccountBlacklist sets the accounBlacklist parameter

WithSenderAssetWhitelist sets the senderAssetWhitelist parameter

WithSenderAssetBlacklist sets the senderAssetBlacklist parameter

WithRecipientAssetWhitelist sets the recipientAssetWhitelist parameter

WithRecipientAssetBlacklist sets the recipientAssetBlacklist parameter

WithAccount sets the account parameter

WithSender sets the sender parameter

WithRecipient sets the recipient parameter

WithRecipient sets the state parameter

WithIsRecipientContract sets the _isRecipientContract variable.

WithAssetId sets the assetId parameter

It sets the value of the templateId variable.

WithCollectionName is a function that takes a string as a parameter and returns an OffersUriParameterBuilder object

This function sets the schema name for the query.

WithCollectionBlacklist is a function that takes an array of strings and returns an OffersUriParameterBuilder object

WithCollectionWhitelist is a function that takes an array of strings and returns an OffersUriParameterBuilder object

This function takes an array of strings and joins them together with a comma.

WithLowerBound sets the lower bound of the primary key

WithUpperBound sets the upper bound of the range of primary key

WithBefore sets the _before variable to the value of the before parameter

WithAfter sets the _after variable to the value of the after parameter

WithPage sets the _page variable to the value of the page parameter

WithLimit sets the _limit variable to the value of the limit parameter

This function sets the sort strategy for the query.

It sets the sort parameter to the value passed in.

It builds a query string based on the parameters that have been set.

Members

public OffersUriParameterBuilder WithAccountWhitelist(string accountWhitelist)

WithAccountWhitelist sets the accountWhiteList parameter

Parameters

  • accountWhitelist The accountWhitelist shows only offers sent by one of the accounts.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAccountBlacklist(string accountBlacklist)

WithAccountBlacklist sets the accounBlacklist parameter

Parameters

  • accountWhitelist The accountBlackist excludes offers sent by one of the accounts.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSenderAssetWhitelist(string senderAssetwhitelist)

WithSenderAssetWhitelist sets the senderAssetWhitelist parameter

Parameters

  • senderAssetWhitelist The senderAssetWhitelist only shows offers that contain assets.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSenderAssetBlacklist(string senderAssetBlacklist)

WithSenderAssetBlacklist sets the senderAssetBlacklist parameter

Parameters

  • senderAssetBlacklistlist The senderAssetBlacklist excludes offers that contain assets.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithRecipientAssetWhitelist(string recipientAssetwhitelist)

WithRecipientAssetWhitelist sets the recipientAssetWhitelist parameter

Parameters

  • recipientAssetWhitelist The recipientAssetWhitelist only shows offers that contain assets recieved.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithRecipientAssetBlacklist(string recipientAssetBlacklist)

WithRecipientAssetBlacklist sets the recipientAssetBlacklist parameter

Parameters

  • recipientAssetBlacklist The recipientAssetBlacklist excludes offers that contain assets recieved.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAccount(string account)

WithAccount sets the account parameter

Parameters

  • account The account parameter is used to filter the results. The account parameter is a string that is matched against the account .

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSender(string sender)

WithSender sets the sender parameter

Parameters

  • sender The sender parameter is used to filter the results. The sender parameter is a string that is matched against the account name.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithRecipient(string recipient)

WithRecipient sets the recipient parameter

Parameters

  • recipient The recipient parameter is used show offers recieved by a recipient.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithState(string state)

WithRecipient sets the state parameter

Parameters

  • state The state parameter filters results depending on the state of the offer.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithIsRecipientContract(bool isRecipientContract)

WithIsRecipientContract sets the _isRecipientContract variable.

Parameters

  • isRecipientContract Filters offers where recipient is a contract.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAssetId(string assetId)

WithAssetId sets the assetId parameter

Parameters

  • assetId The assetId parameter shows offers based on a certain assetId.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithTemplateId(string temlpateId)

It sets the value of the templateId variable.

Parameters

  • templateId Results based on only offers which contain assets of template.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithCollectionName(string collectionName)

WithCollectionName is a function that takes a string as a parameter and returns an OffersUriParameterBuilder object

Parameters

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

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

  • schemaName The name of the schema to use.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

WithCollectionBlacklist is a function that takes an array of strings and returns an OffersUriParameterBuilder object

Parameters

  • collectionBlacklist A list of collections to exclude from the results.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

WithCollectionWhitelist is a function that takes an array of strings and returns an OffersUriParameterBuilder object

Parameters

  • collectionWhitelist A list of collections to include in the response.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithIds(string[] ids)

This function takes an array of strings and joins them together with a comma.

Parameters

  • ids A comma-separated list of account IDs.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithLowerBound(string lowerBound)

WithLowerBound sets the lower bound of the primary key

Parameters

  • lowerBound The lower bound of primary key.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithUpperBound(string upperBound)

WithUpperBound sets the upper bound of the range of primary key

Parameters

  • upperBound The upper bound of primary key.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithBefore(int before)

WithBefore sets the _before variable to the value of the before parameter

Parameters

  • before The previous values of the results to return.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAfter(int after)

WithAfter sets the _after variable to the value of the after parameter

Parameters

  • after The next values of the results to return.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithPage(int page)

WithPage sets the _page variable to the value of the page parameter

Parameters

  • page The page number of the results to return.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithLimit(int limit)

WithLimit sets the _limit variable to the value of the limit parameter

Parameters

  • limit The number of results to return.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

  • SortStrategy

Returns

The builder object itself.

public OffersUriParameterBuilder WithSort(string sort)

It sets the sort parameter to the value passed in.

Parameters

  • sort The field to sort the results by.

Returns

The OffersUriParameterBuilder object.

public string Build()

It builds a query string based on the parameters that have been set.

Returns

A string that contains the parameters for the query.

private string _account

private string _sender

private string _recipient

private string _state

private bool? _isRecipientContract

private string _assetId

private string _templateId

private string _schemaName

private string _collectionName

private string _accountWhitelist

private string _accountBlacklist

private string _senderAssetWhitelist

private string _senderAssetBlacklist

private string _recipientAssetWhitelist

private string _recipientAssetBlacklist

private string _collectionBlacklist

private string _collectionWhitelist

private string _ids

private string _lowerBound

private string _upperBound

private int? _before

private int? _after

private int? _page

private int? _limit

private SortStrategy? _sortStrategy

private string _sort

PreviousImmutableDataDtoNextSchemas

Last updated 2 years ago

public (string accountWhitelist)

public (string accountBlacklist)

public (string senderAssetwhitelist)

public (string senderAssetBlacklist)

public (string recipientAssetwhitelist)

public (string recipientAssetBlacklist)

public (string account)

public (string sender)

public (string recipient)

public (string state)

public (bool isRecipientContract)

public (string assetId)

public (string temlpateId)

public (string collectionName)

public (string schemaName)

public (string[] collectionBlacklist)

public (string[] collectionWhitelist)

public (string[] ids)

public (string lowerBound)

public (string upperBound)

public (int before)

public (int after)

public (int page)

public (int limit)

public ( sorting)

public (string sort)

public string ()

private string

private string

private string

private string

private bool?

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private string

private int?

private int?

private int?

private int?

private ?

private string

OffersUriParameterBuilder
WithAccountWhitelist
OffersUriParameterBuilder
WithAccountBlacklist
OffersUriParameterBuilder
WithSenderAssetWhitelist
OffersUriParameterBuilder
WithSenderAssetBlacklist
OffersUriParameterBuilder
WithRecipientAssetWhitelist
OffersUriParameterBuilder
WithRecipientAssetBlacklist
OffersUriParameterBuilder
WithAccount
OffersUriParameterBuilder
WithSender
OffersUriParameterBuilder
WithRecipient
OffersUriParameterBuilder
WithState
OffersUriParameterBuilder
WithIsRecipientContract
OffersUriParameterBuilder
WithAssetId
OffersUriParameterBuilder
WithTemplateId
OffersUriParameterBuilder
WithCollectionName
OffersUriParameterBuilder
WithSchemaName
OffersUriParameterBuilder
WithCollectionBlacklist
OffersUriParameterBuilder
WithCollectionWhitelist
OffersUriParameterBuilder
WithIds
OffersUriParameterBuilder
WithLowerBound
OffersUriParameterBuilder
WithUpperBound
OffersUriParameterBuilder
WithBefore
OffersUriParameterBuilder
WithAfter
OffersUriParameterBuilder
WithPage
OffersUriParameterBuilder
WithLimit
OffersUriParameterBuilder
WithOrder
SortStrategy
OffersUriParameterBuilder
WithSort
Build
_account
_sender
_recipient
_state
_isRecipientContract
_assetId
_templateId
_schemaName
_collectionName
_accountWhitelist
_accountBlacklist
_senderAssetWhitelist
_senderAssetBlacklist
_recipientAssetWhitelist
_recipientAssetBlacklist
_collectionBlacklist
_collectionWhitelist
_ids
_lowerBound
_upperBound
_before
_after
_page
_limit
SortStrategy
_sortStrategy
_sort