> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameUI (conteúdo da API)

> XGameUI

# XGameUI

As APIs XboxGameUI permitem que os títulos exibam interfaces do usuário predefinidas no console XBOX One. Essas interfaces do usuário predefinidas incluem seletores de usuário, cartões de perfil e convites de jogo, entre outras interfaces.

## Funções

| Função | Descrição |
| - | - |
| [XGameUiSetNotificationPositionHint](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetnotificationpositionhint.md) | Define a posição preferencial para as notificações do sistema serem exibidas no título atual. |
| [XGameUiShowAchievementsAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowachievementsasync.md) | Exibe a interface do usuário que apresenta as conquistas do jogador solicitante para o título especificado. |
| [XGameUiShowAchievementsResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowachievementsresult.md) | Obtém o resultado de uma chamada para [XGameUiShowAchievementsAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowachievementsasync.md). |
| [XGameUiShowErrorDialogAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowerrordialogasync.md) | Exibe a interface do usuário de uma caixa de diálogo de erro com uma cadeia de caracteres de erro definida pelo serviço para o código de erro especificado. |
| [XGameUiShowErrorDialogResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowerrordialogresult.md) | Obtém o resultado de uma chamada para [XGameUiShowErrorDialogAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowerrordialogasync.md). |
| [XGameUiShowMessageDialogAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmessagedialogasync.md) | Exibe a interface do usuário de uma caixa de diálogo de mensagem personalizável. |
| [XGameUiShowMessageDialogResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmessagedialogresult.md) | Obtém o resultado de uma chamada para [XGameUiShowMessageDialogAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmessagedialogasync.md). |
| [XGameUiShowMultiplayerActivityGameInviteAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteasync.md) | A definir |
| [XGameUiShowMultiplayerActivityGameInviteResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteresult.md) | A definir |
| [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md) | Exibe uma interface do usuário de seletor que permite que uma pessoa que está jogando selecione jogadores em uma lista apresentada de pessoas. |
| [XGameUiShowPlayerPickerResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickerresult.md) | Obtém os resultados de uma chamada de [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md). |
| [XGameUiShowPlayerPickerResultCount](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickerresultcount.md) | Obtém a contagem de resultados de uma chamada de [XGameUiShowPlayerPickerAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickerasync.md). |
| [XGameUiShowPlayerProfileCardAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync.md) | Exibe a interface do usuário do cartão de perfil do jogador especificado. |
| [XGameUiShowPlayerProfileCardResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerprofilecardresult.md) | Obtém o resultado de uma chamada para [XGameUiShowPlayerProfileCardAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerprofilecardasync.md). |
| [XGameUiShowSendGameInviteAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md) | Mostra uma interface do usuário de seletor preenchida com a lista de amigos e a lista de amigos sugeridos do jogador selecionado. |
| [XGameUiShowSendGameInviteResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowsendgameinviteresult.md) | Obtém o resultado de uma chamada para [XGameUIShowSendGameInviteAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md). |
| [XGameUiShowStateShareAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowstateshareasync.md) | Exibe a interface do usuário para compartilhar um estado com outros jogadores |
| [XGameUiShowStateShareResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowstateshareresult.md) | Obtém o resultado de uma chamada para [XGameUIShowStateShareAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowstateshareasync.md) |
| [XGameUiShowTextEntryAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryasync.md) | Exibe uma interface do usuário de entrada de texto para que um usuário insira informações. |
| [XGameUiShowTextEntryResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresult.md) | Obtém os resultados de uma chamada de [XGameUiShowTextEntryAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryasync.md). |
| [XGameUiShowTextEntryResultSize](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryresultsize.md) | Obtém o tamanho do buffer de retorno de uma chamada de [XGameUiShowTextEntryAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryasync.md). |
| [XGameUiShowWebAuthenticationAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowwebauthenticationasync.md) | Exibe uma interface do usuário da Web que permite ao usuário delegar acesso a sites e serviços externos sem fornecer diretamente suas credenciais ao título em execução. |
| [XGameUiShowWebAuthenticationResult](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowwebauthenticationresult.md) | Obtém os resultados de uma chamada de [XGameUiShowWebAuthenticationAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowwebauthenticationasync.md). |
| [XGameUiShowWebAuthenticationResultSize](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowwebauthenticationresultsize.md) | Recupera o tamanho do buffer necessário para conter os resultados de uma solicitação de autenticação. |
| [XGameUiShowWebAuthenticationWithOptionsAsync](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowwebauthenticationwithoptionsasync.md) | Exibe uma interface do usuário da Web, com a opção de mostrá-la em tela inteira, que permite ao usuário delegar acesso a sites e serviços externos sem fornecer diretamente suas credenciais ao título em execução. |
| [XGameUiTextEntryClose](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentryclose.md) | Fecha o teclado virtual e libera os recursos correspondentes. |
| [XGameUiTextEntryGetExtents](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentrygetextents.md) | Obtém as extensões de tela do teclado virtual. |
| [XGameUiTextEntryGetState](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentrygetstate.md) | Obtém o estado atual do teclado virtual aberto. |
| [XGameUiTextEntryOpen](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentryopen.md) | Abre um teclado virtual em que o título é responsável por renderizar o texto. |
| [XGameUiTextEntryUpdatePositionHint](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentryupdatepositionhint.md) | Atualiza o posicionamento preferencial do teclado virtual. |
| [XGameUiTextEntryUpdateVisibility](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentryupdatevisibility.md) | Atualiza se deve ser exibido o teclado virtual completo ou apenas a lista de candidatos. |
| [XGameUISetUICallbacks](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetuicallbacks.md) | Define os retornos de chamada de interface do usuário definidos pelo desenvolvedor. |
| [XGameUISetMessageDialogUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetmessagedialoguiresponse.md) | Define o valor XGameUiMessageDialogButton resultante a ser retornado por XGameUiShowMessageDialogResult. |
| [XGameUISetPlayerPickerUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetplayerpickeruiresponse.md) | Define os resultados a serem retornados por XGameUiShowPlayerPickerResultCount e XGameUiShowPlayerPickerResult. |
| [XGameUISetTextEntryUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisettextentryuiresponse.md) | Define o comprimento do texto resultante e o texto a serem retornados por XGameUiShowTextEntryAsync. |
| [XGameUISetPlayerProfileCardUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetplayerprofilecarduiresponse.md) | Conclui a chamada para XGameUiShowPlayerProfileCardAsync. |
| [XGameUISetSendGameInviteUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse.md) | Conclui a chamada para XGameUiShowSendGameInviteAsync. |
| [XGameUISetAchievementsUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetachievementsuiresponse.md) | Conclui a chamada para XGameUiShowAchievementsAsync. |
| [XGameUISetMultiplayerActivityGameInviteUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuisetmultiplayeractivitygameinviteuiresponse.md) | Conclui a chamada para XGameUiShowMultiplayerActivityGameInviteAsync. |
| [XGameUISetErrorDialogUIResponse](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuiseterrordialoguiresponse.md) | Conclui a chamada para XGameUiShowErrorDialogAsync. |
| [XGameUIShowPlayerProfileCardUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerprofilecarduicallback.md) | Assinatura de um retorno de chamada de XGameUiShowPlayerProfileCardAsync. |
| [XGameUIShowPlayerPickerUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowplayerpickeruicallback.md) | Assinatura de um retorno de chamada de XGameUiShowPlayerPickerAsync. |
| [XGameUIShowSendGameInviteUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback.md) | Assinatura de um retorno de chamada de XGameUiShowSendGameInviteAsync. |
| [XGameUIShowAchievementsUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowachievementsuicallback.md) | Assinatura de um retorno de chamada de XGameUiShowAchievementsAsync. |
| [XGameUIShowMultiplayerActivityGameInviteUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmultiplayeractivitygameinviteuicallback.md) | Assinatura de um retorno de chamada de XGameUiShowMultiplayerActivityGameInviteAsync. |
| [XGameUIShowMessageDialogUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowmessagedialoguicallback.md) | Assinatura de um retorno de chamada de XGameUiShowMessageDialogAsync. |
| [XGameUIShowErrorDialogUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowerrordialoguicallback.md) | Assinatura de um retorno de chamada de XGameUiShowErrorDialogAsync. |
| [XGameUIShowTextEntryUICallback](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuishowtextentryuicallback.md) | Assinatura de um retorno de chamada de XGameUiShowTextEntryAsync. |

