---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Interface NowAttachmentService - Android

# Interface NowAttachmentService - Android {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

A interface NowAttachmentService fornece funções que permitem a manipulação de anexos de arquivo e seus metadados associados.
{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| configuração | [NowServiceConfiguration](https://servicenow-prod.fluidtopics.net/jf~9lIjtHwW3MVfVkwHV9w "A classe NowServiceConfiguration permite configurar o URL da instância ServiceNow e o nome do pacote para um serviço do recurso.") | Configuração a ser associada ao serviço. |
[Tabela 1. Propriedades]

{#NowAttachServiceAndroidInterface__table_vx2_klw_5pb}

## NowAttachmentService - attachment(sysId: cadeia de caracteres, validAttachment: booliano = verdadeiro) {#ariaid-title2}

Recupera o anexo com o sys_id especificado e, opcionalmente, valida o anexo comparando o hash calculado do anexo com o hash esperado.
{#NAttServ-attachment_S_B__table_old_sp5_4pb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sysId | Cadeia de caracteres | Sys_id do anexo a ser recuperado. Este é o sys_id do anexo em sua instância ServiceNow. |
| validarAnexo | Booliano | Sinalizador que indica se o anexo deve ser validado. Valores válidos: * verdadeiro: validar o anexo. * falso: não valida o anexo. {#NAttServ-attachment_S_B__ul_ftq_1q5_4pb} Padrão: verdadeiro |
[Tabela 2. Parâmetros]

{#NAttServ-attachment_S_B__table_old_sp5_4pb} {#NAttServ-attachment_S_B__table_pld_sp5_4pb__entry__2}

| Tipo | Descrição |
|-|-|
| [Chamar](https://servicenow-prod.fluidtopics.net/3pSuthm1bUG8QcZWbXf62g#CallAndroidInterface "A interface Chamada representa uma solicitação que está preparada para processamento.")\<[NowAttachment](https://servicenow-prod.fluidtopics.net/SpGzHMKP~RSGM9aEy3xoLA#NowAttachmentAndroidAPI "A classe NowAttachment fornece um objeto que contém um anexo e seus metadados associados.")\> | Objeto NowAttachment que contém o anexo solicitado. |
[Tabela 3. Retorna]

{#NAttServ-attachment_S_B__table_pld_sp5_4pb}  
<br />

    fun getAttachment(sysId: String, isValidateAttachment: Boolean) { 
      val call = attachmentService.attachment(sysId, isValidateAttachment) 
      call.enqueue( 
        { response -> 
          val attachment: NowAttachment? = response.body 
        }, 
          { nowDataError -> handleError(nowDataError) } 
      ) 
    }

## NowAttachmentService - attachmentMetadata(sysId: cadeia de caracteres) {#ariaid-title3}

Recupera os metadados do anexo associado ao sys_id especificado.
{#NAttServ-attachmentMetadata_S__table_bqq_1r5_4pb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sysId | Cadeia de caracteres | Sys_id do anexo cujos metadados você deseja recuperar. |
[Tabela 4. Parâmetros]

{#NAttServ-attachmentMetadata_S__table_bqq_1r5_4pb} {#NAttServ-attachmentMetadata_S__table_cqq_1r5_4pb__entry__2}

| Tipo | Descrição |
|-|-|
| [Chamar](https://servicenow-prod.fluidtopics.net/3pSuthm1bUG8QcZWbXf62g#CallAndroidInterface "A interface Chamada representa uma solicitação que está preparada para processamento.")​\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/AFzt3EKTxbkv52pknvWvUg#NowAttachmentMetadataAndroidAPI "A classe NowAttachmentMetadata fornece funções que permitem codificar e gerenciar metadados de anexo.")\> | Objeto que contém os metadados do anexo especificado. |
[Tabela 5. Retorna]

{#NAttServ-attachmentMetadata_S__table_cqq_1r5_4pb}  

    fun fetchMetadata(sysId: String) { 
      val call = attachmentService.attachmentMetadata(sysId) 
      call.enqueue(
        { response -> 
          val metadata: NowAttachmentMetadata? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }

## NowAttachmentService - attachmentMetadata(filtro: filtro? = nulo, limite: int? = nulo) {#ariaid-title4}

Recupera os metadados de todos os anexos que atendem aos critérios especificados.
{#NAttServ-attachmentMetadata_S_I___table_ujt_zc1_ppb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| filtros | [Filtro](https://servicenow-prod.fluidtopics.net/pRpIXjU72aWwWUxtqkO5aw#FilterAndroidAPI "A classe Filtro fornece a capacidade de configurar filtros que definem os dados a serem retornados nos resultados de retorno de uma consulta de endpoint REST.") | Opcional. Cadeia de caracteres de consulta a ser usada para filtrar os anexos cujos metadados serão retornados. Padrão: nulo - Retorna metadados para todos os anexos disponíveis. Leva em consideração o parâmetro limit. |
| limite | Inteiro | Opcional. Número máximo de metadados de arquivo de anexo a serem retornados. Padrão: nulo - Retorna todos os metadados que atendem às especificações de parâmetro filter. |
[Tabela 6. Parâmetros]

{#NAttServ-attachmentMetadata_S_I___table_ujt_zc1_ppb} {#NAttServ-attachmentMetadata_S_I___table_vjt_zc1_ppb__entry__2}

| Tipo | Descrição |
|-|-|
| [Chamar](https://servicenow-prod.fluidtopics.net/3pSuthm1bUG8QcZWbXf62g#CallAndroidInterface "A interface Chamada representa uma solicitação que está preparada para processamento.")\<[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/)​\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/AFzt3EKTxbkv52pknvWvUg#NowAttachmentMetadataAndroidAPI "A classe NowAttachmentMetadata fornece funções que permitem codificar e gerenciar metadados de anexo.")\>\> | Lista de objetos que contêm os metadados dos anexos correspondentes. |
[Tabela 7. Retorna]

{#NAttServ-attachmentMetadata_S_I___table_vjt_zc1_ppb}  

    fun fetchMultipleMetadata(filterQuery: String, limit: Int) { 
      val call = attachmentService.attachmentMetadata(Filter(filterQuery), limit) 
      call.enqueue( 
        { response -> 
          val metadataList: List<NowAttachmentMetadata>? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }

## NowAttachmentService - attachmentMetadataPaginator (filtro: filtro? = nulo, limite: int? = nulo) {#ariaid-title5}

Recupera os metadados de todos os anexos que atendem aos critérios especificados e cria um paginador para iterar nas páginas dos metadados retornados.
Você pode usar este paginador para navegar pelos metadados retornados, executando operações de navegação, como buscar a primeira, última, anterior ou próxima página, ou verificar se há a próxima página ou a anterior.
{#NAttServ-attachMetadataPaginat_S_I__table_npz_zf1_ppb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| filtros | [Filtro](https://servicenow-prod.fluidtopics.net/pRpIXjU72aWwWUxtqkO5aw#FilterAndroidAPI "A classe Filtro fornece a capacidade de configurar filtros que definem os dados a serem retornados nos resultados de retorno de uma consulta de endpoint REST.") | Opcional. Cadeia de caracteres de consulta a ser usada para filtrar os anexos cujos metadados serão retornados. Padrão: nulo - Retorna metadados para todos os anexos disponíveis. Leva em consideração o parâmetro limit. |
| limite | Inteiro | Opcional. Número máximo de metadados de arquivo de anexo a serem retornados. Padrão: nulo - Retorna todos os metadados que atendem às especificações de parâmetro filter. |
[Tabela 8. Parâmetros]

{#NAttServ-attachMetadataPaginat_S_I__table_npz_zf1_ppb} {#NAttServ-attachMetadataPaginat_S_I__table_opz_zf1_ppb__entry__2}

| Tipo | Descrição |
|-|-|
| Paginador​\<[NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/AFzt3EKTxbkv52pknvWvUg#NowAttachmentMetadataAndroidAPI "A classe NowAttachmentMetadata fornece funções que permitem codificar e gerenciar metadados de anexo.")\> | Sucesso: objeto do paginador junto com as páginas de metadados especificadas. Falha: objeto NowDataError. |
[Tabela 9. Retorna]

{#NAttServ-attachMetadataPaginat_S_I__table_opz_zf1_ppb}  
O exemplo de código a seguir mostra como chamar esta função.

    suspend fun createAttachmentMetadataPaginator() {
      val filterQuery: String = "content_type=text/plain"
      val filter = filterQuery.let(::Filter)
      val limit = 10
      val paginator = nowServiceManager.getNowAttachmentService()?.attachmentMetadataPaginator(filter, limit)
        ?.observe(object : PaginatorCallBack<NowAttachmentMetadata> {
          override fun onFailure(e: NowDataError) {
            handleError(e)
          }

          override fun onSuccess(response: Response<List<NowAttachmentMetadata>>) {
            handleResponse(response)
          }

        })
        ?: throw Exception("Response is null")
    }

## NowAttachmentService - delete(sysId: cadeia de caracteres) {#ariaid-title6}

Exclui o anexo com o sys_id especificado.
{#NAttServ-delete_S__table_dq4_dj1_ppb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sysId | Cadeia de caracteres | Sys_id do anexo a ser excluído. |
[Tabela 10. Parâmetros]

{#NAttServ-delete_S__table_dq4_dj1_ppb} {#NAttServ-delete_S__table_eq4_dj1_ppb__entry__2}

| Tipo | Descrição |
|-|-|
| [Chamar](https://servicenow-prod.fluidtopics.net/3pSuthm1bUG8QcZWbXf62g#CallAndroidInterface "A interface Chamada representa uma solicitação que está preparada para processamento.")\<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/)\> | Sucesso: nada é retornado. Falha: NowDataError retornado. |
[Tabela 11. Retorna]

{#NAttServ-delete_S__table_eq4_dj1_ppb}  
<br />

    fun deleteAttachment(sysId: String) { 
      val call = attachmentService.delete(sysId) 
      call.enqueue( 
        { response -> handleResponse(response) }, 
        { nowDataError -> handleError(nowDataError) } 
      )
    } 

## NowAttachmentService - upload (dados: ByteArray, configuração: NowAttachmentUploadConfiguration) {#ariaid-title7}

Recupera os metadados de todos os anexos que atendem aos critérios especificados e cria um paginador para iterar nas páginas dos metadados retornados.
{#NAttServ-upload_A_O__table_fkj_3k1_ppb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| dados | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/) | Metadados para carregar e associar ao anexo especificado no objeto de configuração. |
| configuração | NowAttachmentUploadConfiguration | Carregar parâmetros de configuração. |
[Tabela 12. Parâmetros]

{#NAttServ-upload_A_O__table_fkj_3k1_ppb} {#NAttServ-upload_A_O__table_gkj_3k1_ppb__entry__2}

| Tipo | Descrição |
|-|-|
| [NowAttachmentMetadata](https://servicenow-prod.fluidtopics.net/AFzt3EKTxbkv52pknvWvUg#NowAttachmentMetadataAndroidAPI "A classe NowAttachmentMetadata fornece funções que permitem codificar e gerenciar metadados de anexo.") | Metadados carregados. |
[Tabela 13. Retorna]

{#NAttServ-upload_A_O__table_gkj_3k1_ppb}  

    fun uploadAttachment(tableName: String, recordSysId: String, fileName: String) { 
      val bitmap = BitmapFactory.decodeResource(resources, R.drawable.test_image) 
      val data = bitmap.compress(ImageType.JPEG) 
      val contentType = "image/jpg" 
      val config = NowAttachmentUploadConfiguration(tableName, recordSysId, fileName, contentType) 
      val call = attachmentService.upload(data, config) 
     
      call.enqueue( 
        { response -> 
          val uploadedAttachmentMetadata: NowAttachmentMetadata? = response.body 
        },
        { nowDataError -> handleError(nowDataError) } 
      )
    }