Function DAppRegistryApiFactory

  • DAppRegistryApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        apiV1DappAutocompleteGet(search: string, storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2008>>;
        apiV1DappCategoriesGet(options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>;
        apiV1DappSearchAddressOwnerAddressGet(ownerAddress: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2007>>;
        apiV1DappSearchDappIdGet(dappId: string, storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2007>>;
        dAppFilesV1Form(dappId: string, field: string, dAppFiles: Blob[], options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2001>>;
        downloadBuildUrlV1(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PreSignedUrlResponse>>;
        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>>;
    }

    • apiV1DappAutocompleteGet:function
      • Summary

        Auto-Complete search

        Throws

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

    • apiV1DappCategoriesGet:function
    • apiV1DappSearchAddressOwnerAddressGet:function
      • Summary

        Search DApp By owner Address

        Throws

        Parameters

        • ownerAddress: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2007>>

    • apiV1DappSearchDappIdGet:function
      • Summary

        Search DApp By Dapp Id

        Throws

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

    • dAppFilesV1Form:function
      • Uploading dapp screenshots | logo | banner | dApp file to the servers

        Summary

        Upload dApp files

        Throws

        Parameters

        • dappId: string
        • field: string
        • dAppFiles: Blob[]
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2001>>

    • downloadBuildUrlV1:function
      • Summary

        Build Download URL

        Throws

        Parameters

        • dappId: string

          Dapp Id where upload will happen

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<PreSignedUrlResponse>>

    • searchDapps:function
      • 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

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

Generated using TypeDoc