Interface NowAttachmentService - Android
. NowAttachmentService a interface fornece funções que permitem a manipulação de anexos de arquivo e seus metadados associados.
| Nome | Tipo | Descrição |
|---|---|---|
| configuração | NowServiceConfiguration | Configuração a ser associada ao serviço. |
NowAttachmentService - anexo(SYSID: Cadeia de caracteres, validateAttachment: Boolian
Recupera o anexo com o sys_id especificado e, opcionalmente, valida o anexo comparando o hash calculado do anexo com o hash esperado.
| Nome | Tipo | Descrição |
|---|---|---|
| sysId | Cadeia de caracteres | Sys_id do anexo a ser recuperado. Este é o sys_id do anexo em seu ServiceNow instância. |
| ValidateAttachment | Booliano | Sinalizador que indica se o anexo deve ser validado. Valores válidos:
Padrão: verdadeiro |
| Tipo | Descrição |
|---|---|
| Chamada . NowAttachment > | Objeto NowAttachment que contém o anexo solicitado. |
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)
Recupera os metadados do anexo associado ao sys_id especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| sysId | Cadeia de caracteres | Sys_id do anexo cujos metadados você deseja recuperar. |
| Tipo | Descrição |
|---|---|
| Chamada . NowAttachmentMetadados > | Objeto que contém os metadados do anexo especificado. |
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)
Recupera os metadados de todos os anexos que atendem aos critérios especificados.
| Nome | Tipo | Descrição |
|---|---|---|
| filtros | Filtro | 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 limitparâmetro. |
| limite | Inteiro | Opcional. Número máximo de metadados do arquivo de anexo a serem retornados. Padrão: Nulo - Retorna todos os metadados que atendem a. filterespecificações de parâmetro. |
| Tipo | Descrição |
|---|---|
| Chamada . Lista . NowAttachmentMetadados >> | Lista de objetos que contêm os metadados dos anexos correspondentes. |
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)
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á uma página seguinte ou anterior.
| Nome | Tipo | Descrição |
|---|---|---|
| filtros | Filtro | 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 limitparâmetro. |
| limite | Inteiro | Opcional. Número máximo de metadados do arquivo de anexo a serem retornados. Padrão: Nulo - Retorna todos os metadados que atendem a. filterespecificações de parâmetro. |
| Tipo | Descrição |
|---|---|
| Paginador NowAttachmentMetadados > | Objeto do paginador junto com as páginas especificadas de metadados. Falha: Objeto NowDataError. |
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)
Exclui o anexo com o sys_id especificado.
| Nome | Tipo | Descrição |
|---|---|---|
| sysId | Cadeia de caracteres | Sys_id do anexo a ser excluído. |
| Tipo | Descrição |
|---|---|
| Chamada . ByteArray > | Êxito: Nada é retornado. NowDataError retornado. |
fun deleteAttachment(sysId: String) {
val call = attachmentService.delete(sysId)
call.enqueue(
{ response -> handleResponse(response) },
{ nowDataError -> handleError(nowDataError) }
)
}
NowAttachmentService - upload(dados: ByteArray, configuração: NowAttachmentUploadConfiguration)
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.
| Nome | Tipo | Descrição |
|---|---|---|
| dados | ByteArray | Metadados a serem carregados e associados ao anexo especificado no objeto de configuração. |
| configuração | NowAttachmentUploadConfiguration | Carregar parâmetros de configuração. |
| Tipo | Descrição |
|---|---|
| NowAttachmentMetadados | Metadados carregados. |
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) }
)
}