## Estruturas

| Estrutura | Descrição |
| - | - |
| [XGameUiWebAuthenticationResultData](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata.md) | Contém a resposta de uma solicitação de autenticação na Web. |
| [XGameUiTextEntryExtents](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuitextentryextents.md) | Descreve o posicionamento relativo do teclado virtual. |
| [XGameUiTextEntryOptions](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuitextentryoptions.md) | Conjunto inicial de opções para o teclado virtual usado por XGameUiTextEntryOpen. |
| [XGameUICallbackHandle](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuicallbackhandle.md) | Identificador associado a uma invocação de retorno de chamada do XGameUi. Usado em chamadas para APIs Set\*Response. |
| [XGameUIPlayerPickerInfo](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuiplayerpickerinfo.md) | Struct que encapsula as informações do usuário a serem usadas pela interface do usuário personalizada de seletor de jogadores do desenvolvedor. |
| [XGameUIUICallbacks](https://docs.xbox.com/pt-BR/reference/system/xgameui/structs/xgameuiuicallbacks.md) | Struct que contém ponteiros para retornos de chamada de interface do usuário definidos pelo desenvolvedor. |

## Enumerações

| Enumeração | Descrição |
| - | - |
| [XGameUiMessageDialogButton](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuimessagedialogbutton.md) | Enumera os botões em uma caixa de diálogo de mensagem personalizável. |
| [XGameUiNotificationPositionHint](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuinotificationpositionhint.md) | Descreve a posição preferencial para as notificações do sistema serem exibidas no título atual. |
| [XGameUiTextEntryChangeTypeFlags](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuitextentrychangetypeflags.md) | Sinalizadores que indicam o que mudou desde a última chamada para XGameUiTextEntryGetState. |
| [XGameUiTextEntryInputScope](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuitextentryinputscope.md) | Enumera os tipos de informações esperados na entrada de texto. |
| [XGameUiTextEntryPositionHint](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuitextentrypositionhint.md) | Dica de onde posicionar melhor o teclado virtual. |
| [XGameUiTextEntryVisibilityFlags](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuitextentryvisibilityflags.md) | Sinalizadores que indicam o estado de visibilidade do teclado virtual. |
| [XGameUiWebAuthenticationOptions](https://docs.xbox.com/pt-BR/reference/system/xgameui/enums/xgameuiwebauthenticationoptions.md) | Enumera as opções para apresentar o fluxo de autenticação na Web. |

## Códigos de erro

Os códigos de erro a seguir podem ser retornados pelas APIs XGameUI. Para obter uma lista completa, consulte [Códigos de erro](https://docs.xbox.com/pt-BR/reference/errorcodes.md).

| Código | Valor | Descrição |
| - | - | - |
| E\_GAMEUI\_TEXTENTRY\_NOT\_SHOWN | — | O XGameUiTextEntryHandle não é válido, provavelmente porque você precisa chamar [XGameUiTextEntryOpen](https://docs.xbox.com/pt-BR/reference/system/xgameui/functions/xgameuitextentryopen.md) primeiro. |

## Documentação conceitual

* [Objetivos e melhorias do design da programação assíncrona](https://docs.xbox.com/pt-BR/build/core-features/common/async/async-whitepaper.md)
* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [O que é o Microsoft Game Development Kit?](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/intro/introduction)
* [Usando wrappers C# para APIs do GDK no seu projeto Unity](https://docs.xbox.com/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers.md)

## Confira também

[Referência da API do sistema](https://docs.xbox.com/pt-BR/reference/system/gc-reference-system-toc.md)


## Related topics

- [XGame (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xgame/xgame_members.md)
- [XGameActivation (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xgameactivation/xgameactivation_members.md)
- [XGameEvent (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xgameevent/xgameevent_members.md)
- [XGameStreaming (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/xgamestreaming_members.md)
- [XGameSave (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xgamesave/xgamesave_members.md)