XStore
Material de referência para as APIs de XStore. Fornece funcionalidades relacionadas a comércio para um jogo, incluindo detalhes sobre o conteúdo disponível para compra, gerenciamento de pacotes de conteúdo para download, gerenciamento de licenças e avaliações de jogos.Funções
| Função | Descrição |
|---|---|
| XStoreAcquireLicenseForDurablesAsync | Adquire uma licença para o durável especificado. |
| XStoreAcquireLicenseForDurablesResult | Recupera o resultado de uma chamada a XStoreAcquireLicenseForDurablesAsync. |
| XStoreAcquireLicenseForPackageAsync | Adquire uma licença para um DLC do jogo que o usuário tem direito de usar. |
| XStoreAcquireLicenseForPackageResult | Recupera os resultados de uma chamada a XStoreAcquireLicenseForPackageAsync. |
| XStoreCanAcquireLicenseForPackageAsync | Recupera uma licença de visualização para DLC. |
| XStoreCanAcquireLicenseForPackageResult | Obtém os resultados de uma chamada a XStoreCanAcquireLicenseForPackageAsync. |
| XStoreCanAcquireLicenseForStoreIdAsync | Recupera uma licença de visualização para conteúdo. |
| XStoreCanAcquireLicenseForStoreIdResult | Obtém os resultados de uma chamada a XStoreCanAcquireLicenseForStoreIdAsync. |
| XStoreCloseContextHandle | Fecha o identificador de contexto da loja especificado. |
| XStoreCloseLicenseHandle | Fecha o identificador de licença da loja especificado. |
| XStoreCloseProductsQueryHandle | Fecha o identificador de consulta de produtos da loja especificado. |
| XStoreCreateContext | Cria um contexto da loja para o usuário especificado. |
| XStoreDownloadAndInstallPackagesAsync | Baixa e instala os pacotes da loja especificados. |
| XStoreDownloadAndInstallPackagesResult | Obtém os resultados de uma chamada a XStoreDownloadAndInstallPackagesAsync. |
| XStoreDownloadAndInstallPackagesResultCount | Obtém o número de itens no resultado que será retornado por XStoreDownloadAndInstallPackagesResult. |
| XStoreDownloadAndInstallPackageUpdatesAsync | Baixa e instala atualizações para os pacotes da loja especificados. |
| XStoreDownloadAndInstallPackageUpdatesResult | Obtém os resultados de uma chamada a XStoreDownloadAndInstallPackageUpdatesAsync. |
| XStoreDownloadPackageUpdatesAsync | Baixa atualizações para os pacotes especificados. |
| XStoreDownloadPackageUpdatesResult | Obtém os resultados de uma chamada a XStoreDownloadPackageUpdatesAsync. |
| XStoreEnumerateProductsQuery | Enumera os resultados de uma consulta de produtos. |
| XStoreGameLicenseChangedCallback | Um retorno de chamada definido pelo jogo para o evento de alteração da licença do jogo. |
| XStoreGetUserCollectionsIdAsync | Obtém uma ID de coleções do cliente. |
| XStoreGetUserCollectionsIdResult | Obtém os resultados de uma chamada a XStoreGetUserCollectionsIdAsync. |
| XStoreGetUserCollectionsIdResultSize | Obtém o tamanho da ID retornada por XStoreGetUserCollectionsIdResult. |
| XStoreGetUserPurchaseIdAsync | Recupera uma ID de compra do cliente. |
| XStoreGetUserPurchaseIdResult | Obtém o resultado de uma chamada a XStoreGetUserPurchaseIdAsync. |
| XStoreGetUserPurchaseIdResultSize | Obtém o tamanho do resultado retornado por XStoreGetUserPurchaseIdResult. |
| XStoreIsLicenseValid | Verifica se a licença especificada é válida. |
| XStorePackageLicenseLostCallback | Retorno de chamada definido pelo jogo para o evento de perda de licença. |
| XStoreProductQueryCallback | Retorno de chamada definido pelo jogo para uma consulta de produto. |
| XStoreProductsQueryHasMorePages | Verifica se há mais páginas de resultados para a consulta especificada. |
| XStoreProductsQueryNextPageAsync | Obtém a próxima página de resultados da consulta. |
| XStoreProductsQueryNextPageResult | Obtém a próxima página de resultados de uma consulta de produto. |
| XStoreQueryAddOnLicensesAsync | Enumera as licenças concedidas ao usuário para duráveis sem bits do jogo em execução no momento. |
| XStoreQueryAddOnLicensesResult | Recupera o resultado de uma chamada a XStoreQueryAddOnLicensesAsync. |
| XStoreQueryAddOnLicensesResultCount | Obtém o número de licenças recuperadas por XStoreQueryAddonLicensesAsync. |
| XStoreQueryAssociatedProductsAsync | Obtém informações da listagem da loja para os produtos que podem ser comprados dentro do jogo atual. |
| XStoreQueryAssociatedProductsForStoreIdAsync | Obtém informações da listagem da loja para os produtos que podem ser comprados a partir do produto especificado pela Store ID. |
| XStoreQueryAssociatedProductsForStoreIdResult | Obtém os resultados de uma chamada a XStoreQueryAssociatedProductsForStoreIdAsync. |
| XStoreQueryAssociatedProductsResult | Obtém os resultados de uma chamada a XStoreQueryAssociatedProductsAsync. |
| XStoreQueryConsumableBalanceRemainingAsync | Obtém o saldo restante do consumível para a ID de produto especificada. |
| XStoreQueryConsumableBalanceRemainingResult | Recupera os resultados de uma chamada a XStoreQueryConsumableBalanceRemainingAsync. |
| XStoreQueryEntitledProductsAsync | Fornece as informações de produto da Store para todos os complementos do jogo atual que o usuário comprou. |
| XStoreQueryEntitledProductsResult | Obtém os resultados de uma chamada a XStoreQueryEntitledProductsAsync. |
| XStoreQueryGameAndDlcPackageUpdatesAsync | Obtém atualizações do jogo e opcionais para o pacote atual. |
| XStoreQueryGameAndDlcPackageUpdatesResult | Obtém o resultado de uma chamada a XStoreQueryGameAndDlcPackageUpdatesAsync. |
| XStoreQueryGameAndDlcPackageUpdatesResultCount | Obtém o número de atualizações recuperadas por XStoreQueryGameAndDlcPackageUpdatesAsync. |
| XStoreQueryGameLicenseAsync | Recupera informações sobre a licença que foi adquirida para permitir a inicialização do jogo. |
| XStoreQueryGameLicenseResult | Obtém os resultados de uma chamada a XStoreQueryGameLicenseAsync. |
| XStoreQueryLicenseTokenAsync | Fornece ao jogo chamador um token opaco que pode ser passado para o serviço do jogo para fazer chamadas B2B. |
| XStoreQueryLicenseTokenResult | Recupera os resultados de uma chamada a XStoreQueryLicenseTokenAsync. |
| XStoreQueryLicenseTokenResultSize | Obtém o tamanho do resultado que será retornado por XstoreQueryLicenseTokenResult. |
| XStoreQueryPackageIdentifier | Recupera o identificador de pacote para a ID da loja especificada. |
| XStoreQueryPackageUpdatesAsync | Recupera as atualizações disponíveis para os pacotes especificados. |
| XStoreQueryPackageUpdatesResult | Obtém o resultado de uma chamada a XStoreQueryPackageUpdatesAsync. |
| XStoreQueryPackageUpdatesResultCount | Obtém o número de atualizações recuperadas por XStoreQueryPackageUpdatesAsync. |
| XStoreQueryProductForCurrentGameAsync | Fornece informações de produto da loja para o jogo em execução no momento, seus SKUs e disponibilidades, e outros metadados. |
| XStoreQueryProductForCurrentGameResult | Obtém os resultados de uma chamada a XStoreQueryProductForCurrentGameAsync. |
| XStoreQueryProductForPackageAsync | Recupera informações de produto da loja para o pacote especificado. |
| XStoreQueryProductForPackageResult | Obtém os resultados de uma chamada a XStoreQueryProductForPackageAsync. |
| XStoreQueryProductsAsync | Retorna informações de listagem para os produtos especificados que estão associados ao jogo atual, independentemente de os produtos estarem disponíveis para compra no jogo atual no momento. |
| XStoreQueryProductsResult | Obtém os resultados de uma chamada a XStoreQueryProductsAsync. |
| XStoreRegisterGameLicenseChanged | Registra um retorno de chamada para o evento de alteração da licença do jogo. |
| XStoreRegisterPackageLicenseLost | Registra um retorno de chamada para o evento de perda de licença. |
| XStoreReportConsumableFulfillmentAsync | Consome a quantidade especificada de um consumível. |
| XStoreReportConsumableFulfillmentResult | Obtém os resultados de uma chamada a XStoreReportConsumableFulfillmentAsync. |
| XStoreShowAssociatedProductsUIAsync | Abre o aplicativo Microsoft Store e mostra o conjunto de complementos disponíveis associados ao jogo. Isso pode ser filtrado ainda mais por tipo de produto. |
| XStoreShowAssociatedProductsUIResult | Obtém o resultado de uma chamada a XStoreShowAssociatedProductsUIAsync. |
| XStoreShowGiftingUIAsync | Permite que o jogo solicite a compra de um produto específico da loja como presente para outro usuário. |
| XStoreShowGiftingUIResult | Obtém os resultados de uma chamada a XStoreShowGiftingUIAsync. |
| XStoreShowProductPageUIAsync | Abre o aplicativo da Store diretamente na página de detalhes do ProductId especificado. |
| XStoreShowProductPageUIResult | Obtém o resultado de uma chamada a XStoreShowProductPageUIAsync. |
| XStoreShowPurchaseUIAsync | Permite que o jogo solicite a compra de um produto específico da loja. |
| XStoreShowPurchaseUIResult | Obtém os resultados de uma chamada a XStoreShowPurchaseUIAsync. |
| XStoreShowRateAndReviewUIAsync | Exibe uma caixa de diálogo do sistema para permitir que o usuário forneça uma avaliação ou recuse fazê-lo. |
| XStoreShowRateAndReviewUIResult | Obtém o resultado de uma chamada a XStoreShowRateAndReviewUIAsync. |
| XStoreShowRedeemTokenUIAsync | Dispara um resgate de token para o usuário atual para um token especificado. |
| XStoreShowRedeemTokenUIResult | Obtém os resultados de uma chamada a XStoreShowRedeemTokenUIAsync. |
| XStoreUnregisterGameLicenseChanged | Cancela o registro do retorno de chamada de alteração da licença do jogo especificado. |
| XStoreUnregisterPackageLicenseLost | Cancela o registro do retorno de chamada de perda de licença da loja especificado. |
Estruturas
| Estrutura | Descrição |
|---|---|
| XStoreAddonLicense | Descreve uma licença de complemento. |
| XStoreAvailability | Descreve a disponibilidade de um produto. |
| XStoreCanAcquireLicenseResult | Obtém o resultado de uma chamada a XStoreCanAcquireLicenseForPackageAsync ou XStoreCanAcquireLicenseForStoreIdAsync. |
| XStoreCollectionData | Descreve uma coleção da loja. |
| XStoreConsumableResult | Representa a quantidade do consumível. |
| XStoreGameLicense | Descreve uma licença de jogo. |
| XStoreImage | Descreve uma imagem. |
| XStorePackageUpdate | Descreve uma atualização de pacote. |
| XStorePrice | Informações de preço da loja. |
| XStoreProduct | Descreve um produto da loja. |
| XStoreRateAndReviewResult | Os resultados de uma chamada a XStoreShowRateAndReviewUIAsync. |
| XStoreSku | Descreve um SKU da loja. |
| XStoreSubscriptionInfo | Contém informações sobre uma assinatura. |
| XStoreVideo | Descreve um vídeo da loja. |
Enumerações
| Enumeração | Descrição |
|---|---|
| XStoreCanLicenseStatus | Indica se um usuário poderia licenciar um pacote. |
| XStoreDurationUnit | Unidades de um valor de duração. |
| XStoreProductKind | Indica o tipo de produto. |
Códigos de erro
Os seguintes códigos de erro podem ser retornados pelas APIs de XStore. Para obter uma lista completa, consulte Códigos de erro.| Código | Valor | Descrição |
|---|---|---|
| E_GAMESTORE_LICENSE_ACTION_NOT_APPLICABLE_TO_PRODUCT | 0x89245300 | O jogo solicitou uma licença para um produto que não pode ser licenciado. |
| E_GAMESTORE_NETWORK_ERROR | 0x89245301 | O jogo não conseguiu se comunicar com a rede da loja. |
| E_GAMESTORE_SERVER_ERROR | 0x89245302 | O jogo recebeu uma resposta inválida do servidor da loja. |
| E_GAMESTORE_INSUFFICIENT_QUANTITY | 0x89245303 | O usuário não tem quantidade suficiente deste consumível para usar a quantidade solicitada. |
| E_GAMESTORE_ALREADY_PURCHASED | 0x89245304 | O usuário já possui este produto. |
| E_GAMESTORE_LICENSE_ACTION_THROTTLED | 0x89245305 | O jogo consultou excessivamente uma licença para o produto e agora está limitado. O limite é de 30 tentativas de licenciamento em 10 minutos para o mesmo produto. |
Documentação conceitual
Confira também
Referência de API do sistemaReferência de API de XPackage
Visão geral do comércio