NowAttachmentService-Schnittstelle – Android

Die NowAttachmentService- Schnittstelle bietet Funktionen, die die Bearbeitung von Dateianhängen und den zugehörigen Metadaten ermöglichen.

Tabelle : 1. Eigenschaften

Name	Typ	Beschreibung
konfigurieren	NowServiceConfiguration	Konfiguration, die dem Service zugeordnet werden soll.

NowAttachmentService – attachment(sysId: String,validateAttachment: Boolean = true)

Ruft den Anhang mit der angegebenen sys_id ab und validiert den Anhang optional, indem der berechnete Hash des Anhangs mit dem erwarteten Hash verglichen wird.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id des abzurufenden Anhangs. Dies ist die sys_id für den Anhang in Ihrer Instanz ServiceNow.
validAttachment	Boolean	Kennzeichnung, die angibt, ob der Anhang validiert werden soll. Gültige Werte: true: Validiert den Anhang. false: Validiert den Anhang nicht. Standardwert: true

Tabelle : 3. Ergebnisse

Typ	Beschreibung
Rufen Sie<NowAttachment> auf	NowAttachment-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) } 
  ) 
}

NowAttachmentService – attachmentMetadata(sysId: String)

Ruft die Metadaten für den Anhang ab, der der angegebenen sys_id zugeordnet ist.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id des Anhangs, dessen Metadaten Sie abrufen möchten.

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Rufen Sie​<NowAttachmentMetadata> auf	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) } 
  )
}

NowAttachmentService – attachmentMetadata(filter: Filter? = null, limit: Int? = null)

Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
filter	Filter	Optional. Abfragezeichenfolge, die zum Filtern der Anhänge verwendet wird, deren Metadaten zurückgegeben werden sollen. Standard: null – Gibt Metadaten für alle verfügbaren Anhänge zurück. Berücksichtigt den Parameter limit.
limit	Ganzzahl	Optional. Maximale Anzahl der zurückzugebenden Metadaten der Anhangdatei. Standard: null – Gibt alle Metadaten zurück, die die Parameterspezifikationen filter erfüllen.

Tabelle : 7. Ergebnisse

Typ	Beschreibung
Rufen Sie<Liste​<NowAttachmentMetadata>> auf	Liste der Objekte, 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) } 
  )
}

NowAttachmentService – attachmentMetadataPaginator(filter: Filter? = null, limit: Int? = null)

Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen, und erstellt einen Paginator zum Durchgehen der Seiten der zurückgegebenen Metadaten.

Sie können diesen Paginator verwenden, um durch die zurückgegebenen Metadaten zu navigieren und Navigationsvorgänge wie das Abrufen der ersten, letzten, vorherigen oder nächsten Seite auszuführen oder zu überprüfen, ob die nächste oder vorherige Seite vorhanden ist.

Tabelle : 8. Parameter

Name	Typ	Beschreibung
filter	Filter	Optional. Abfragezeichenfolge, die zum Filtern der Anhänge verwendet wird, deren Metadaten zurückgegeben werden sollen. Standard: null – Gibt Metadaten für alle verfügbaren Anhänge zurück. Berücksichtigt den Parameter limit.
limit	Ganzzahl	Optional. Maximale Anzahl der zurückzugebenden Metadaten der Anhangdatei. Standard: null – Gibt alle Metadaten zurück, die die Parameterspezifikationen filter erfüllen.

Tabelle : 9. Ergebnisse

Typ	Beschreibung
Paginator​<NowAttachmentMetadata>	Erfolg: Paginator-Objekt zusammen mit den angegebenen Seiten mit Metadaten. Fehler: NowDataError-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")
}

NowAttachmentService – delete(sysId: String)

Löscht den Anhang mit der angegebenen sys_id.

Tabelle : 10. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id des zu löschenden Anhangs.

Tabelle : 11. Ergebnisse

Typ	Beschreibung
Rufen Sie<ByteArray> auf	Erfolg: Es wird nichts zurückgegeben. Fehler: NowDataError zurückgegeben.

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

NowAttachmentService – Upload(data: ByteArray, Konfiguration: NowAttachmentUploadConfiguration)

Ruft die Metadaten für alle Anhänge ab, die die angegebenen Kriterien erfüllen, und erstellt einen Paginator zum Durchlaufen der Seiten der zurückgegebenen Metadaten.

Tabelle : 12. Parameter

Name	Typ	Beschreibung
Daten	Byte-Array	Metadaten, die hochgeladen und dem im Konfigurationsobjekt angegebenen Anhang zugeordnet werden sollen.
konfigurieren	NowAttachmentUploadConfiguration	Laden Sie Konfigurationsparameter hoch.

Tabelle : 13. Ergebnisse

Typ	Beschreibung
NowAttachmentMetadata	Hochgeladene Metadaten.

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) } 
  )
}