---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# cabrillo.attachments - クライアント

# cabrillo.attachments - クライアント {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：7分

Cabrillo JS の添付機能の名前空間です。これにより、添付ファイルの追加と表示が可能になります。

## cabrillo.attachments addFile(文字列 tableName, 文字列 sysId, オブジェクト params, 文字列 options) {#ariaid-title2}

ドキュメント ピッカーを表示し、選択したファイルをアップロードします。
重要:  
このメソッドは廃止されました。代わりに [addFiles()](https://servicenow-prod.fluidtopics.net/LwkLwEhXobfZSeylGBjDAQ#CA-addFiles_S_S_O_S "ファイルを選択してアップロードするためのドキュメントピッカーを表示します。") メソッドを使用してください。
{#CA-addFile_S_S_O_S__table_yt5_3qw_2bb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| tableName | 文字列 | 添付ファイルを添付するレコードのテーブル名 |
| sysID | 文字列 | 添付ファイルを添付するレコードの sys_id |
| params | オブジェクト | 未使用null に設定します。 |
| オプション | 文字列 | 未使用null に設定します。 |
[表 : 1. パラメーター]

{#CA-addFile_S_S_O_S__table_yt5_3qw_2bb} {#CA-addFile_S_S_O_S__table_zt5_3qw_2bb__entry__2}

| タイプ | 説明 |
|-|-|
| promise | 成功した場合は Cabrillo.Attachment オブジェクト。操作が失敗すると、エラーが発生します。 |
[表 : 2. 返される内容]

{#CA-addFile_S_S_O_S__table_zt5_3qw_2bb}  

    var table = 'incident';
    var sysID = 'a9e30c7dc61122760116894de7bcc7bd';

    cabrillo.attachments.addFile(table,
        sysID, 
        null,
        null
    ).then(function(attachment) {
        if (attachment) {
            console.log('Added a new file.', attachment);
        } else {
            console.log('User cancelled adding an attachment.');
        }
    }, function(error) {
        console.log('Failed to attach new file.', error);
    });

## cabrillo.attachments - addFiles(文字列 tableName, 文字列 sysId, オブジェクトパラメーター, オブジェクトオプション) {#ariaid-title3}

ファイルを選択してアップロードするためのドキュメントピッカーを表示します。
{#CA-addFiles_S_S_O_S__table_yt5_3qw_2bb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| tableName | 文字列 | ファイルを添付するレコードが含まれているテーブルの名前。 |
| sysID | 文字列 | ファイルを添付するレコードのSys_id。 |
| params | オブジェクト | オプション。将来の使用のために予約されています。null に設定します。 |
| オプション | オブジェクト | オプション。ファイルをアップロードするための追加設定。 { "isSingleSelection": Boolean } |
| options.isSingleSelection | ブーリアン | オプション。ファイルをアップロードするためのドキュメントピッカーで複数選択を許可するかどうかを示すフラグ。 有効な値： * true:アップロードするファイルは一度に 1 つしか選択できません。 * false:アップロードするファイルを一度に複数選択できます。 {#CA-addFiles_S_S_O_S__ul_nkl_n4f_xwb} デフォルト：False |
[表 : 3. パラメーター]

{#CA-addFiles_S_S_O_S__table_yt5_3qw_2bb} {#CA-addFiles_S_S_O_S__table_wgq_ynf_xwb__entry__2}

| タイプ | 説明 |
|-|-|
| Promise | 正常に作成された添付ファイルとエラーが含まれます。 複数のファイルが選択されている場合、正常にアップロードされたファイルごとに Cabrillo.Attachment が作成され、失敗したアップロードごとにエラーメッセージが生成されます。 データタイプ: オブジェクト { "attachments": [Array], "errors": [Array] } |
| Promise.attachments | 正常に作成された添付ファイルが含まれます。 データタイプ：アレイ "attachments": [Cabrillo.Attachment] |
| Promise.errors | エラーが含まれています。 データタイプ：アレイ "errors": ["String"] |
[表 : 4. 返される内容]

{#CA-addFiles_S_S_O_S__table_wgq_ynf_xwb}  
この例では、インシデントレコードに複数の添付ファイルを追加するためのボタンを作成し、アップロードエラーがないかチェックします。

    this.attachMultipleFilesButton = function() {
       c.log("Attempting to add multiple attachments to INC0010453");
       var table = 'incident';
       var sysID = 'fc74aefa1bfb2c10181499f1b24bcb3c';

       cabrillo.attachments.addFiles(table, sysID).then(function(result) {
          if (result) {
             handleMultipleResult(result)
          } else {
             c.log('User cancelled adding an attachment.');
          }
       }, function(error) {
          c.log('Failed to attach new files.', error);
       });
    }

    // A helper function to handle addFiles results 
    function handleMultipleResult(result) {
       c.log('Added multiple attachments.', result);
       if (result.attachments) {
          c.log('Number of new attachments', result.attachments.length);
       }
       if (result.errors) {
          c.log('Number of errors during upload', result.errors.length);
       }
    }

## cabrillo.attachments viewFile(Cabrillo.Attachment attachment, Cabrillo.Rect sourceRect, 文字列 sourceBase64Image) {#ariaid-title4}

ドキュメント ピッカーを表示し、選択したファイルをアップロードします。
注:  
sourceBase64 イメージで sourceRect パラメーターを使用する拡張は、iOS でのみサポートされています。Android はこれらのパラメーターを無視し、拡張アニメーションを使用しないでイメージを開きます。
{#CA-viewFile_CA_CR_S__table_wvb_ybf_wbb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 添付ファイル | Cabrillo.Attachment | 表示する添付ファイルについて説明します。 |
| sourceRect | Cabrillo.Rect | オプション。拡大するイメージのソース レクタングルについて説明します。 |
| sourceBase64Image | 文字列 | オプション。拡大するソース イメージの base64 表現。 |
[表 : 5. パラメーター]

{#CA-viewFile_CA_CR_S__table_wvb_ybf_wbb} {#CA-viewFile_CA_CR_S__table_xvb_ybf_wbb__entry__2}

| タイプ | 説明 |
|-|-|
| promise | 成功した場合は未解決のオブジェクト、それ以外の場合はエラー。 |
[表 : 6. 返される内容]

{#CA-viewFile_CA_CR_S__table_xvb_ybf_wbb}  

    // A Cabrillo.Attachment dictionary to view
    var attachment = {
        sys_id: '8e99daa3ff133100ba13ffffffffff2d',
        content_type: 'image/jpeg',
        path: '8e99daa3ff133100ba13ffffffffff2d.iix'
    };

    cabrillo.attachments.viewFile(attachment,
        null,
        null
    ).then(function() {
        // It worked. Nothing to do here.
    }, function(error) {
        console.log('Failed to view file.', error);
    });

ネイティブ イメージ ビューアーにタップされたイメージを拡大縮小するために、viewFile() メソッドは、ページ上のイメージのレクタングルのオプション引数と、イメージの base64 でエンコードされたサムネイルを受け入れます。サムネイルは、アニメーションを含むフル サイズのイメージに拡大縮小されます。

    // Grab image metadata from an image that was tapped
    var imageMetadata = imageMetadataFromEvent(event);

    // Optional rect of image on page
    var imageRect = imageMetadata.rect;

    // Optional base64 encoded image to scale up into native viewer
    var base64EncodedImage = imageMetadata.base64;

    // A Cabrillo.Attachment dictionary to view
    var attachment = {
        sys_id: '8e99daa3ff133100ba13ffffffffff2d',
        content_type: 'image/jpeg',
        path: '8e99daa3ff133100ba13ffffffffff2d.iix'
    }

    cabrillo.attachments.viewFile(attachment,
        imageRect,
        base64EncodedImage
    ).then(function() {
        // It worked. Nothing to do here.
    }, function(error) {
        console.log('Failed to view file.', error);
    });