NowAttachmentService-Schnittstelle – Android

Die NowAttachmentService Die 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: 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.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	SYS_ID des abzurufenden Anhangs. Dies ist die sys_ID für den Anhang auf Ihrem ServiceNow Instanz.
ValidierteAnhang	Boolean	Kennzeichnung, die angibt, ob der Anhang validiert werden soll. Gültige Werte: Wahr: Validieren Sie den Anhang. Falsch: Validieren Sie den Anhang nicht. Standardwert: wahr

Tabelle : 3. Rückgaben

Typ	Beschreibung
Rufen Sie An < Jetzt Anhang >	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: Zeichenfolge)

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. Rückgaben

Typ	Beschreibung
Rufen Sie An ​< NowAttachmentMetadata >	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, Grenzwert: 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 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 Metadaten der Anhangdatei, die zurückgegeben werden sollen. Standard: Null: Gibt alle Metadaten zurück, die den entsprechen filterParameterspezifikationen.

Tabelle : 7. Rückgaben

Typ	Beschreibung
Rufen Sie An < Liste ​< NowAttachmentMetadata >>	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, 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 das Ü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 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 Metadaten der Anhangdatei, die zurückgegeben werden sollen. Standard: Null: Gibt alle Metadaten zurück, die den entsprechen filterParameterspezifikationen.

Tabelle : 9. Rückgaben

Typ	Beschreibung
Paginator​< NowAttachmentMetadata >	Erfolg: Paginator-Objekt zusammen mit den angegebenen Seiten von 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: Zeichenfolge)

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. Rückgaben

Typ	Beschreibung
Rufen Sie An < ByteArray >	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(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.

Tabelle : 12. Parameter

Name	Typ	Beschreibung
Daten	ByteArray	Metadaten, die dem im Konfigurationsobjekt angegebenen Anhang hochgeladen und zugeordnet werden sollen.
konfigurieren	NowAttachmentUploadConfiguration	Konfigurationsparameter hochladen.

Tabelle : 13. Rückgaben

Typ	Beschreibung
NowAttachmentMetadata	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) } 
  )
}