Now AttachmentService-Schnittstelle – Android
Die Jetzt AttachmentService Die Schnittstelle bietet Funktionen, die die Bearbeitung von Dateianhängen und den zugehörigen Metadaten ermöglichen.
| Name | Typ | Beschreibung |
|---|---|---|
| konfigurieren | Jetzt Servicekonfiguration | Konfiguration, die dem Service zugeordnet werden soll. |
Now AttachmentService – attachment(sysId: Zeichenfolge, validateAttachment: Boolescher Wert = wahr)
Ruft den Anhang mit der angegebenen sys_ID ab und validiert optional den Anhang, indem der berechnete Hash des Anhangs mit dem erwarteten Hash verglichen wird.
| Name | Typ | Beschreibung |
|---|---|---|
| Sys-ID | Zeichenfolge | SYS_ID des abzurufenden Anhangs. Dies ist die sys_ID für den Anhang auf Ihrem ServiceNowInstanz. |
| ValidierteAnhang | Boolean | Kennzeichnung, die angibt, ob der Anhang validiert werden soll. Gültige Werte:
Standard: Wahr |
| Typ | Beschreibung |
|---|---|
| Rufen Sie An < Jetzt Anhang > | Now Attachment-Objekt, das den angeforderten Anhang enthält. |
fun getAttachment(sysId: String, isValidateAttachment: Boolean) {
val call = attachmentService.attachment(sysId, isValidateAttachment)
call.enqueue(
{ response ->
val attachment: NowAttachment? = response.body
},
{ nowDataError -> handleError(nowDataError) }
)
}
Now AttachmentService – attachmentMetadata(sysId: Zeichenfolge)
Ruft die Metadaten für den Anhang ab, der der angegebenen sys_ID zugeordnet ist
| Name | Typ | Beschreibung |
|---|---|---|
| Sys-ID | Zeichenfolge | SYS_ID des Anhangs, dessen Metadaten Sie abrufen möchten. |
| Typ | Beschreibung |
|---|---|
| Rufen Sie An < Now AttachmentMetadaten > | Objekt, das die Metadaten für den angegebenen Anhang enthält. |
fun fetchMetadata(sysId: String) {
val call = attachmentService.attachmentMetadata(sysId)
call.enqueue(
{ response ->
val metadata: NowAttachmentMetadata? = response.body
},
{ nowDataError -> handleError(nowDataError) }
)
}
Now AttachmentService – attachmentMetadata(Filter: Filter? = Null, Grenzwert: INT? = Null)
Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen.
| Name | Typ | Beschreibung |
|---|---|---|
| Filter | Filter | Optional. Abfragezeichenfolge, die zum Filtern der Anhänge verwendet werden soll, deren Metadaten zurückgegeben werden sollen. Standard: Null – gibt Metadaten für alle verfügbaren Anhänge zurück. Berücksichtigt limitParameter. |
| limit | Ganzzahl | Optional. Maximale Anzahl der zurückzugebenden Metadaten der Anhangsdatei. Standard: Null – gibt alle Metadaten zurück, die den entsprechen filterParameterspezifikationen. |
| Typ | Beschreibung |
|---|---|
| Rufen Sie An < Liste < Now AttachmentMetadaten >> | Liste von Objekten, die die Metadaten für die übereinstimmenden Anhänge enthalten. |
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) }
)
}
Now AttachmentService – attachmentMetadataPaginator(Filter: Filter? = Null, Grenzwert: INT? = Null)
Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen, und erstellt einen Paginator für die Iteration durch die Seiten der zurückgegebenen Metadaten.
Sie können diesen Paginator verwenden, um durch die zurückgegebenen Metadaten zu navigieren und Navigationsvorgänge auszuführen, z. B. das Abrufen der ersten, letzten, vorherigen oder nächsten Seite, oder überprüfen, ob eine nächste oder vorherige Seite vorhanden ist.
| Name | Typ | Beschreibung |
|---|---|---|
| Filter | Filter | Optional. Abfragezeichenfolge, die zum Filtern der Anhänge verwendet werden soll, deren Metadaten zurückgegeben werden sollen. Standard: Null – gibt Metadaten für alle verfügbaren Anhänge zurück. Berücksichtigt limitParameter. |
| limit | Ganzzahl | Optional. Maximale Anzahl der zurückzugebenden Metadaten der Anhangsdatei. Standard: Null – gibt alle Metadaten zurück, die den entsprechen filterParameterspezifikationen. |
| Typ | Beschreibung |
|---|---|
| Paginierer< Now AttachmentMetadaten > | Erfolg: Paginierobjekt zusammen mit den angegebenen Seiten von Metadaten. Fehler: Now DataError-Objekt. |
Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.
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")
}
Now AttachmentService – delete(sysId: Zeichenfolge)
Löscht den Anhang mit der angegebenen sys_ID
| Name | Typ | Beschreibung |
|---|---|---|
| Sys-ID | Zeichenfolge | SYS_ID des zu löschenden Anhangs. |
| Typ | Beschreibung |
|---|---|
| Rufen Sie An < ByteArray > | Erfolg: Es wird nichts zurückgegeben. Fehler: Now DataError zurückgegeben. |
fun deleteAttachment(sysId: String) {
val call = attachmentService.delete(sysId)
call.enqueue(
{ response -> handleResponse(response) },
{ nowDataError -> handleError(nowDataError) }
)
}
NowAttachmentService – Upload(Daten: ByteArray, Konfiguration: NowAttachmentUploadConfiguration)
Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen, und erstellt einen Paginator für die Iteration durch Seiten der zurückgegebenen Metadaten.
| Name | Typ | Beschreibung |
|---|---|---|
| Daten | ByteArray | Metadaten, die hochgeladen und dem im Konfigurationsobjekt angegebenen Anhang zugeordnet werden sollen. |
| konfigurieren | Now AttachmentUploadConfiguration | Konfigurationsparameter hochladen. |
| Typ | Beschreibung |
|---|---|
| Now AttachmentMetadaten | Metadaten wurden hochgeladen. |
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) }
)
}