As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Constantes, funções e eventos para sessões de streaming de WorkSpaces aplicativos incorporados da Amazon
<a name="constants-functions-events-embedded-sessions"></a>

Os tópicos a seguir fornecem informações de referência para constantes, funções e eventos que você pode usar para configurar sessões de streaming de WorkSpaces aplicativos incorporados.

**Topics**
+ [Trabalhar com o `HIDDEN_ELEMENTS`](#constants-hidden-elements)
+ [Funções para o objeto `AppStream.Embed`](#functions-embed-object)
+ [Eventos para sessões de streaming WorkSpaces de aplicativos incorporados](#events-embedded-streaming-sessions)
+ [Exemplos para adicionar ouvintes de eventos e encerrar uma sessão de streaming de WorkSpaces aplicativos incorporados](#examples-add-event-listeners-end-embedded-streaming-session)

Os seguintes elementos da interface de usuário de WorkSpaces aplicativos podem ser passados para a opção de `HIDDEN_ELEMENTS` configuração quando uma sessão de streaming de WorkSpaces aplicativos incorporados é inicializada.

## Trabalhar com o `HIDDEN_ELEMENTS`
<a name="constants-hidden-elements"></a>

Os seguintes elementos da interface de usuário de WorkSpaces aplicativos podem ser passados como constantes para a opção de `HIDDEN_ELEMENTS` configuração quando uma sessão de streaming de WorkSpaces aplicativos incorporados é inicializada. 

```
AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON
AppStream.Embed.Elements.TOOLBAR
AppStream.Embed.Elements.CATALOG_BUTTON
AppStream.Embed.Elements.WINDOW_SWITCHER_BUTTON
AppStream.Embed.Elements.FILES_BUTTON
AppStream.Embed.Elements.CLIPBOARD_BUTTON
AppStream.Embed.Elements.COPY_LOCAL_BUTTON
AppStream.Embed.Elements.PASTE_REMOTE_BUTTON
AppStream.Embed.Elements.SETTINGS_BUTTON
AppStream.Embed.Elements.STREAMING_MODE_BUTTON
AppStream.Embed.Elements.SCREEN_RESOLUTION_BUTTON
AppStream.Embed.Elements.REGIONAL_SETTINGS_BUTTON
AppStream.Embed.Elements.FULLSCREEN_BUTTON
AppStream.Embed.Elements.END_SESSION_BUTTON
```

Os três elementos a seguir podem ser passados como strings para HIDDEN\$1ELEMENTS, em vez de como constantes.


| String | Description | 
| --- | --- | 
| 'adminCommandsButton' | Quando você está conectado a um construtor de imagens de WorkSpaces aplicativos, o botão Comandos administrativos é exibido no canto superior direito da barra de ferramentas de WorkSpaces aplicativos. Passar essa string para HIDDEN\$1ELEMENTS oculta o botão Admin Commands (Comandos de administrador). | 
| 'softKeyboardButton' | Durante as sessões de streaming de WorkSpaces aplicativos em dispositivos sensíveis ao toque, os usuários podem tocar no ícone do teclado na barra de ferramentas de WorkSpaces aplicativos para exibir o teclado na tela. Passar essa string para HIDDEN\$1ELEMENTS oculta o ícone do teclado. | 
| 'keyboardShortcutsButton' | Durante as sessões de streaming de WorkSpaces aplicativos em dispositivos sensíveis ao toque, os usuários podem tocar no ícone Fn na barra de ferramentas de WorkSpaces aplicativos para exibir os atalhos do teclado. Passar essa string para HIDDEN\$1ELEMENTS oculta o ícone Fn. | 

## Funções para o objeto `AppStream.Embed`
<a name="functions-embed-object"></a>

A tabela a seguir lista as funções que podem ser executadas no objeto `AppStream.Embed`. 


| Função | Description | 
| --- | --- | 
| AppStream.Embed(containerId:string, options:object) | O construtor do objeto AppStream.Embed. Este construtor inicializa e se comunica com o objeto AppStream.Embed e usa um ID de contêiner div. O ID é usado para injetar o iframe. Ele também injeta um objeto que inclui as opções de configuração para appstreamOptions (sessionURLeHIDDEN\$1ELEMENTS).  | 
| endSession() | Essa função encerra a sessão de streaming, mas não destrói o iframe. Se você especificar um URL de redirecionamento, o iframe tentará carregar o URL. Dependendo dos cabeçalhos CORS da página, o URL pode não ser carregado.  | 
| launchApp(appId:string) | Esta função inicia programaticamente um aplicativo com o ID do aplicativo especificado durante a criação da imagem.  | 
| launchAppSwitcher() | Essa função envia o AppSwitcher comando para o portal de WorkSpaces aplicativos. Isso aciona o comando AppSwitcher na instância.  | 
| getSessionState() | Essa função retorna um objeto para sessionStatus. Para obter mais informações, consulte [Eventos para sessões de streaming WorkSpaces de aplicativos incorporados](#events-embedded-streaming-sessions).  | 
| getUserInterfaceState() | Essa função retorna um objeto para `UserInterfaceState`. O objeto contém os pares de chave/valor para o seguinte:  `sessionStatus`: enumeração de estado `sessionTerminationReason`: string `sessionDisconnectionReason`: string  Para obter mais informações, consulte [Eventos para sessões de streaming WorkSpaces de aplicativos incorporados](#events-embedded-streaming-sessions).  | 
| addEventListener(name, callback) | Essa função adiciona uma função de retorno de chamada para quando o evento especificado é acionado. Para obter uma lista dos eventos que podem ser acionados, consulte [Eventos para sessões de streaming WorkSpaces de aplicativos incorporados](#events-embedded-streaming-sessions).  | 
| removeEventListener(name, callback) | Essa função remove o retorno de chamada para os eventos especificados.  | 
| destroy() | Essa função exclui o iframe e limpa os recursos. Essa função não afeta as sessões de streaming que estão em andamento.  | 

## Eventos para sessões de streaming WorkSpaces de aplicativos incorporados
<a name="events-embedded-streaming-sessions"></a>

A tabela a seguir lista os eventos que podem ser acionados durante as sessões de streaming de WorkSpaces aplicativos incorporados.


| Event | Dados | Description | 
| --- | --- | --- | 
| AppStream.Embed.Events.SESSION\$1STATE\$1CHANGE |  `sessionStatus`: `State enumeration` `sessionTerminationReason`: string `sessionDisconnectionReason`: string  | Esse evento é acionado quando ocorre qualquer alteração no estado da sessão. O evento inclui um mapa dos estados que foram alterados. Para recuperar o estado da sessão completa, use a função `getSessionState()`. Veja a seguir os estados da sessão: `AppStream.Embed.SessionStatus.Unknown`: a sessão não foi iniciada e não está reservada `AppStream.Embed.SessionStatus.Reserved`: a sessão está reservada, mas não foi iniciada.  `AppStream.Embed.SessionStatus.Started`: o usuário se conectou à sessão e iniciou o streaming. `AppStream.Embed.SessionStatus Disconnected `: o usuário se desconectou da sessão. `AppStream.Embed.SessionStatus.Ended`: a sessão foi marcada como encerrada ou expirada.  | 
| AppStream.Embed.Events.SESSION\$1INTERFACE\$1STATE\$1CHANGE | `hiddenElements`: matriz de strings  `isFullscreen`: booliano `isSoftKeyboardVisible`: booliano  | Esse evento é acionado quando ocorre qualquer alteração no estado da sessão. O evento inclui um mapa dos estados que foram alterados. Para recuperar o estado da sessão completa, use a função getSessionState(). | 
| AppStream.Embed.Events.SESSION\$1ERROR | `errorCode`: número `errorMessage`: string  | Esse evento é acionado quando ocorrem erros durante uma sessão. | 

## Exemplos para adicionar ouvintes de eventos e encerrar uma sessão de streaming de WorkSpaces aplicativos incorporados
<a name="examples-add-event-listeners-end-embedded-streaming-session"></a>

Os exemplos nesta seção mostram como fazer o seguinte:
+ Adicione ouvintes de eventos para sessões de streaming de WorkSpaces aplicativos incorporados.
+ Encerre programaticamente uma sessão de streaming de WorkSpaces aplicativos incorporados.

### Exemplo 1: Adicionar ouvintes de eventos para sessões de streaming de WorkSpaces aplicativos incorporados
<a name="example-add-event-listeners"></a>

Para adicionar listeners de eventos para alterações de estado de sessão, alterações de estado da interface da sessão e erros de sessão durante as sessões de streaming incorporadas, use o seguinte código:

```
appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_STATE_CHANGE, updateSessionStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE, updateUserInterfaceStateCallback);

appstreamEmbed.addEventListener(AppStream.Embed.Events.SESSION_ERROR, errorCallback);
```

Neste exemplo, `AppStream.Embed.Events.SESSION_STATE_CHANGE`, `AppStream.Embed.Events.SESSION_INTERFACE_STATE_CHANGE` e `AppStream.Embed.Events.SESSION_ERROR` são nomes de eventos.

As funções `updateSessionStateCallback`, `updateUserInterfaceStateCallback` e `errorCallback` são as que você implementa. Essas funções são passadas para a função `addEventListener` e chamadas quando um evento é acionado.

### Exemplo 2: Encerrar programaticamente uma sessão de streaming de WorkSpaces aplicativos incorporados
<a name="programmatically-end-embedded-streaming-session"></a>

Para encerrar uma sessão de streaming de WorkSpaces aplicativos incorporados, use a seguinte função:

```
appstreamEmbed.endSession();
```