Class DAppRegistryApi

DAppRegistryApi - object-oriented interface

Export

Hierarchy

BaseAPI
- DAppRegistryApi

Index

Constructors

constructor

new DAppRegistryApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): DAppRegistryApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DAppRegistryApi
Inherited from BaseAPI.constructor
- Defined in base.ts:50

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

apiV1DappAutocompleteGet

apiV1DappAutocompleteGet(search: string, storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2008>>
Summary
Auto-Complete search

Throws

Memberof
DAppRegistryApi
Parameters
- search: string
- Optional storeKey: string
  
  The name of store for which whitelisted dapps have to fetch
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2008>>
- Defined in apis/dapp-registry-api.ts:733

apiV1DappCategoriesGet

apiV1DappCategoriesGet(options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>
Summary
Get All category with subcategories.

Throws

Memberof
DAppRegistryApi
Parameters
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2002>>
- Defined in apis/dapp-registry-api.ts:743

apiV1DappSearchAddressOwnerAddressGet

apiV1DappSearchAddressOwnerAddressGet(ownerAddress: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2007>>
Summary
Search DApp By owner Address

Throws

Memberof
DAppRegistryApi
Parameters
- ownerAddress: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2007>>
- Defined in apis/dapp-registry-api.ts:754

apiV1DappSearchDappIdGet

apiV1DappSearchDappIdGet(dappId: string, storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2007>>
Summary
Search DApp By Dapp Id

Throws

Memberof
DAppRegistryApi
Parameters
- dappId: string
- Optional storeKey: string
  
  The name of store for which whitelisted dapps have to fetch
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2007>>
- Defined in apis/dapp-registry-api.ts:766

dAppFilesV1Form

dAppFilesV1Form(dappId: string, field: string, dAppFiles: Blob[], options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2001>>
Uploading dapp screenshots | logo | banner | dApp file to the servers

Summary
Upload dApp files

Throws

Memberof
DAppRegistryApi
Parameters
- dappId: string
- field: string
- dAppFiles: Blob[]
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2001>>
- Defined in apis/dapp-registry-api.ts:779

downloadBuildUrlV1

downloadBuildUrlV1(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PreSignedUrlResponse>>
Summary
Build Download URL

Throws

Memberof
DAppRegistryApi
Parameters
- dappId: string
  
  Dapp Id where upload will happen
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<PreSignedUrlResponse>>
- Defined in apis/dapp-registry-api.ts:790

searchDapps

searchDapps(page?: number, limit?: number, orderBy?: string, search?: string, categories?: string[], subCategories?: string[], isListed?: boolean, isMinted?: boolean, language?: string, chainId?: number, allowedInCountries?: string[], blockedInCountries?: string[], availableOnPlatform?: string[], isForMatureAudience?: boolean, minAge?: number, listedOnOrAfter?: string, listedOnOrBefore?: string, storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2006>>
Get all dApps or search by a keyword. Optionally, filter on specific attributes of the dApp. This API call will get all the dApps or perform a text search.

Summary
Search Dapps

Throws

Memberof
DAppRegistryApi
Parameters
- Optional page: number
  
  Current page
- Optional limit: number
  
  Page size
- Optional orderBy: string
  
  Want to get dapp by order(asc, desc) by one or more params.
- Optional search: string
  
  A string to be used for search. The search happens on the `name` and `tags` fields of the dApp. If this is not present, all dApps are returned.
- Optional categories: string[]
  
  The categories in which dApps belong. Multiple categories are joined using OR operator.
- Optional subCategories: string[]
  
  The sub-categories in which dApps belong. Multiple sub-categories are joined using OR operator. To get a list of sub categories for a category, use the `/dapp/categories` API.
- Optional isListed: boolean
  
  DApp is listed or not
- Optional isMinted: boolean
  
  DApp is listed or not
- Optional language: string
  
  DApp's language
- Optional chainId: number
  
  DApp supported chainId's. Only dApps belonging to this chainID will be returned.
- Optional allowedInCountries: string[]
  
  dApp allowed countries
- Optional blockedInCountries: string[]
  
  dApp blocked countries
- Optional availableOnPlatform: string[]
  
  DApp is listed or not
- Optional isForMatureAudience: boolean
  
  Mentions if the app is for all ages or only mature audience
- Optional minAge: number
  
  Minimum age
- Optional listedOnOrAfter: string
  
  The date dApp was listed on or after. Date should be in ISO format.
- Optional listedOnOrBefore: string
  
  The date dApp was listed on or before. Date should be in ISO format.
- Optional storeKey: string
  
  The name of store for which whitelisted dapps have to fetch
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2006>>
- Defined in apis/dapp-registry-api.ts:818

Class DAppRegistryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns DAppRegistryApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

apiV1DappAutocompleteGet

Summary

Throws

Memberof

Parameters

search: string

Optional storeKey: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2008>>

apiV1DappCategoriesGet

Summary

Throws

Memberof

Parameters

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2002>>

apiV1DappSearchAddressOwnerAddressGet

Summary

Throws

Memberof

Parameters

ownerAddress: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2007>>

apiV1DappSearchDappIdGet

Summary

Throws

Memberof

Parameters

dappId: string

Optional storeKey: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2007>>

dAppFilesV1Form

Summary

Throws

Memberof

Parameters

dappId: string

field: string

dAppFiles: Blob[]

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2001>>

downloadBuildUrlV1

Summary

Throws

Memberof

Parameters

dappId: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<PreSignedUrlResponse>>

searchDapps

Summary

Throws

Memberof

Parameters

Optional page: number

Optional limit: number

Optional orderBy: string

Optional search: string

Optional categories: string[]

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` storeKey: string

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` storeKey: string

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` page: number

`Optional` limit: number

`Optional` orderBy: string

`Optional` search: string

`Optional` categories: string[]

`Optional` subCategories: string[]

`Optional` isListed: boolean

`Optional` isMinted: boolean

`Optional` language: string

`Optional` chainId: number

`Optional` allowedInCountries: string[]

`Optional` blockedInCountries: string[]

`Optional` availableOnPlatform: string[]

`Optional` isForMatureAudience: boolean

`Optional` minAge: number

`Optional` listedOnOrAfter: string

`Optional` listedOnOrBefore: string

`Optional` storeKey: string

`Optional` options: AxiosRequestConfig