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

# Contexto

> Salve valores padrão, como o vendedor e o título do PlayFab, para comandos posteriores, em perfis nomeados se você precisar de mais de um conjunto.

`xbox context` salva valores padrão para o vendedor, o título do PlayFab, o título do XBOX e a sandbox, para
que você não precise passá-los em todos os comandos. Esta página também descreve de onde um comando obtém
esses valores quando você não os passa. O contexto é local: esses comandos não alteram nada no
Partner Center nem no PlayFab.

## Comandos

| Comando | Descrição |
| - | - |
| `context get` | Mostra os valores salvos. |
| `context set` | Salva um valor. |
| `context unset` | Remove valores salvos. |
| `context key list` | Lista as chaves que você pode salvar e os comandos que usam cada uma. Não exige entrada. |
| `context profile list` | Lista seus perfis, começando por `default`. |
| `context profile delete` | Exclui um perfil nomeado e todos os valores salvos nele. |

## Chaves

Uma chave é o nome da opção que ela preenche:

| Chave | Opção | Variável | Usada por |
| - | - | - | - |
| `playfab-title-id` | `--playfab-title-id` | `XBOX_PLAYFAB_TITLE_ID` | Comandos [`playfab`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab) |
| `sandbox-id` | `--sandbox-id` | `XBOX_SANDBOX_ID` | [`xbl`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/xbl) `config status` e `config publish` |
| `seller-id` | `--seller-id` | `XBOX_SELLER_ID` | Comandos [`audience`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/audience), [`game`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/game), [`package`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/package), [`playtest`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playtest), [`sandbox`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/sandbox), [`test-account`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/test-account) e [`xbl`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/xbl) |
| `title-id` | `--title-id` | `XBOX_TITLE_ID` | [`xbl`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/xbl#title-targeting) `config list`, `config status`, `config publish` e `config download` e `config save` com escopo de sandbox |

Nenhuma outra opção aceita um valor salvo ou uma variável.

`title-id` é uma ID de título do XBOX em hexadecimal, como `1234ABCD`, e não uma ID de título do PlayFab. Os
comandos `xbl` a usam para encontrar o identificador de configuração de serviço (SCID) do título e a ignoram
quando você passa `--scid`. Consulte [Direcionamento de título](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/xbl.md#title-targeting).

## Como os comandos usam os valores salvos

Quando um comando aceita uma dessas opções, ele usa o primeiro valor que encontra:

1. A opção na linha de comando, como `--seller-id`.
2. A variável `XBOX_` da opção, como `XBOX_SELLER_ID`. Uma variável em branco conta como não definida.
3. O valor salvo com `context set` no [perfil](#profiles) selecionado.

```bash theme={null}
xbox context set playfab-title-id ABC123
xbox playfab title-data get                                # uses ABC123
XBOX_PLAYFAB_TITLE_ID=DEF456 xbox playfab title-data get   # uses DEF456
xbox --playfab-title-id GHI789 playfab title-data get      # uses GHI789
```

Um valor vindo de uma variável ou do contexto salvo é verificado como um valor digitado, e um erro indica de onde ele
veio, como `XBOX_SELLER_ID: --seller-id must be a positive numeric value.` Se nada
fornecer um valor de que um comando precisa, ele informa como defini-lo. Os comandos em que o vendedor é
opcional, `xbl` e `test-account`, usam seu único vendedor autorizado.

Um comando que altera algo grava em stderr cada valor que preencheu e de onde ele veio,
mesmo com `--confirm`. Com `--verbose`, todos os comandos fazem isso:

```text theme={null}
Using --playfab-title-id ABC123 from saved context.
```

[Problemas conhecidos](https://docs.xbox.com/pt-BR/tools/xbox-cli/known-issues.md) descreve dois problemas que fazem os comandos `game` e `sandbox`
usarem um vendedor diferente daquele escolhido dessa forma.

## Perfis

Um perfil é um conjunto nomeado de valores salvos, como um para um título de teste e outro para produção.
Os comandos usam o perfil indicado por `--profile`; caso contrário, o indicado por `XBOX_PROFILE`; caso contrário, `default`.

```bash theme={null}
xbox --profile test context set playfab-title-id TEST1   # creates "test"
xbox --profile test playfab title-data get               # uses TEST1
xbox playfab title-data get                              # uses the default profile
```

Para usar um perfil em todos os comandos de um shell, defina `XBOX_PROFILE`:

```bash theme={null}
export XBOX_PROFILE=test
```

Para listar seus perfis:

```bash theme={null}
xbox context profile list
```

Para excluir um perfil e todos os valores salvos nele:

```bash theme={null}
xbox context profile delete test
```

* Salvar o primeiro valor em um perfil o cria. Os nomes contêm letras, dígitos e hifens, com até
  64 caracteres, e não diferenciam maiúsculas de minúsculas.

* Um perfil que não existe, como um com erro de digitação, falha em vez de recorrer a
  `default`.

* Um perfil não herda valores de `default`.

* As variáveis `XBOX_` continuam prevalecendo sobre um perfil. Quando uma delas prevalece sobre o perfil indicado por `--profile`,
  o comando informa isso, mesmo que não altere nada:

  ```text theme={null}
  Using --playfab-title-id PROD1 from XBOX_PLAYFAB_TITLE_ID, not profile test.
  ```

* A CLI não memoriza um perfil entre comandos; portanto, escolher um nunca altera o que
  outro terminal ou agente usa.

## Onde os valores são salvos

Os valores salvos ficam em `context.json` no diretório de estado da CLI:

| SO | Diretório |
| - | - |
| Windows | `%LOCALAPPDATA%\XboxDevCLI` |
| macOS | `~/Library/Application Support/XboxDevCLI` |
| Linux | `$XDG_DATA_HOME/XboxDevCLI`, por padrão `~/.local/share/XboxDevCLI` |

Cada valor pertence à conta que o salvou, de modo que outra conta não o utiliza.
`auth logout` mantém os valores salvos, e entrar novamente com a mesma conta os restaura.

## Argumentos e opções

| Argumento ou opção | Comandos | Descrição |
| - | - | - |
| `<key> <value>` | `set` | A chave a ser salva e seu valor. O valor deve ser válido para a opção da chave: `seller-id` é um número positivo (consulte [`xbox seller list`](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/seller)) e `playfab-title-id` contém letras e dígitos. |
| `<key>...` | `unset` | Chaves a serem removidas. Remover uma chave que não está salva é bem-sucedido. |
| `<name>` | `profile delete` | O perfil a ser excluído. `default` não pode ser excluído. |
| `--profile <name>` | Todos | Usa este perfil em vez do perfil de `XBOX_PROFILE` ou de `default`. Uma [opção global](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands.md). |
| `--all` | `unset` | Remove todos os valores salvos no perfil selecionado. Não pode ser combinada com nomes de chave. |
| `--base-url <url>` | `get`, `set`, `unset` | Substitui a configuração `XboxPartner:BaseUrl`. Os valores de vendedor salvos pertencem ao ponto de extremidade para o qual foram salvos. |
| `--output <format>` | Todos | `json` (padrão), `json-compact` ou `table`. |

## Comportamento

`get` retorna a `account` conectada, o `profile` e uma matriz `values` de `key` e `value`,
com `null` para uma chave que não está salva. Ele mostra o que está salvo, e não o que um comando usaria; execute
o comando com `--verbose` para ver isso. Sem entrada, `get` não mostra valores e informa como
entrar.

`set`, `unset` e os comandos `profile` exigem uma conta conectada. `set` não verifica o
valor com o serviço; portanto, um vendedor que você não pode usar falha no primeiro comando que o envia.

Uma entidade de serviço não tem contexto salvo. Em um modo de entidade de serviço, os comandos que entram
recusam `--profile` e `XBOX_PROFILE`, e todos os comandos `context`, exceto `key list`, falham. Em vez disso, passe
cada valor com sua opção ou variável `XBOX_`. Consulte
[Autenticação de automação (entidade de serviço)](https://docs.xbox.com/pt-BR/tools/xbox-cli/authentication.md#automation-service-principal-authentication).

## Valores que não vêm da linha de comando

O contexto salvo é compartilhado por todos os terminais e agentes que seu usuário do SO executa, e as variáveis de ambiente
não aparecem na linha de comando. Portanto, além de indicar cada valor que preencheu:

* Uma operação cujo destino é o próprio valor do contexto deve tê-lo na linha de comando.
  `/Admin/DeleteTitle` exclui o título, e `playfab api-policy set --overwrite` substitui toda a
  sua política de acesso à API; por isso, cada um recusa um título vindo do contexto salvo ou de uma variável e imprime
  o comando a ser executado em vez disso:

  ```text theme={null}
  $ xbox playfab api /Admin/DeleteTitle --confirm
  Using --playfab-title-id ABC123 from saved context.
  '/Admin/DeleteTitle' acts on playfab-title-id ABC123, which comes from saved context.
  The target of a destructive operation must be named on the command line. To proceed, run:
    xbox --playfab-title-id ABC123 playfab api /Admin/DeleteTitle --confirm
  ```

  O comando impresso omite um valor embutido de `--body` ou `--statements`, porque o corpo de uma
  solicitação pode conter segredos. Coloque o valor de volta no lugar de `<body>` ou `<statements>`.

* Se outra conta entrar enquanto um comando que usa valores salvos estiver em execução, por exemplo enquanto ele
  aguarda confirmação, o comando para antes de enviar qualquer coisa. Execute-o novamente.

Consulte [Segurança e operações destrutivas](https://docs.xbox.com/pt-BR/tools/xbox-cli/safety.md) para conhecer as regras de confirmação.

## Saída em tabela

Todos os comandos de contexto aceitam `--output table`:

| Comando | Colunas |
| - | - |
| `context get`, `set`, `unset` | `KEY`, `VALUE` |
| `context key list` | `KEY`, `USED BY` |
| `context profile list`, `profile delete` | `NAME` |

## Exemplos

Liste as chaves que você pode salvar:

```bash theme={null}
xbox context key list --output table
```

Salve um vendedor e um título do PlayFab e verifique o que está salvo:

```bash theme={null}
xbox context set seller-id 1234567
xbox context set playfab-title-id ABC123
xbox context get --output table
```

Execute comandos que usam os valores salvos e veja de onde veio o título:

```bash theme={null}
xbox game list
xbox --verbose playfab title-data get
```

Remova um valor salvo:

```bash theme={null}
xbox context unset playfab-title-id
```

Remova todos os valores salvos no perfil selecionado:

```bash theme={null}
xbox context unset --all
```

Consulte [Configuração](https://docs.xbox.com/pt-BR/tools/xbox-cli/configuration.md) para conhecer as configurações, que o contexto não altera.


## Related topics

- [Contexto do jogo](https://docs.xbox.com/pt-BR/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/game-context.md)
- [Modelos de contexto do CloudScript do PlayFab usando Azure Functions](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/CloudScript-af-context.md)
- [Guia de operações assíncronas do SDK C++ de Lobby e Matchmaking](https://docs.xbox.com/pt-BR/services/playfab/multiplayer/lobby/lobby-and-matchmaking-client-sdk-async.md)
- [Manipulação de áudio em tempo real](https://docs.xbox.com/pt-BR/services/xbox-services/multiplayer/chat/game-chat2/real-time-audio-manipulation.md)
- [Diretriz de acessibilidade do XBOX 114](https://docs.xbox.com/pt-BR/build/game-principles/accessibility/xag-deep-dives/xag-114-ui-context.md)
