Récupérer les pièces jointes et les métadonnées de pièce jointe

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • L’API NowAttachmentService vous permet d’effectuer des opérations CRUD sur les pièces jointes et de récupérer les métadonnées de pièce jointe à partir de votre ServiceNow instance.

    À l’aide de cette API, vous pouvez :
    • Chargez les pièces jointes sur votre ServiceNow instance et associez-les à un enregistrement spécifique.
    • Téléchargez une ou plusieurs pièces jointes.
    • Supprimez les pièces jointes.
    • Validez une pièce jointe en comparant le hachage calculé de la pièce jointe au hachage attendu.
    • Télécharger les métadonnées de la pièce jointe. Ces métadonnées sont générées par votre ServiceNow instance lorsqu’une pièce jointe est chargée.

    Pour plus d’informations sur l’utilisation des pièces jointes, consultez API de pièce jointe.

    Toutes les méthodes NowAttachmentService fournissent trois implémentations pour renvoyer les données de résultats. L’une qui appelle un gestionnaire de complétion avec les résultats de retour, l’autre qui préforme un async/await et une autre qui renvoie un éditeur Combine (déconseillé). Par exemple, chaque méthode upload() télécharge et associe une pièce jointe spécifiée à un enregistrement spécifié. Toutefois, la NowAttachmentService : upload(données : données, configuration : NowAttachmentUploadConfiguration, progressUpdate : @escaping ProgressUpdate, achèvement : @escaping (Result<NowAttachmentMetadata, NowDataError>)) méthode appelle un gestionnaire de complétion avec les résultats renvoyés, la NowAttachmentService : upload(data : Data, configuration : NowAttachmentUploadConfiguration, progressUpdate : @escaping ProgressUpdate) Levées asynchrones méthode effectue un async/await et la NowAttachmentService : upload(données : données, configuration : NowAttachmentUploadConfiguration, progressUpdate : @escaping ProgressUpdate) méthode renvoie un éditeur Combine.

    Avant de pouvoir utiliser l’API NowAttachmentService , vous devez importer NowData , puis initialiser un objet NowAttachmentService.
    // Import the NowData framework
    import NowData
    
    func makeAttachmentService(instanceUrl: URL, 
      completion: @escaping ((Result<NowAttachmentService, NowServiceErrors>) → Void))

    Pagination des métadonnées des pièces jointes

    Vous pouvez utiliser les méthodes NowAttachmentService pour télécharger les métadonnées de pièce jointe d’une ou de plusieurs pièces jointes. Lors du téléchargement de métadonnées à partir de plusieurs pièces jointes, vous pouvez utiliser la NowAttachmentService : attachmentMetadataPaginator(filter : Filter, limit : Int) méthode, qui renvoie un objet Paginator qui vous permet d’itérer facilement sur la quantité potentiellement importante de données renvoyées. Vous utilisez généralement des résultats de retour paginés pour fournir des options de défilement infini pour les données présentées à l’intérieur d’un UITableView, d’un UICollectionView (UIKit) ou d’une liste (SwiftUI), ou pour simplifier l’itération de page des résultats en général.

    Après avoir obtenu un objet Paginator, abonnez-vous à son éditeur pour commencer à recevoir des données.
    paginator.publisher
      .subscribe(on: DispatchQueue.global())
      .receive(on: DispatchQueue.main)
      .sink { ... }
      .store(in: &subscriptions)
    L’objet Paginator renvoyé fournit les méthodes suivantes qui vous permettent de parcourir les enregistrements renvoyés :
    • premier()
    • last()
    • next()
    • previous()
    • reset()
    Remarque :
    Certaines méthodes Paginator peuvent lever une exception, par exemple lorsqu’il n’y a plus de pages à extraire.

    En outre, l’objet Paginator fournit des propriétés qui vous permettent d’obtenir des informations sur les données paginées. Pour plus d’informations sur ces propriétés et les méthodes disponibles, reportez-vous à la section API du paginateur : iOS.