NowAttachmentMetadata 構造:iOS

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分
  • 構造体には、添付ファイル メタデータのエンコードと管理を可能にする関数が用意されています。

    表 : 1. プロパティ
    名前 タイプ 説明
    averageImageColor 文字列 関連付けられた画像で最も支配的な色。
    chunkSize(バイト単位) 整数 チャンクのサイズ。

    単位:バイト

    圧縮サイズ (バイト単位) 整数 添付ファイルの圧縮サイズ。

    単位:バイト

    作成日時 日付 添付ファイルが作成された日付。
    createdBy 文字列 添付ファイルを作成したエンティティ。
    ダウンロード URL インスタンス上の ServiceNow 添付ファイルの URL。
    fileName 文字列 添付ファイルの名前。
    ハッシュ 文字列 添付ファイルに想定される SHA256 ダイジェスト。

    ダウンロードされた添付ファイルは、その計算されたダイジェストをこの SHA256 ダイジェストと比較することによって 検証 されます。

    画像高さ 整数 画像の高さ。

    単位:ピクセル

    画像幅 整数 画像の幅。

    単位:ピクセル

    isCompressed ブール 添付ファイルが圧縮されているかどうかを示すフラグ。
    可能な値:
    • true:添付ファイルは圧縮されています。
    • false:添付ファイルは圧縮されていません。
    mimeType 文字列 添付ファイルの MIME タイプ。
    modificationCount 整数 添付ファイルが変更された回数。
    sizeInBytes 整数 添付ファイルのサイズ。

    単位:バイト

    sourceSysId 文字列 添付ファイルの sys_id。
    sourceTableName 文字列 添付ファイルが存在するソーステーブルの名前。
    state 条件付き、利用不可、利用可能、処理待ちなどの可用性ステータス。
    sysId 文字列 インスタンス内の各レコードを識別する一意の 32 文字の ServiceNow グローバル一意識別子 (GUID)。
    タグ 文字列 添付ファイルに関連付けられたタグのリスト。
    updated 日付 添付ファイルが最後に変更された日付。
    updatedBy 文字列 添付ファイルを更新したエンティティ。

    NowAttachmentMetadata - encode(to エンコーダー: エンコーダー)

    指定したエンコーダーを使用して、現在のオブジェクト値をデータにエンコードします。

    オブジェクトのデータへのエンコードに失敗した場合、エンコーダーはその場所に空の キー付きコンテナー をエンコードします。この関数は、指定されたエンコーダーの形式で無効な値がある場合にもエラーをスローします。

    表 : 2. パラメーター
    名前 タイプ 説明
    エンコーダーへ Encoder エンコードされた出力の構造を定義するエンコーダー。
    表 : 3. 返される内容
    タイプ 説明
    なし

    次のコード例は、この関数を呼び出す方法を示しています。

    let query = "active=true^short_descriptionLIKEbroken"
    let filter = Filter(query: query)
    metadataPublisher(filter: filter, limit: 1)
    private func metadataPublisher(filter: Filter?, limit: Int?) {
      let publisher = attachmentService.attachmentMetadata(filter: filter, limit: limit)
      publisher
      .receive(on: DispatchQueue.main)
      .encode(encoder: JSONEncoder())
      .sink { [weak self] completion in
        if case let .failure(error) = completion {
          // attachment published failed, return NowDataError
        }
      } receiveValue: { [weak self] (data) in
        // Attachment published successful, return data
      }
      .store(in: &subscriptions)
    }

    NowAttachmentMetadata - init(from decoder: Decoder)

    指定されたデコーダーからオブジェクトにデータをデコードすることによって、新しい NowAttachmentMetadata インスタンスを作成します。

    このメソッドは、デコーダーからの読み取りが失敗した場合、または読み取られたデータが破損しているか無効である場合にエラーをスローします。

    表 : 4. パラメーター
    名前 タイプ 説明
    デコーダー デコーダー データを読み取るデコーダー。
    表 : 5. 返される内容
    タイプ 説明
    なし

    次のコード例は、この関数を呼び出す方法を示しています。

    guard 
      let metadataHeader = response.httpResponse?.value(forHTTPHeaderField: NowAttachment.attachmentMetadataHeaderKey),
      let metadataHeaderData = metadataHeader.data(using: .utf8) else {
        throw NowDataError.missingAttachmentMetadata
      }
                
    let metadata = try coder.decode(NowAttachmentMetadata.self, from: metadataHeaderData)
    let attachment = NowAttachment(metadata: metadata, data: response.data)