Source: https://rox.chat/kb/pt/mobile/sdk/ios-additional-features.html

> Este artigo lista os recursos do Rox.Chat Mobile SDK para iOS que não estão disponíveis por padrão. Para ativá-los, entre em contato com o suporte técnico.

# Recursos adicionais do Rox.Chat Mobile SDK para iOS

Este artigo lista os recursos do **Rox.Chat Mobile SDK** para **iOS** que não estão disponíveis por padrão. Para ativá-los, entre em contato com o [suporte técnico](mailto:support@rox.chat).

!!! Note "N.B."
    Este artigo é um complemento do [manual principal](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html) sobre o **Rox.Chat Mobile SDK** para **iOS**.

## Classe `Roxchat` { #rox-chat }

### Método da classe `newFAQBuilder()` { #newfaqbuilder }

Método necessário para obter um objeto [`FAQBuilder`](#faqbuilder), que, por sua vez, é necessário para criar uma instância da classe [`FAQ`](#faq).

## Classe `FAQBuilder` { #faqbuilder }

Uma classe cuja instância é usada para obter uma instância da classe [`FAQ`](#faq). Uma instância da classe é obtida usando o método [`newFAQBuilder()`](#newfaqbuilder) da classe [`Roxchat`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#roxchat).

### Método de instância `set(accountName:)` { #faqbuilder-set-accountname }

O método é necessário para definir o nome da conta no sistema **Rox.Chat** ao criar um bloco de FAQ.

O parâmetro `accountName` é o nome da conta do cliente no sistema **Rox.Chat**. Normalmente é uma URL do servidor (por exemplo, `https://demo.rox.chat`), mas pode ser um nome de conta com uma única palavra (por exemplo, `demo`) se o servidor estiver no domínio `rox.chat.`.

Retorna a mesma instância da classe [`FAQBuilder`](#faqbuilder), mas com o nome da conta definido. A chamada do método é necessária para obter uma instância de [`FAQ`](#faq).

### Método de instância `set(application:)`

O método é necessário para definir o nome do aplicativo no sistema **Rox.Chat** ao criar um bloco de FAQ.

O parâmetro `application` é o nome do aplicativo cliente no sistema **Rox.Chat**.

Retorna a mesma instância da classe [`FAQBuilder`](#faqbuilder), mas com o nome da conta definido.

### Método de instância `set(departmentKey:)`

O método é necessário para definir a chave do departamento no sistema **Rox.Chat** ao criar um bloco de FAQ.

O parâmetro `departmentKey` é o nome do aplicativo do cliente no sistema **Rox.Chat**.

Retorna a mesma instância da classe [`FAQBuilder`](#faqbuilder), mas com o nome da conta definido.

### Método de instância `set(language:)`

O método é necessário para definir o idioma no sistema **Rox.Chat** ao criar um bloco de FAQ.

O parâmetro `language` é o idioma do cliente no sistema **Rox.Chat**.

Retorna a mesma instância da classe [`FAQBuilder`](#faqbuilder), mas com o nome da conta definido.

### Método de instância `build()` { #faqbuilder-build }

Um método que é chamado na conclusão dos métodos acima para obter uma instância de `FAQ`.

Retorna um objeto `FAQ` com os parâmetros definidos usando o restante dos métodos de instância da classe.

Pode gerar erros do tipo [`FAQBuilderError`](#faq-builder-error).

Requer a chamada do método [`set(accountName:)`](#faqbuilder-set-accountname).

---

## Protocolo `FAQ` { #faq }

Um protocolo que permite a manipulação da lista atual de perguntas frequentes. Uma instância da classe `FAQ` é obtida usando os métodos da classe [`FAQBuilder`](#faqbuilder).

### Método de instância `resume()` { #faq-resume }

Quando uma instância da classe `FAQ` é criada, sua lista de FAQs correspondente fica em um estado suspenso. Esse método é necessário para iniciar a atividade da rede.

Ele pode gerar erros como [`FAQAccessError`](#faq-access-error). Necessário para que o serviço funcione totalmente no contexto do aplicativo.

### Método de instância `pause()` { #faq-pause }

Um método que é usado para pausar a atividade da rede. Se a lista de perguntas frequentes já estiver em um estado suspenso, o método não executará nenhuma ação.

Pode gerar erros do tipo [`FAQAccessError`](#faq-access-error). A lista de FAQs não deve estar em um estado desativado para que o método seja chamado.

### Método de instância `destroy()` { #faq-destroy }

Um método que é usado para desativar a lista de FAQs e a instância da classe. Quando esse método é chamado, nenhum método pode ser usado.

Pode gerar erros como [`FAQAccessError`](#faq-access-error).

### Método de instância `getCategory(id:completionHandler:)`

Método usado para obter um objeto da classe [`FAQCategory`](#faq-category) por meio do `completionHandler`.

O parâmetro `id` é o ID da categoria do bloco de FAQ. O tipo é `String`.

O parâmetro `completionHandler` é um fechamento que é executado depois que a execução do método é concluída. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQCategory`](#faq-category); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `getCategoriesForApplication(completionHandler:)`

Método usado para obter uma matriz de IDs de categoria que correspondem aos parâmetros fornecidos por meio do `completionHandler`. Só funciona quando os parâmetros do aplicativo são especificados.

O parâmetro `completionHandler` é um fechamento que é executado quando o método é concluído. Se o método for concluído com êxito, a closure aceitará uma matriz de identificadores de categoria do tipo `String`; se não for bem-sucedida, aceitará um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `getCachedCategory(id:completionHandler:)`

Método usado para recuperar um objeto da classe [`FAQCategory`](#faq-category) por meio do `completionHandler` de um cache armazenado.

O parâmetro `id` é o ID da categoria do bloco de FAQ. O tipo é `String`.

O parâmetro `completionHandler` é um fechamento que é executado depois que a execução do método é concluída. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQCategory`](#faq-category); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `getItem(id:openFrom:completionHandler:)`

Método usado para obter um objeto da classe [`FAQItem`](#faq-item) por meio do `completionHandler`.

O parâmetro `id` é o ID da página do bloco de FAQ. O tipo é `String`.

Parâmetro `openFrom` - solicitação de artigo de uma determinada fonte. Tipo - opcional [`FAQItemSource`](#faq-item-source).

O parâmetro `completionHandler` é um fechamento que é executado depois que o método é concluído. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQItem`](#faq-item); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `getCachedItem(id:openFrom:completionHandler:)`

Método usado para recuperar um objeto da classe [`FAQItem`](#faq-item) por meio do `completionHandler` do cache.

O parâmetro `id` é o ID da página do bloco de FAQ. O tipo é `String`.

Parâmetro `openFrom` - solicitação de um artigo de uma determinada fonte. Tipo - opcional [`FAQItemSource`](#faq-item-source).

O parâmetro `completionHandler` é um fechamento que é executado depois que o método é concluído. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQItem`](#faq-item); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `funcgetStructure(id:completionHandler:)`

Método usado para obter um objeto da classe [`FAQStructure()`](#faq-structure) por meio do `completionHandler.`

O parâmetro `id` é o ID do nó que será a raiz da árvore (estrutura) do bloco de FAQ. O tipo é `String`.

O parâmetro `completionHandler` é um fechamento que é executado depois que a execução do método é concluída. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQStructure()`](#faq-structure); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `getCachedStructure(id:completionHandler:)`

Método usado para recuperar um objeto da classe [`FAQStructure()`](#faq-structure) por meio do `completionHandler` do cache.

O parâmetro `id` é o ID do nó que será a raiz da árvore (estrutura) do bloco de FAQ. O tipo é `String`.

Parâmetro `completionHandler` - fechamento, que é executado após a conclusão da execução do método. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQStructure()`](#faq-structure); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `func like(item:completionHandler:)`

Um método que permite que você coloque uma marca “like” em um artigo.

O parâmetro `item` é a página a ser classificada. O tipo é [`FAQItem`](#faq-item).

Parâmetro `completionHandler` - um fechamento que é executado depois que o método é concluído. Se o método for concluído com êxito, a closure recebe um parâmetro do tipo [`FAQItem`](#faq-item); se não for bem-sucedida, recebe um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não tem tipo de retorno.

O método requer uma chamada para o método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `dislike(item:completionHandler:)`

Um método que permite que você coloque uma marca de “não gosto” em um artigo.

Importante: o método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

O parâmetro `item` é a página a ser classificada. O tipo é [`FAQItem`](#faq-item).

O parâmetro `completionHandler` é um fechamento que é executado depois que o método é concluído. Se o método for concluído com êxito, o fechamento receberá um parâmetro do tipo [`FAQItem`](#faq-item); se não for bem-sucedido, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

### Método de instância `search(query:category:limitOfItems:completionHandler:)`

Um método que pesquisa artigos com base em uma palavra-chave.

O parâmetro `query` é a consulta que está sendo pesquisada. O tipo é `String`.

O parâmetro `category` é o ID da categoria que está sendo pesquisada. Tipo - `String`.

Parâmetro `limitOfItems` - o número máximo de artigos que devem ser retornados.

Parâmetro `completionHandler` - fechamento, que é executado após a conclusão da execução do método. Se o método for concluído com êxito, a closure receberá um parâmetro do tipo [`FAQSearchItem`](#faq-search-item); se não for bem-sucedida, receberá um parâmetro do tipo [`FAQGetCompletionHandlerError`](#faq-get-completion-handler-error) e não terá nenhum tipo de retorno.

O método requer uma chamada ao método [`resume()`](#faq-resume) para funcionar corretamente.

---

## Protocolo `FAQCategory` { #faq-category }

Representação de uma categoria de um bloco de perguntas frequentes. Fornece métodos para recuperar informações sobre uma categoria. Os objetos `FAQCategory` podem ser recuperados usando o `completionHandler` nos métodos `getCategory(id:completion:)` e `getCachedCategory(id:completionHandler:)`.

### Método de instância `getID()`

Retorna o identificador da categoria. O tipo é `String`.

### Método de instância `getTitle()`

Retorna o título da categoria. O tipo é `String`.

### Método de instância `getItems()`

A categoria contém as páginas do bloco FAQ.

Retorna as páginas pertencentes à categoria. O tipo é [`FAQItem`](#faq-item).

### Método de instância `getSubcategories()` { #faq-category-get-subcategories }

Uma categoria contém subcategorias. Por conveniência, esse método retorna informações de subcategorias sem suas páginas e subcategorias.

Retorna informações sobre subcategorias pertencentes a uma categoria. O tipo é [`FAQCategoryInfo`](#faq-category-info).

---

## Protocolo `FAQItem` { #faq-item }

Representação da página de bloco de FAQ. Fornece métodos para recuperar informações sobre a página. Os objetos `FAQItem` podem ser recuperados da função `completionHandler` `getItem(id:completionHandler:)`.

### Método de instância `getId()`.

Retorna o identificador da página. O tipo é `String`.

### Método de instância `getTitle()`

Retorna o título da página. O tipo é `String`.

### Método de instância `getCategories()`

Uma página pode pertencer a várias categorias.

Retorna os identificadores das categorias às quais a página pertence. O tipo é `String`.

### Método de instância `getTags()`

A página tem um conjunto de tags.

Retorna uma lista de tags com as quais a página está marcada. O tipo é `String`.

### Método de instância `getContent()`

Retorna o conteúdo da página. O tipo é `String`.

### Método de instância `getLikeCount()`

A página contém o número de marcas de “Curtir”.

Retorna o número de marcas de “Curtir” da página. O tipo é `Int`.

### Método de instância `getDislikeCount()`

A página contém o número de marcas de “Não gostei”.

Retorna o número de marcas de “Não gostei” da página. O tipo é `Int`.

### Método de instância `getUserRate()`

A página pode ser marcada pelo usuário.

Retorna a classificação do usuário. O tipo é [`UserRate`](#user-rate).

---

## Protocolo `FAQCategoryInfo` { #faq-category-info }

Representação das informações de categoria do bloco de FAQ. Fornece métodos para recuperar o identificador e o cabeçalho da categoria. Os objetos `FAQCategoryInfo` podem ser recuperados usando o método [`getSubcategories()`](#faq-category-get-subcategories).

### Método de instância `getID()`

Retorna o identificador da categoria. O tipo é `String`.

### Método de instância `getTitle()`

Retorna o título da categoria. O tipo é `String`.

---

## Protocolo `FAQSearchItem` { #faq-search-item }

Um resumo das páginas recuperadas de uma pesquisa por palavra-chave.

### Método de instância `getID()`

Retorna o identificador de página da página. O tipo é `String`.

### Método de instância `getTitle()`

Retorna o título da página. O tipo é `String`.

### Método de instância `getScore()`

A página tem uma pontuação de pesquisa. Quanto maior a pontuação, mais a página corresponde à consulta de pesquisa. Retorna a pontuação da pesquisa. O tipo é `Double`.

---

## Protocolo `FAQStructure` { #faq-structure }

Representação da árvore (estrutura) do bloco de FAQ. Fornece métodos para recuperar informações sobre a árvore do bloco de FAQ.

Os objetos `FAQStructure` podem ser recuperados usando o método `completionHandler` `getStructure(id:completionHandler:)`.

### Método de instância `getID()`

A árvore tem um elemento raiz.

Retorna o identificador do elemento raiz da árvore. O tipo é `String`.

### Método de instância `getTitle()`

Retorna o título do elemento raiz. O tipo é `String`.

### Método de instância `getType()` { #faq-structure-get-type }

A raiz da árvore pode ser uma categoria ou uma página.

Retorna o tipo do elemento raiz. O tipo é [`RootType`](#root-type).

### Método de instância `getChildren()`

Retorna as subárvores cujas raízes são descendentes diretas da raiz da árvore (estrutura). O tipo é [`FAQStructure`](#faq-structure).

---

## Tipo enumerado `UserRate` { #user-rate }

A página pode ser avaliada pelo usuário.

### Case `like`

O usuário gostou da página.

### Caso de `dislike`

O usuário não gostou da página.

### Caso `noRate`

A página não foi avaliada pelo usuário.

---

## Tipo enumerado `FAQAccessError` { #faq-access-error }

O valor do tipo corresponde a erros que podem ser lançados por alguns métodos do protocolo [`FAQ`](#faq).

### Case `invalidThread`

Ocorre quando um método foi chamado de um thread diferente do thread no qual a instância do bloco de FAQ foi criada.

### Caso `invalidFaq`

Ocorre quando há tentativa de usar métodos de uma instância inválida de [`FAQ`](#faq) (por exemplo, depois que o método [`destroy()`](#faq-destroy) foi chamado nela).

---

## Tipo enumerado `FAQBuilderError` { #faq-builder-error }

Os valores do tipo correspondem a possíveis erros que podem ocorrer ao chamar o método [`build()`](#faqbuilder-build) da classe [`FAQBuilder`](#faqbuilder).

### Case `nilAccountName`

Ocorre quando nenhum valor de nome de conta foi passado ao criar o bloco de FAQ.

---

## Tipo enumerado `FAQGetCompletionHandlerError` { #faq-get-completion-handler-error }

Possíveis erros que podem ser lançados pelos métodos do protocolo [`FAQ`](#faq).

### Case `ERROR`

Erro encontrado.

---

## Tipo enumerado `FAQItemSource` { #faq-item-source }

A possível origem do artigo. O artigo pode vir de uma pesquisa ou de uma estrutura ou categoria.

### Case `search`

O artigo é solicitado a partir de uma pesquisa.

### Case `tree`

O artigo é solicitado a partir de uma estrutura ou categoria.

---

## Tipo enumerado `RootType` { #root-type }

Tipos possíveis da raiz da árvore de blocos de FAQ (consulte o método [`getType()`](#faq-structure-get-type) do protocolo [`FAQStructure`](#faq-structure)).

### Case `item`

A raiz da árvore é uma página.

### Case `category`

A raiz da árvore é uma categoria.

### Case `unknown` (desconhecido)

A raiz da árvore tem um tipo desconhecido para esta versão do SDK.

---

## Classe `SessionBuilder`

### Método `set(prechat:)`

Um método que pode ser usado para definir campos com informações adicionais que ficarão visíveis para o operador.

O parâmetro `prechat` é um campo com informações adicionais no formato `JSON`. O tipo de parâmetro é `String`.

Retorna a mesma instância da classe `SessionBuilder`, mas com os campos definidos. Para obter uma instância da classe [`RoxchatSession`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#roxchat-session), a chamada do método é opcional.

### Método `set(multivistorSection:)`

Método para definir as configurações para receber notificações por push do serviço **Rox.Chat** quando várias sessões estiverem em execução no mesmo dispositivo.

O tipo de parâmetro `multivisitorSection` é `String`.

Retorna a mesma instância da classe [`SessionBuilder`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#session-builder), mas com o campo definido.

É opcional chamar o método para obter uma instância da classe [`RoxchatSession`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#roxchat-session).

### Método `set(onlineStatusRequestFrequencyInMillis:)`

Um método para especificar a frequência das solicitações ao servidor em milissegundos.

O parâmetro `onlineStatusRequestFrequencyInMillis` é `Int64`.

Retorna a mesma instância da classe [`SessionBuilder`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#session-builder), mas com o valor da opção correspondente definido manualmente.

---

## Protocolo `RoxchatSession`

### Método de instância `change(location:)`

Esse método é usado para alterar o nome de um local em uma sessão existente. Chamar o método é mais ou menos análogo ao resultado da criação de uma nova sessão com parâmetros semelhantes, mas com um nome de local diferente.

O parâmetro `location` é o nome do local para o qual o valor da sessão atual deve ser alterado. O tipo é `String`.

Pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

A sessão não deve estar em estado suspenso ou desativado para chamar o método (consulte os métodos [`resume()`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#resume), [`pause()`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#pause) e [`destroy()`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#destroy)).

---

## Interface `Message`

### Método `getSticker()`

Retorna um objeto do tipo `Sticker`.

Não lança exceções.

### Método `canVisitorReact()`

O método retorna `true` se o visitante puder reagir à mensagem; caso contrário, retorna `false`.

Não lança exceções.

---

## Tipo enumerado `AttachmentState` { #attachment-state }

### Case `externalChecks`

O arquivo é verificado pelo servidor.

---

## Interface `MessageStream`

### Método `rateOperatorWith(id:note:byRating:completionHandler:)`

Use esse método para enviar a classificação do operador do visitante atual com um comentário.

O parâmetro `id` é o ID do operador cuja classificação deve ser enviada para o serviço **Rox.Chat**. O tipo é `String`. Opcional: se você passar `nil`, a avaliação será enviada para o operador de chat atual (se houver).

O parâmetro `note` é um comentário sobre a avaliação do operador que deve ser enviado ao serviço **Rox.Chat**. O comprimento máximo é de 2000 caracteres. Tipo - opcional `String`.

Parâmetro `byRating` - a classificação do operador a ser enviada ao serviço **Rox.Chat**. A classificação deve ser um número inteiro de 1 a 5 (se você especificar o contrário, o método não executará nenhuma ação). O tipo é `Int`.

O parâmetro `completionHandler` é um objeto `RateOperatorCompletionHandler`.

Pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

!!! Warning “Warning!”
    A implementação do mecanismo de avaliação do operador no chat é deixada para os desenvolvedores do aplicativo móvel!

### Método `respondSentryCall(id:)`

Use esse método para transferir o chat para o operador de plantão.

O parâmetro `id` é o ID da mensagem a ser transferida para o operador de plantão. O tipo é `String`.

Pode gerar erros do tipo [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

### Método `searchStreamMessagesBy(query:completionHandler:)` { #message-stream-searchstreammessagesby }

O método é usado para pesquisar uma mensagem no histórico por consulta.

Ele pode gerar erros do tipo `AccessError`.

O parâmetro `query` é a consulta a ser pesquisada. O tipo é `String`.

O parâmetro `completionHandler` é um objeto que implementa os métodos do protocolo [`SearchMessagesCompletionHandler`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#search-messages-completion-handler). Tipo Opcional.

### Método `set(prechatFields:)`

Envia campos adicionais para o servidor.

Pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

Parâmetro `prechatFields` - campos adicionais. O tipo é `String`.

### Método `set(surveyListener:)` { #message-stream-set-survey-listener }

Use esse método para definir o objeto [`SurveyListener`](#survey-listener).

O parâmetro `surveyListener` é um objeto que implementa a interface [`SurveyListener`](#survey-listener).

### Método `set(helloMessageListener)`

Use esse método para definir a mensagem hello.

O parâmetro `helloMessageListener` é um objeto que implementa a interface [`HelloMessageListener`](#hello-message-listener).

### Método `send(message:data:completionHandler:)` { #send-message-data }

O método é usado para enviar a mensagem de um visitante para o serviço **Rox.Chat**.

O parâmetro `message` é a mensagem a ser enviada. O tipo é `String`.

O tamanho máximo da mensagem é de 32.000 caracteres. Mensagens mais longas serão cortadas pelo servidor quando forem recebidas.

O parâmetro `data` é usado para enviar um dicionário arbitrário com parâmetros de mensagem para o servidor (se a versão do servidor oferecer suporte a essa funcionalidade). As chaves do dicionário devem ser do tipo `String` e os valores, de qualquer tipo “padrão”.

O parâmetro `completionHandler` é um objeto [`DataMessageCompletionHandler`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#data-message-completion-handler) ou `nil`.

Retorna uma ID gerada aleatoriamente para essa mensagem, que pode ser usada para identificar essa mensagem específica na lógica do aplicativo. O tipo é `String`.

Pode gerar erros do tipo [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

Se os objetos [`MessageTracker`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-tracker) e [`MessageListener`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-listener) existirem, o envio de uma mensagem invocará o método [`added(newMessage:previousMessage:)`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#added-message-new-message-after-previous-message) do protocolo [`MessageListener`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-listener) com uma nova mensagem com status [`SENDING`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#sending) do tipo enumerado [`MessageSendStatus`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-send-status).

### Método `send(uploadedFiles:completionHandler:)` { #send-uploaded-files-completion-handler }

Método para enviar arquivos carregados para o servidor **Rox.Chat**. O tipo é `UploadedFile`.

Parâmetro `uploadedFile` - lista de arquivos a serem enviados.

Parâmetro `completionHandler` - objeto que implementa métodos da interface [`SendFilesCompletionHandler`](#send-files-completion-handler). O tipo é opcional.

### Método `send(surveyAnswer:completionHandler:)` { #message-stream-send-survey-answer-completion-handler }

Use esse método para enviar a resposta à pergunta atual recebida pelo método [`SurveyListener.on(nextQuestion: SurveyQuestion)`](#survey-listener-on-next-question-survey-question).

O parâmetro `surveyAnswer` é a resposta, para uma pergunta do tipo `'stars'`, a resposta será um número inteiro entre 1 e 5 que define a pontuação do operador. Para uma pergunta do tipo `'radio'`, a resposta é o índice do elemento na matriz `options` a partir de 1. Para uma pergunta do tipo `'comment'`, a resposta é uma string que representa o comentário do usuário. O tipo é `String`.

Pode gerar erros do tipo [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

O parâmetro `completionHandler` é um objeto que implementa os métodos do protocolo [`SendSurveyAnswerCompletionHandler`](#send-survey-answer-completion-handler). Tipo Opcional.

### Método `uploadFilesToServer(file:filename:mimeType:completionHandler:)` { #upload-files-to-server-file-filename-mime-type-completion-handler }

O parâmetro `file` é o próprio arquivo no formato `Data`.

O parâmetro `filename` é o nome do arquivo. O tipo é `String`.

Parâmetro `mimeType` - tipo MIME do arquivo transferido. O tipo é `String`.

O parâmetro `completionHandler` é um objeto que implementa os métodos do protocolo [`UploadFileToServerCompletionHandler`](#upload-file-to-server-completion-handler). Tipo Opcional.

### Método `deleteUploadedFiles(fileGuid:completionHandler:)` { #delete-uploaded-files-file-guid-completion-handler }

Método para excluir arquivos do servidor **Rox.Chat**.

O parâmetro `fileGuid` é o ID do arquivo a ser excluído. O tipo é `String`.

Parâmetro `completionHandler` - objeto que implementa métodos do protocolo [`DeleteUploadedFileCompletionHandler`](#delete-uploaded-file-completion-handler). Tipo Opcional.

### Método `sendSticker(withId:completionHandler:)` { #send-sticker-with-id-completion-handler }

Use esse método para enviar um adesivo para uma sala de bate-papo.

O parâmetro `withId` é o ID do adesivo a ser enviado para o serviço **Rox.Chat**. O tipo é `int`.

Parâmetro `completionHandler` - objeto que implementa a interface [`SendStickerCompletionHandler`](#send-sticker-completion-handler). Tipo Opcional.

### Método `autocomplete(text:completionHandler)` { #autocomplete }

O método retorna uma dica.

Pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

O parâmetro `text` é o texto da dica. O tipo é `String`.

O parâmetro `completionHandler` é um objeto que implementa a interface [`AutocompleteCompletionHandler`](#autocomplete-completion-handler). O tipo é opcional.

### Método `react(message:reaction:completionHandler:)` { #message-stream-react }

Método usado para enviar a reação do usuário a uma mensagem.

Ele pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

O parâmetro `message` é a mensagem a ser respondida. O tipo é `Message`.

O parâmetro `reaction` é a reação do usuário. O tipo é `ReactionString`.

Parâmetro `completionHandler` - objeto que implementa os métodos de protocolo [`ReactionCompletionHandler`](#reaction-completion-handler). O tipo é opcional.

### Método `updateWidgetStatus(data:)`

O método é usado para atualizar o status do widget.

Ele pode gerar erros como [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

Parâmetro `data` - string no formato `JSON` com o novo status do widget. O tipo é `String`.

### Método `closeSurvey(completionHandler:)` { #message-stream-close-survey-completion-handler }

Use esse método para fechar a pesquisa.

Ele pode gerar erros do tipo [`AccessError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

O parâmetro `completionHandler` é um objeto que implementa os métodos do protocolo [`SurveyCloseCompletionHandler`](#survey-close-completion-handler). O tipo é opcional.

### Método `sendGeolocation(latitude:longitude:completionHandler:)` { #sendgeolocation }

Use esse método para enviar a geolocalização para o servidor.

O parâmetro `latitude` é a latitude. O tipo é `Double`.

O parâmetro `longitude` é a longitude. Tipo - `Double`.

O parâmetro `completionHandler` é um objeto que implementa os métodos do protocolo [GeolocationCompletionHandler](#geolocation-completion-handler). O tipo é opcional.

Pode gerar erros como [AccessError](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#access-error).

### Método `clearHistory()`

O método é chamado quando o usuário limpa o histórico.

---

## Protocolo `Operator`

### Método de instância `getInfo()`

O método permite que você obtenha informações adicionais sobre um operador específico.Retorna informações adicionais sobre um operador específico. O tipo é opcional `String`.

---

## Protocolo `SendFilesCompletionHandler` { #send-files-completion-handler }

Um objeto de protocolo pode ser passado no parâmetro `completionHandler` do método [`send(uploadedFiles:completionHandler:)`](#send-uploaded-files-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess(messageID:)`

O método é chamado quando os arquivos são enviados com êxito usando o método [`send(uploadedFiles:completionHandler:)`](#send-uploaded-files-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `messageid` é o ID da mensagem correspondente. O tipo é `String`.

### Método de instância `onFailure(messageID:error:)` { #send-files-completion-handler-on-failure-message-id-error }

Chamado quando o método [`send(uploadedFiles:completionHandler:)`](#send-uploaded-files-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) falha ao enviar arquivos.

O parâmetro `messageid` é o ID da mensagem correspondente. O tipo é `String`.

O parâmetro `error` - o erro que impediu o envio bem-sucedido do arquivo. Tipo - [`SendFilesError`](#send-files-error).

---

## Tipo enumerado `SendFilesError` { #send-files-error }

Possíveis erros que podem ser passados para o parâmetro `error` do método [`onFailure(messageID:error:)`](#send-files-completion-handler-on-failure-message-id-error) do protocolo [`SendFilesCompletionHandler`](#send-files-completion-handler).

### Case `fileNotFound`

Arquivo não encontrado.

### Case `maxFilesCountPerMessage`

Número máximo de arquivos para a mensagem.

### Case `unknown`

Erro desconhecido.

---

## Protocolo `DeleteUploadedFileCompletionHandler` { #delete-uploaded-file-completion-handler }

Um objeto orientado por protocolo pode ser passado no parâmetro `completionHandler` do método [`deleteUploadedFiles(fileGuid:completionHandler:)`](#delete-uploaded-files-file-guid-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess()`

O método é chamado quando um arquivo é excluído com êxito usando o método [`deleteUploadedFiles(fileGuid:completionHandler:)`](#delete-uploaded-files-file-guid-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onFailure(error:)` { #delete-uploaded-file-completion-handler-on-failure-error }

Chamado quando a exclusão de um arquivo falha usando o método [`deleteUploadedFiles(fileGuid:completionHandler:)`](#delete-uploaded-files-file-guid-completion-handler) protocol [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `error` é o erro que impediu que o arquivo fosse enviado com êxito. Tipo - [`DeleteUploadedFileError`](#delete-uploaded-file-error).

---

## Tipo enumerado `DeleteUploadedFileError` { #delete-uploaded-file-error }

Possíveis erros que podem ser passados para o parâmetro `error` do método [`onFailure(error:)`](#delete-uploaded-file-completion-handler-on-failure-error) do protocolo [`DeleteUploadedFileCompletionHandler`](#delete-uploaded-file-completion-handler).

### Case `fileNotFound`

Arquivo não encontrado.

### Case `fileHasBeenSent`

O arquivo foi enviado.

### Case `unknown`

Erro desconhecido.

---

## Protocolo `SendStickerCompletionHandler` { #send-sticker-completion-handler }

Um objeto de protocolo pode ser passado no parâmetro `completionHandler` do método [`send(message:completionHandler:)`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream-send-message-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método `onSuccess()`

O método é chamado quando um adesivo é enviado com sucesso usando o método [`sendSticker(withId:completionHandler:)`](#send-sticker-with-id-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método `onFailure(error:)` { #send-sticker-completion-handler-on-failure-error }

Chamado quando o envio de um adesivo falha usando o método [`send(message:completionHandler:)`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream-send-message-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `error` é o erro que impediu que o arquivo fosse enviado com êxito. Tipo - [`SendStickerError`](#send-sticker-error).

---

## Tipo enumerado `SendStickerError` { #send-sticker-error }

Possíveis erros que podem ser passados para o parâmetro `error` do método [`onFailure(error:)`](#send-sticker-completion-handler-on-failure-error) do protocolo [`SendStickerCompletionHandler`](#send-sticker-completion-handler).

### Case `noChat`

Nenhum chat foi encontrado.

### Case `noStickerId`

Nenhum ID de adesivo foi definido.

---

## Protocolo `AutocompleteCompletionHandler` { #autocomplete-completion-handler }

Um objeto que obedece ao protocolo pode ser passado no parâmetro `completionHandler` do método [`autocomplete(text:completionHandler)`](#autocomplete) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess()`

O método é chamado quando o prompt é enviado com sucesso usando o método [`autocomplete(text:completionHandler)`](#autocomplete) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onFailure(error:)`

Chamado quando um prompt é enviado sem sucesso usando o método [`autocomplete(text:completionHandler)`](#autocomplete) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `error` é o erro que impediu o envio bem-sucedido do prompt. Tipo - [`AutocompleteError`](#autocomplete-error).

---

## Tipo enumerado `AutocompleteError` { #autocomplete-error }

### Caso de `hintApiInvalid`

A API do ponto de extremidade para dicas do visitante não está definida ou não está definida corretamente.

### Caso de `unknown`

Erro desconhecido

---

## Protocolo `SurveyListener` { #survey-listener }

Um objeto que implementa o protocolo pode ser passado no parâmetro `surveyListener` do método [`set(surveyListener:)`](#message-stream-set-survey-listener) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `on(survey:)` { #survey-listener-on-survey }

Esse método é chamado quando uma nova pesquisa chega do servidor.

O parâmetro `survey` é o objeto de pesquisa. O tipo é [`Survey`](#survey).

### Método de instância `on(nextQuestion:)` { #survey-listener-on-next-question-survey-question }

Esse método é chamado em dois casos: quando você recebe uma pesquisa imediatamente após chamar [`on(survey:)`](#survey-listener-on-survey) e quando você responde com êxito à pergunta anterior da pesquisa atual.

O parâmetro `nextQuestion` é a primeira/próxima pergunta. O tipo é [`SurveyQuestion`](#survey-question).

### Método de instância `onSurveyCancelled()`

Esse método é chamado quando uma pesquisa é fechada no servidor.

---

## Protocolo `SendSurveyAnswerCompletionHandler` { #send-survey-answer-completion-handler }

Um objeto que implementa esse protocolo pode ser passado para o parâmetro `completionHandler` do método [`send(surveyAnswer:completionHandler:)`](#message-stream-send-survey-answer-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess()`

Chamado quando o método [`send(surveyAnswer:completionHandler:)`](#message-stream-send-survey-answer-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) é bem-sucedido.

### Método de instância `onFailure(error:)`

Chamado quando o método [`send(surveyAnswer:completionHandler:)`](#message-stream-send-survey-answer-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) falha.

O parâmetro `error` é o erro que impediu que o método fosse chamado com êxito. O tipo é [`SendSurveyAnswerError`](#send-survey-answer-error).

---

## Tipo enumerado `SendSurveyAnswerError` { #send-survey-answer-error }

Possíveis erros que podem ser passados para o parâmetro `error` ao chamar o método `SendSurveyAnswerCompletionHandler.onFailure(error:)`.

### Case `incorrectRadioValue`

Ocorre quando uma resposta incorreta para uma pergunta do tipo `'radio'' foi passada.

### Caso `incorrectStarsValue`

Ocorre quando uma resposta incorreta foi passada para uma pergunta do tipo `'stars'`.

### Caso `incorrectSurveyID`

Ocorre quando um ID de pesquisa inválido foi passado ao tentar enviar uma resposta a uma pergunta.

### Caso `maxCommentLength_exceeded`

Ocorre quando foi enviada uma resposta a uma pergunta do tipo ``comentário`` que excede o comprimento máximo permitido.

### Caso `noCurrentSurvey`

Ocorre quando é feita uma tentativa de enviar uma resposta a uma pergunta quando a pesquisa atual no servidor já foi encerrada ou ainda não foi iniciada.

### Caso `questionNotFound` (pergunta não encontrada)

A pergunta não foi encontrada.

### Case `surveyDisabled`

Ocorre quando se tenta enviar uma resposta a uma pergunta quando o recurso de enquete está desativado nesse servidor.

### Caso `unknown`

Erro desconhecido.

---

## Protocolo `SurveyCloseCompletionHandler` { #survey-close-completion-handler }

Um objeto que implementa esse protocolo pode ser passado para o parâmetro `completionHandler` do método [`closeSurvey(completionHandler:)`](#message-stream-close-survey-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess()`

Chamado quando a chamada ao método [`closeSurvey(completionHandler:)`](#message-stream-close-survey-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) é bem-sucedida.

### Método de instância `onFailure(error:)` { #survey-close-completion-handler-on-failure-error }

Chamado quando a chamada ao método [`closeSurvey(completionHandler:)`](#message-stream-close-survey-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) falha.

O parâmetro `error` é o erro que impediu que o método fosse chamado com êxito. Tipo - [`SurveyCloseError`](#survey-close-error).

---

## Tipo enumerado `SurveyCloseError` { #survey-close-error }

Possíveis erros que podem ser passados para o parâmetro `error` ao chamar o método [`SurveyCloseCompletionHandler.onFailure(error:)`](#survey-close-completion-handler-on-failure-error).

### Case `incorrectSurveyID`

Ocorre quando um ID de pesquisa incorreto foi passado ao tentar fechar uma pesquisa.

### Caso `noCurrentSurvey`

Ocorre ao tentar fechar uma pesquisa quando a pesquisa atual no servidor já foi fechada ou ainda não foi iniciada.

### Caso `surveyDisabled`

Ocorre quando se tenta fechar uma pesquisa quando a opção de pesquisa está desativada nesse servidor.

### Caso `unknown`

Erro desconhecido.

---

## Protocolo `GeolocationCompletionHandler` { #geolocation-completion-handler }

Um objeto que implementa esse protocolo pode ser passado para o parâmetro `completionHandler` do método [`sendGeolocation`](#sendgeolocation) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess()`

Chamado quando a chamada ao método [`sendGeolocation`](#sendgeolocation) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) é bem-sucedida.


### Método `onFailure(error:)` { #geolocation-completion-handler-on-failure }

Chamado quando a chamada ao método [`sendGeolocation`](#sendgeolocation) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream) falha.

O parâmetro `error` é o erro que impediu que o método fosse chamado com êxito. Tipo - [`GeolocationError`](#geolocation-error).

---

## Tipo enumerado `GeolocationError` { #geolocation-error }

Possíveis erros que podem ser passados para o parâmetro `error` ao chamar o método [`GeolocationCompletionHandler.onFailure(error:)`](#geolocation-completion-handler-on-failure).


### Case `invalidGeolocation`

Dados de geolocalização inválidos.


### Case `unknown`

Erro desconhecido.

---

## Protocolo `HelloMessageListener` { #hello-message-listener }

O protocolo é uma abstração que representa uma mensagem hello.

### Método de instância `helloMessage(message:)`

O método é chamado quando uma mensagem hello é recebida antes que as mensagens de chat sejam recebidas.

O parâmetro `message` é a mensagem de “hello”. O tipo é `String`.

---

## Tipo enumerado `ReactonString`

Tipos de reação disponíveis.

### Case `like`

Uma classificação `like`.

### Case `dislike`

Uma classificação `dislike`.

---

## Protocolo `ReactionCompletionHandler` { #reaction-completion-handler }

Um objeto de assunto de protocolo pode ser passado no parâmetro `completionHandler` do método [`react(message:reaction:completionHandler:)`](#message-stream-react) do protocolo `MessageStream`.

### Método de instância `onSuccess(messageID:)`

O método é chamado em uma solicitação bem-sucedida pelo método [`react(message:reaction:completionHandler:)`](#message-stream-react) do protocolo `MessageStream`.

O parâmetro `messageid` é a ID da mensagem. O tipo é `String`.

### Método de instância `onFailure(error:)` { #reaction-completion-handler-onfailure }

Chamado quando a solicitação do método [`react(message:reaction:completionHandler:)`](#message-stream-react) falha.

O parâmetro `error` é o erro que impediu que a chamada do método fosse bem-sucedida. O tipo é `ReactionError`.

---

## Tipo enumerado `ReactionError`

Possíveis erros que podem ser passados para o parâmetro de método [`onFailure(error:)`](#reaction-completion-handler-onfailure) do protocolo `ReactionCompletionHandler`.

### Case `notAllowed`

As reações estão desativadas no servidor.

### Case `messageNotOwned`

O usuário só pode deixar reações às mensagens do operador.

### Case `messageNotFound`

Mensagem não encontrada.

### Case `unknown`

Erro desconhecido.

---

## Tipo enumerado `DataMessageError` { #data-message-error }

Possíveis erros que podem ser passados para o parâmetro `error` do método [`onFailure(messageID:error:)`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#on-failure-message-id-error-data-message-completion-handler).

### Case `UNKNOWN`

O código de erro recebido não é suportado por esta versão do `RoxchatClientLibrary`.

### Case `QUOTED_MESSAGE_CANNOT_BE_REPLIED`

A mensagem citada não está marcada com o sinalizador `canBeReplied` ou o sinalizador não está definido como `true`.

### Case `QUOTED_MESSAGE_FROM_ANOTHER_VISITOR`

A ID da mensagem enviada corresponde a outro visitante.

### Case `QUOTED_MESSAGE_MULTIPLE_IDS`

O ID da mensagem enviada corresponde a várias mensagens (provavelmente há um erro no banco de dados).

### Caso `QUOTED_MESSAGE_REQUIRED_ARGUMENTS_MISSING`

Indica que um ou mais argumentos do sistema de cotação implementado pelo servidor não foram enviados.

### Caso `QUOTED_MESSAGE_WRONG_ID`

Foi enviado um ID inválido da mensagem citada.

---

## Protocolo `Survey` { #survey }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getConfig()`

Use esse método para obter a configuração da pesquisa.

Ele retorna um valor do tipo [`SurveyConfig`](#survey-config).

### Método de instância `getID()`

Use esse método para obter o `id` da pesquisa.

Ele retorna um valor do tipo `String`.

### Método de instância `getCurrentQuestionInfo()`

Use esse método para obter informações sobre a pergunta atual.

Ele retorna um valor do tipo [`SurveyCurrentQuestionInfo`](#survey-current-question-info).

---

## Protocolo `SurveyConfig` { #survey-config }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getID()`

Use esse método para obter o ID da configuração da pesquisa.

Ele retorna um valor do tipo `Int`.

### Método de instância `getDescriptor()`

Use esse método para obter o objeto descritor para essa pesquisa.

Ele retorna um valor do tipo [`SurveyDescriptor`](#survey-descriptor).

### Método de instância `getVersion()`

Use esse método para obter as informações de versão da configuração atual da pesquisa.

Ele retorna um valor do tipo `String`.

---

## Protocolo `SurveyCurrentQuestionInfo` { #survey-current-question-info }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getFormID()`

Use esse método para obter o ID do formulário da pergunta atual.

Ele retorna um valor do tipo `Int`.

### Método de instância `getQuestionID()`

Use esse método para obter o índice da pergunta atual na lista de perguntas a partir de 0, retornada pelo método `getQuestions()`.

Ele retorna um valor do tipo `Int`.

---

## Protocolo `SurveyDescriptor` { #survey-descriptor }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getForms()`

Use esse método para obter uma lista dos formulários da pesquisa atual.

Ele retorna um valor do tipo [`SurveyForm`](#survey-form).

---

## Protocolo `SurveyForm` { #survey-form }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getID()`

Use esse método para obter o ID do formulário.

Ele retorna um valor do tipo `Int`.

### Método de instância `getQuestions()`

Use esse método para obter a lista de perguntas desse formulário.

Retorna um valor do tipo [`SurveyQuestion`](#survey-question).

---

## Protocolo `SurveyQuestion` { #survey-question }

Contém métodos que podem ser usados para recuperar informações sobre uma pesquisa.

### Método de instância `getType()` { #survey-question-get-type }

Use esse método para obter o tipo da pergunta fornecida.

Ele retorna um valor do tipo [`SurveyType`](#survey-type).

### Método de instância `getText()`

Use esse método para obter o texto da pergunta.

Ele retorna um valor do tipo `String`.

### Método de instância `getOptions()`

Use esse método para obter as opções de resposta para a pergunta.

Ele retorna um valor opcional do tipo `[String]`.

---

## Tipo enumerado `SurveyType` { #survey-type }

Os tipos que podem ser obtidos como resultado da chamada do método [`getType()`](#survey-question-get-type) em um objeto do tipo [`SurveyQuestion`](#survey-question).

### Case `stars`

Uma pergunta na qual a resposta é uma pontuação.

### Case `radio`

Uma pergunta na qual a resposta é uma opção de uma lista de opções possíveis.

### Case `comment` (comentário)

Uma pergunta na qual a resposta é um comentário do usuário.

---

## Protocolo `UploadFileToServerCompletionHandler` { #upload-file-to-server-completion-handler }

Um objeto de protocolo pode ser passado no parâmetro `completionHandler` do método [`uploadFilesToServer(file:filename:mimeType:completionHandler:)`](#upload-files-to-server-file-filename-mime-type-completion-handler) protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

### Método de instância `onSuccess(id:uploadedFile:)`

O método é chamado quando um arquivo é carregado com êxito usando o método [`uploadFilesToServer(file:filename:mimeType:completionHandler:)`](#upload-files-to-server-file-filename-mime-type-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `messageid` é o ID da mensagem correspondente. O tipo é `String`.

Parâmetro `uploadedFile` - o arquivo carregado no servidor. O tipo é [`UploadedFile`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#uploaded-file).

### Método `onFailure(messageID:error:)`

Chamado quando um upload de arquivo falha usando o método [`uploadFilesToServer(file:filename:mimeType:completionHandler:)`](#upload-files-to-server-file-filename-mime-type-completion-handler) do protocolo [`MessageStream`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#message-stream).

O parâmetro `messageid` é o ID da mensagem correspondente. O tipo é `String`.

O parâmetro `error` - o erro que impediu o envio bem-sucedido do arquivo. Tipo - [`SendFileError`](https://rox.chat/kb/pt/mobile/sdk/ios-sdk-handbook.html#send-file-error).

---

## Protocolo `KeyboardButton`

### Método de instância `getParams()`

O método é usado para obter informações sobre o botão de teclado do chatbot.

Retorna um objeto [`Params`](#params) ou `nil` se nenhuma informação adicional estiver disponível.

---

## Protocol `Params` { #params }

Contém informações sobre o botão de teclado do chatbot.

### Método de instância `getAction()`

Um método que pode ser usado para obter a ação de um botão no teclado do chatbot.

Retorna a ação do botão. O tipo é uma `String` opcional.

### Método de instância `getType()`

Um método pelo qual o tipo do botão no teclado do chatbot pode ser obtido.

Retorna o tipo do botão. O tipo é opcional [`ParamsButtonType`](#params-button-type).

### Método de instância `getColor()`

Método que pode ser usado para obter a cor de um botão no teclado do chatbot.

Retorna a cor do botão. O tipo é uma `String` opcional.

---

## Tipo enumerado `ParamsButtonType` { #params-button-type }

Possíveis tipos de botões do teclado do chatbot retornados pelo método `Params.getType()`.

### Case `url`

O botão é um link.

### Case `action`

O botão é uma ação.
