XUser
Material de referência para as APIs XUser.Funções
| Função | Descrição |
|---|---|
| XUserAddAsync | Adiciona de forma assíncrona um usuário a uma sessão de jogo. |
| XUserAddByIdWithUiAsync | Adiciona de forma assíncrona um usuário a uma sessão de jogo com base em um XUID de um convite de jogo. Esta função só deve ser usada em resposta a um convite de jogo. |
| XUserAddByIdWithUiResult | Recupera um identificador para o usuário criado por XUserAddByIdWithUiAsync. Esta função só deve ser usada em resposta a um convite de jogo. |
| XUserAddResult | Recupera um identificador para um usuário criado por XUserAddAsync. |
| XUserChangeEventCallback | Um retorno de chamada que um aplicativo define para um evento de alteração de usuário. |
| XUserCheckPrivilege | Determina se um usuário tem um privilégio específico. |
| XUserCloseHandle | Fecha um identificador de usuário específico. |
| XUserCloseSignOutDeferralHandle | Fecha um identificador de adiamento de saída de usuário específico. |
| XUserCompare | Compara dois identificadores de usuário quanto à igualdade. |
| XUserDefaultAudioEndpointUtf16ChangedCallback | Um retorno de chamada que um aplicativo define e invoca quando o ponto de extremidade de áudio padrão de um usuário é alterado. |
| XUserDeviceAssociationChangedCallback | Um retorno de chamada invocado quando a associação usuário-dispositivo é alterada. |
| XUserDuplicateHandle | Duplica um identificador de usuário. |
| XUserFindControllerForUserWithUiAsync | Mostra uma caixa de diálogo que solicitará ao usuário que ligue e identifique qual controle deseja usar. |
| XUserFindControllerForUserWithUiResult | Recupera a ID do dispositivo local do aplicativo (APP_LOCAL_DEVICE_ID) que um usuário escolheu usar. |
| XUserFindForDevice | Recupera a ID de usuário de uma ID de dispositivo específica. |
| XUserFindUserById | Recupera a ID de usuário do XBox (XUID) de um usuário local. |
| XUserFindUserByLocalId | Recupera um identificador para o usuário de uma ID de usuário local específica. |
| XUserGetAgeGroup | Retorna a faixa etária de um usuário. |
| XUserGetDefaultAudioEndpointUtf16 | Recupera o ponto de extremidade de áudio padrão de um usuário específico. |
| XUserGetGamerPictureAsync | Recupera de forma assíncrona a imagem de jogador de um usuário específico. |
| XUserGetGamerPictureResult | Recupera o resultado de uma chamada para XUserGetGamerPictureAsync. |
| XUserGetGamerPictureResultSize | Retorna o tamanho do buffer que XUserGetGamerPictureResult exige para recuperar a imagem de jogador retornada por XUserGetGamerPictureAsync. |
| XUserGetGamertag | Recupera o gamertag de um usuário específico. |
| XUserGetId | Obtém a ID de usuário de um usuário específico. |
| XUserGetIsGuest | Retorna um booliano que indica se um usuário é convidado. |
| XUserGetLocalId | Recupera uma ID de sessão de jogo exclusiva de um usuário. |
| XUserGetMaxUsers | Recupera o número máximo de usuários que uma sessão de jogo permite na plataforma atual. |
| XUserGetMsaTokenSilentlyAsync | Esta função foi preterida. |
| XUserGetMsaTokenSilentlyResult | Esta função foi preterida. |
| XUserGetMsaTokenSilentlyResultSize | Esta função foi preterida. |
| XUserGetSignOutDeferral | Recupera um identificador para o adiamento de saída. |
| XUserGetState | Recupera o estado de um usuário. |
| XUserGetTokenAndSignatureAsync | Recupera de forma assíncrona xtokens e assinaturas para solicitações da Web. |
| XUserGetTokenAndSignatureResult | Obtém o resultado de uma chamada para XUserGetTokenAndSignatureAsync. |
| XUserGetTokenAndSignatureResultSize | Obtém o tamanho do buffer para armazenar os resultados de uma chamada para XUserGetTokenAndSignatureAsync. |
| XUserGetTokenAndSignatureUtf16Async | Recupera de forma assíncrona xtokens e assinaturas Unicode para solicitações da Web. |
| XUserGetTokenAndSignatureUtf16Result | Obtém o resultado de uma chamada para XUserGetTokenAndSignatureUtf16Async. |
| XUserGetTokenAndSignatureUtf16ResultSize | Obtém o tamanho do buffer para armazenar os resultados de uma chamada para XUserGetTokenAndSignatureUtf16Async. |
| XUserIsStoreUser | Verifica se a MSA do XUser é a mesma MSA conectada à Microsoft Store. |
| XUserRegisterForChangeEvent | Registra um retorno de chamada para um evento de alteração de usuário. |
| XUserRegisterForDefaultAudioEndpointUtf16Changed | Registra um retorno de chamada que o aplicativo define e invoca quando o ponto de extremidade de áudio padrão é alterado. |
| XUserRegisterForDeviceAssociationChanged | Registra um retorno de chamada para eventos de alteração de associação de dispositivo do usuário. |
| XUserResolveIssueWithUiAsync | Exibe uma interface do usuário do sistema para resolver problemas de token com uma URL não Unicode. |
| XUserResolveIssueWithUiResult | Recupera o resultado de uma chamada para XUserResolveIssueWithUiAsync. |
| XUserResolveIssueWithUiUtf16Async | Exibe uma interface do usuário do sistema para resolver problemas de token com uma URL Unicode específica. |
| XUserResolveIssueWithUiUtf16Result | Recupera o resultado de uma chamada para XUserResolveIssueWithUiUtf16Async. |
| XUserResolvePrivilegeWithUiAsync | Exibe uma interface do usuário de resolução para os privilégios de usuário necessários. |
| XUserResolvePrivilegeWithUiResult | Recupera o resultado de uma chamada para XUserResolvePrivilegeWithUiAsync. |
| XUserUnregisterForChangeEvent | Cancela o registro de um retorno de chamada de alteração de usuário registrado anteriormente. |
| XUserUnregisterForDefaultAudioEndpointUtf16Changed | Cancela o registro de um retorno de chamada de alteração do ponto de extremidade de áudio padrão registrado anteriormente. |
| XUserUnregisterForDeviceAssociationChanged | Cancela o registro de um retorno de chamada de alteração de associação de dispositivo do usuário registrado anteriormente. |
| xUserPlatformRemoteConnectSetEventHandlers | Define os manipuladores de eventos de conexão remota |
| XUserPlatformRemoteConnectCancelPrompt | Sinaliza ao XUser que o prompt de conexão remota foi descartado pelo usuário. |
| XUserPlatformRemoteConnectShowPromptEventHandler | Manipulador de eventos para mostrar o prompt de autenticação de conexão remota. |
| XUserPlatformRemoteConnectClosePromptEventHandler | Manipulador de eventos para fechar o prompt de autenticação remota. |
| XUserPlatformSpopPromptEventHandler | Manipulador de eventos para mostrar o prompt da operação SPOP |
| XUserPlatformSpopPromptSetEventHandlers | Define o manipulador de eventos do prompt SPOP. |
| XUserPlatformSpopPromptClearEventHandler | Limpa o manipulador de eventos do prompt SPOP no XUser. |
| XUserPlatformSpopPromptComplete | Sinaliza ao XUser que o usuário terminou de interagir com o prompt SPOP. |
Estruturas
| Estrutura | Descrição |
|---|---|
| APP_LOCAL_DEVICE_ID | Especifica a ID raiz de um dispositivo de entrada local. |
| XUserDeviceAssociationChange | Especifica as associações de dispositivo antigas e novas quando uma associação de dispositivo é alterada. |
| XUserGetTokenAndSignatureData | Especifica os xtokens e as assinaturas que recuperamos para solicitações da Web. |
| XUserGetTokenAndSignatureHttpHeader | Especifica o cabeçalho HTTP de uma solicitação da Web. |
| XUserGetTokenAndSignatureUtf16Data | Contém xtokens e assinaturas Unicode para solicitações da Web. |
| XUserGetTokenAndSignatureUtf16HttpHeader | Contém um cabeçalho HTTP Unicode para uma solicitação da Web. |
| XUserLocalId | Especifica uma ID de sessão de jogo para um usuário. |
| XUserPlatformRemoteConnectEventHandlers | Encapsula os manipuladores de eventos de conexão remota |
Enumerações
| Enumeração | Descrição |
|---|---|
| XUserAddOptions | Especifica as opções para adicionar um usuário. |
| XUserAgeGroup | Especifica a faixa etária de um usuário. |
| XUserChangeEvent | Especifica o tipo de evento de alteração de usuário. |
| XUserDefaultAudioEndpointKind | Especifica se o ponto de extremidade de áudio padrão do usuário renderiza ou captura áudio. |
| XUserGamerPictureSize | Especifica o tamanho da imagem de jogador em pixels. |
| XUserGamertagComponent | Especifica o tipo (ou componente) de gamertag a ser buscado. |
| XUserGetMsaTokenSilentlyOptions | Opções para XUserGetMsaTokenSilentlyOptions. |
| XUserGetTokenAndSignatureOptions | Opções para GetUserTokenAndSignatureAsync. |
| XUserPrivilege | Especifica os privilégios de um usuário. |
| XUserPrivilegeDenyReason | Especifica o motivo pelo qual um usuário não pôde obter um privilégio. |
| XUserPrivilegeOptions | Especifica as opções de privilégio do usuário. |
| XUserState | Especifica o estado atual do usuário. |
| XUserPlatformOperationResult | Enumeração que define os resultados de uma operação de cliente |
| XUserPlatformSpopOperationResult | Enumeração que define os resultados de uma operação de cliente. |
Documentação conceitual
- Metas de design e melhorias da programação assíncrona
- Visão geral do WinHTTP
- Solicitações da Web (conteúdo)
- Threads sensíveis ao tempo
- Usando wrappers C# para APIs do GDK em seu projeto do Unity
Confira também
Referência da API do sistemaCódigos de erro
Os códigos de erro a seguir podem ser retornados pelas APIs XUser. Para obter uma lista completa, consulte Códigos de erro.| Código | Valor | Descrição |
|---|---|---|
| E_GAMEUSER_MAX_USERS_ADDED | 0x89245100 | Não é possível adicionar este usuário porque o número máximo de usuários foi atingido. |
| E_GAMEUSER_SIGNED_OUT | 0x89245101 | Não é possível executar a operação porque o usuário saiu. |
| E_GAMEUSER_RESOLVE_USER_ISSUE_REQUIRED | 0x89245102 | A UI é necessária para resolver um problema com este usuário. |
| E_GAMEUSER_DEFERRAL_NOT_AVAILABLE | 0x89245103 | Não é um momento apropriado para solicitar o adiamento. |
| E_GAMEUSER_USER_NOT_FOUND | 0x89245104 | O usuário correspondente à ID não foi encontrado. |
| E_GAMEUSER_NO_TOKEN_REQUIRED | 0x89245105 | Nenhum token é necessário para esta chamada. |
| E_GAMEUSER_NO_DEFAULT_USER | 0x89245106 | Não há um usuário padrão atual. Se você receber este erro, chame XUserAddAsync novamente sem AddDefaultUserSilently. |
| E_GAMEUSER_FAILED_TO_RESOLVE | 0x89245107 | Falha ao resolver o privilégio fornecido. |
| E_GAMEUSER_NO_TITLE_ID | 0x89245108 | Um TitleId do XBOX Live deve ser configurado. |
| E_GAMEUSER_UNKNOWN_GAME_IDENTITY | 0x89245109 | A identidade do jogo não é reconhecida. O MSAAppId e o TitleId não correspondem aos associados ao jogo. |
| E_GAMEUSER_NO_PACKAGE_IDENTITY | 0x89245110 | Uma identidade de pacote deve ser configurada. |
| E_GAMEUSER_FAILED_TO_GET_TOKEN | 0x89245111 | A solicitação de token falhou. |
| E_GAMEUSER_INVALID_APP_CONFIGURATION | 0x89245112 | O MSAAppId na configuração do jogo é inválido ou não está configurado para a pilha de autenticação. |
| E_GAMEUSER_MALFORMED_MSAAPPID | 0x89245113 | O MSAAppId na configuração do jogo não corresponde ao formato esperado (cadeia de caracteres de 16 caracteres ou GUID). |
| E_GAMEUSER_INCONSISTENT_MSAAPPID_AND_TITLEID | 0x89245114 | O MSAAppId e o TitleId na configuração do jogo não correspondem aos associados ao jogo. |