Interface de NowAttachmentService : Android

L’interface NowAttachmentService fournit des fonctions qui permettent de manipuler les pièces jointes et les métadonnées associées.

Tableau 1. Propriétés

Nom	Type	Description
configuration	NowServiceConfiguration	Configuration à associer au service.

NowAttachmentService : attachment(sysId : chaîne, validateAttachment : booléen = vrai)

Récupère la pièce jointe avec le sys_id spécifié et valide éventuellement la pièce jointe en comparant le hachage calculé de la pièce jointe au hachage attendu.

Tableau 2. Paramètres

Nom	Type	Description
sysId	Chaîne	Sys_id de la pièce jointe à récupérer. Il s’agit de la sys_id de la pièce jointe sur votre ServiceNow instance.
validateAttachment	Booléen	Marqueur indiquant s’il faut valider la pièce jointe. Valeurs valides : vrai : valider la pièce jointe. faux : ne valide pas la pièce jointe. Par défaut : true

Tableau 3. Renvoie

Type	Description
Appel<NowAttachment>	Objet NowAttachment contenant la pièce jointe demandée.

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 : chaîne)

Récupère les métadonnées de la pièce jointe associée au sys_id spécifié.

Tableau 4. Paramètres

Nom	Type	Description
sysId	Chaîne	Sys_id de la pièce jointe dont vous souhaitez récupérer les métadonnées.

Tableau 5. Renvoie

Type	Description
Call<NowAttachmentMetadata>	Objet contenant les métadonnées pour la pièce jointe spécifiée.

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)

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés.

Tableau 6. Paramètres

Nom	Type	Description
filtre	Filtrer	Facultatif. Chaîne de requête à utiliser pour filtrer les pièces jointes dont les métadonnées doivent renvoyer. Par défaut : null : renvoie les métadonnées pour toutes les pièces jointes disponibles. Prend en compte le limit paramètre.
limite	Entier	Facultatif. Nombre maximal de métadonnées de fichier de pièce jointe à renvoyer. Par défaut : null : renvoie toutes les métadonnées qui répondent aux spécifications des filter paramètres.

Tableau 7. Renvoie

Type	Description
Call<List<NowAttachmentMetadata>>	Liste des objets contenant les métadonnées pour les pièces jointes correspondantes.

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)

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés et crée un paginateur pour itérer entre les pages des métadonnées renvoyées.

Vous pouvez utiliser ce paginateur pour parcourir les métadonnées renvoyées, effectuer des opérations de navigation telles que l’extraction de la première, de la dernière, de la page précédente ou de la page suivante, ou vérifier s’il existe une page suivante ou précédente.

Tableau 8. Paramètres

Nom	Type	Description
filtre	Filtrer	Facultatif. Chaîne de requête à utiliser pour filtrer les pièces jointes dont les métadonnées doivent renvoyer. Par défaut : null : renvoie les métadonnées pour toutes les pièces jointes disponibles. Prend en compte le limit paramètre.
limite	Entier	Facultatif. Nombre maximal de métadonnées de fichier de pièce jointe à renvoyer. Par défaut : null : renvoie toutes les métadonnées qui répondent aux spécifications des filter paramètres.

Tableau 9. Renvoie

Type	Description
Paginateur<NowAttachmentMetadata>	Réussite : objet paginateur avec les pages spécifiées de métadonnées. Échec : objet NowDataError.

L’exemple de code suivant montre comment appeler cette fonction.

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 : chaîne)

Supprime la pièce jointe avec le sys_id spécifié.

Tableau 10. Paramètres

Nom	Type	Description
sysId	Chaîne	Sys_id de la pièce jointe à supprimer.

Tableau 11. Renvoie

Type	Description
Appel<ByteArray>	Réussite : rien n’est renvoyé. Échec : NowDataError renvoyé.

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

NowAttachmentService : upload(données : ByteArray, configuration : NowAttachmentUploadConfiguration)

Récupère les métadonnées de toutes les pièces jointes qui répondent aux critères spécifiés et crée un paginateur pour itérer entre les pages des métadonnées renvoyées.

Tableau 12. Paramètres

Nom	Type	Description
données	Tableau d’octets	Métadonnées à charger et à associer à la pièce jointe spécifiée dans l’objet de configuration.
configuration	NowAttachmentUploadConfiguration	Télécharger les paramètres de configuration.

Tableau 13. Renvoie

Type	Description
Métadonnées NowAttachment	Métadonnées chargées.

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