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

# XGameUI

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

## Estruturas

| Estrutura | Descrição |
| - | - |
| [XGameUiWebAuthenticationResultData](/pt-BR/reference/system/xgameui/structs/xgameuiwebauthenticationresultdata) | Contém a resposta de uma solicitação de autenticação na Web. |
| [XGameUiTextEntryExtents](/pt-BR/reference/system/xgameui/structs/xgameuitextentryextents) | Descreve o posicionamento relativo do teclado virtual. |
| [XGameUiTextEntryOptions](/pt-BR/reference/system/xgameui/structs/xgameuitextentryoptions) | Conjunto inicial de opções para o teclado virtual usado por XGameUiTextEntryOpen. |
| [XGameUICallbackHandle](/pt-BR/reference/system/xgameui/structs/xgameuicallbackhandle) | Identificador associado a uma invocação de retorno de chamada do XGameUi. Usado em chamadas para APIs Set\*Response. |
| [XGameUIPlayerPickerInfo](/pt-BR/reference/system/xgameui/structs/xgameuiplayerpickerinfo) | 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](/pt-BR/reference/system/xgameui/structs/xgameuiuicallbacks) | Struct que contém ponteiros para retornos de chamada de interface do usuário definidos pelo desenvolvedor. |

## Enumerações

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

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

## Documentação conceitual

* [Objetivos e melhorias do design da programação assíncrona](/pt-BR/build/core-features/common/async/async-whitepaper)
* [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](/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers)

## Confira também

[Referência da API do sistema](/pt-BR/reference/system/gc-reference-system-toc)


## Related topics

- [XGameUI](/reference/system/xgameui/xgameui_members.md)
- [XGameUiShowSendGameInviteAsync](/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md)
- [XGameUiShowSendGameInviteResult](/reference/system/xgameui/functions/xgameuishowsendgameinviteresult.md)