1 Single File Actions
- 1.1 readSFFile
- 1.2 queryContent
- 1.3 createSFFileFromCamera
- 1.4 deleteSFFile
2 Create Actions on Multiple Files (recommended v14+)
3 Create Actions on Single Files
- 3.1 createSFFile
- 3.2 createSFFileFromFilePath

In order to use the below APIs, you must enable Salesforce Files support within Pulsar. Please see "Enable Salesforce Files" for instructions for doing this.

Note: You can also pass other additional parameters like custom fields in the data when creating files.

Refer to Image Quality and Max Pixel side settings to understand how you can control the image sizes.

Single File Actions

readSFFile

This API call returns an array containing a dictionary with the ContentVersion object for the ContentDocument or ContentVersion matching the Id specified.

Important returned fields:

VersionData – base64 encoded file data (if ReturnBase64Data is not false)
ThumbBody – base64 encoded file thumbnail data (if ReturnBase64Data is not false and the file is an image)
FileURL – local URL to the file
ThumbURL – local URL to the file thumbnail (empty string if file is not an image)

Related Pulsar Settings:

pulsar.attachment.thumbnailMaxSidePixels

var request = {
"type" : "readSFFile",
"data" : {
        "Id" : "069234567891234",        // Required ContentDocument or ContentVersion Id
        "ReturnBase64Data" : false,      // Optional, default false.  If false you will still have access to URL of file
        "DownloadVersionData" : true,     // Optional, default true. If true and online, Pulsar will attempt to download the file from the server to ensure it has the latest version. If false, it will skip this step and use the data is available locally, if it exists.
    }
};
bridge.send(request, function (responseData) { alert('The File is located here: ' + responseData.data[0].FileURL });

Normal data reads through 'select' API will not contain Base64 file data in the VersionData field unless that field has previously been queried from Salesforce or otherwise populated with Base64 data.

queryContent

This API call returns an array of dictionaries representing ContentVersion objects matching the specified filter. The filter is specified in sqlite where clause format, and is applied to objects in the ContentVersion table only. For example "(ContentDocumentId= '069234567891234')" will return all ContentVersions where the ContentDocumentId field is set to 069234567891234. This method will return URLs to a cached version of the File, but will not return the file data directly as in readSFFile.

Important returned fields:

FileURL – local URL to the file
ThumbURL – local URL to the thumbnail file (empty string if file is not an image)
FilePath - local relative or absolute path to the file
ThumbPath - local relative or absolute path to the file

var request = {
"type" : "queryContent",
"data" : {
        /* give us all synced files attached to account with Id 001abc012345678ABC */
        "filter" : "ContentDocumentId in (SELECT ContentDocumentId FROM ContentDocumentLink WHERE LinkedEntityId = '001abc012345678ABC')",
        "DownloadVersionData" : true,     // Optional, default true. If true and online, Pulsar will attempt to download the files from the server to ensure it has the latest version. If false, it will skip this step and use the data is available locally, if it exists.
    }
};
bridge.send(request, function (responseData) { alert('The first File is located here: ' + responseData.data[0].FileURL });

The queryContent API call will NOT return the ContentVersion's Base64 VersionData field or the Base64 data representing the thumbnail.

createSFFileFromCamera

The createSFFileFromCamera method allows creation of Salesforce Files directly from the device's camera. The intended File's parent SObject Id is a required argument. Optionally, you can specify a file name for the File, instead of using the name of the original file. On success, the response data contains the Id of the created ContentDocument.

Multiple create or delete requests MUST NOT run concurrently, and should instead be run sequentially. This means using callbacks and/or promises with .then() for continuations.

var request = {
"type" : "createSFFileFromCamera",
"data" : {
        "ParentId" : "001234567891234",               // Required
        "Name" : "FileName.jpg",                      // Optional
        "NetworkId" : "0DB123456789123",              // Optional -- The NetworkId of the current Experience Cloud site. NOTE: this would be required only for your Salesforce Community Users.
        "<Custom_Field>" : "<your custom field data>" // You may specify your custom fields here which may be optional or required depending on your configuration.
    }
};
bridge.send(request, function (responseData) {
    if (responseData.type == "createSFFileResponse") {
        alert('Created ContentDocumentId: ' + responseData.data);
    }
    else {
        // error code
    }
});

deleteSFFile

The deleteSFFile method allows deletion of Salesforce Files. A list of content document ids is the only required argument. On success, the response type will be 'deleteSFFileResponse'.

Multiple create or delete requests MUST NOT run concurrently, and should instead be run sequentially. This means using callbacks and/or promises with .then() for continuations.

var request = {
"type" : "deleteSFFile",
"data" : {
        "documentIdList" : ["069234567891234"]  // Required
    }
};
bridge.send(request, function (responseData) {
    if (responseData.type == "deleteSFFileResponse") {
        alert('delete success');
    }
    else {
        alert('delete error');
    }
});

Create Actions on Multiple Files (recommended v14+)

createBatchResponse returned from batch endpoints

All of the following endpoints return a response in the format below. The response below is simplified for brevity.

Full Success – all files saved

{
    "type": "createbatchResponse",
    "object": "ContentDocument",
    "data": {
        "summary": { "success": "TRUE" },
        "results": {
            "0": {
                "objectId": "CURIUM_1111111111_1", // this could also be an 069 ContentDocumentId if performed online.
                "success": "TRUE",
                "FileURL": "http://127.0.0.1:17014/datacache/FileName1.jpg"
            },
            "1": {
                "objectId": "CURIUM_222222222_2", // this could also be an 069 ContentDocumentId if performed online.
                "success": "TRUE",
                "FileURL": "http://127.0.0.1:17014/datacache/FileName2.jpg"
            }
        }
    }
}

Partial Success – some files saved

{
    "type": "createbatchResponse",
    "object": "ContentDocument",
    "data": {
        "summary": { "success": "FALSE" },
        "results": {
            "0": {
                "objectId": "CURIUM_1111111111_1", // this could also be an 069 ContentDocumentId if performed online.
                "success": "TRUE",
                "FileURL": "http://127.0.0.1:17014/datacache/FileName.jpg"
            },
            "1": {
                "success": "FALSE",
                "error": "...error message from API for this file..."
            }
        }
    }
}

createSFFileBatch

The createSFFileBatch method allows creation of multiple Salesforce Files directly from Base64 encoded data. An array of objects with their intended parent SObject Id (ParentId), Name, and Body are required arguments. The ContentType of the File may be optionally specified in MIME type format, as in the example below. On success, the response data contains the Id of the created ContentDocument.

var request = {
"type" : "createSFFileBatch",
"data" : [
   {
        "ParentId" : "001234567891234",               // Required
        "Name" : "FileName.jpg",                      // Required
        "Body" : "AABBCCDDEEFF...",                   // Required -- Base64 data
        "ContentType" : "image/jpeg",                 // Optional -- Manual entry of content type
        "Description" : "...",                        // Optional
        "NetworkId" : "0DB123456789123",              // Optional -- The NetworkId of the current Experience Cloud site. NOTE: this would be required only for your Salesforce Community Users.
        "<Custom_Field>" : "<your custom field data>" // You may specify your custom fields here which may be optional or required depending on your configuration.
    },
    { ... },
    { ... },
]};
bridge.send(request, function (responseData) {
    if (responseData.type == "createbatchResponse") {
        // process results
    }
    else {
        // error code
    }
});

createSFFileFromFilePathBatch

The createSFFileFromFilePathBatch method allows creation of multiple Salesforce Files directly from valid, accessible, device file paths. An array of objects with their intended parent SObject Id (ParentId), Name, and Body are required arguments. The ContentType of the File may be optionally specified in MIME type format, as in the example below. Optionally, you can specify a file name, instead of using the name of the original file. On success, the response data contains the Id of the created ContentDocument.

var request = {
"type" : "createSFFileFromFilePathBatch",
"data" : [
    {
        "ParentId" : "001234567891234",               // Required
        "Name" : "FileName.jpg",                      // Optional
        "ContentType" : "image/jpeg",                 // Optional -- Manual entry of content type
        "FilePath" : "/Valid/Path/To/File.Jpg",       // Required
        "Description" : "...",                        // Optional
        "NetworkId" : "0DB123456789123",              // Optional -- The NetworkId of the current Experience Cloud site. NOTE: this would be required only for your Salesforce Community Users.
        "<Custom_Field>" : "<your custom field data>" // You may specify your custom fields here which may be optional or required depending on your configuration.
    },
    { ... },
    { ... },
]};
bridge.send(request, function (responseData) {
    if (responseData.type == "createbatchResponse") {
         // process results
    }
    else {
        // error code
    }
});

Create Actions on Single Files

createSFFile

The createSFFile method allows creation of Salesforce Files directly from Base64 encoded data. The intended parent SObject Id (ParentId), Name, and Body are required arguments. The ContentType of the File may be optionally specified in MIME type format, as in the example below. On success, the response data contains the Id of the created ContentDocument.

Multiple create or delete requests MUST NOT run concurrently. If you need to create multiple salesforce files, it is recommend you using the createSFFileBatch endpoint to avoid the effort of using callbacks and/or promises with .then() for continuations.

var request = {
"type" : "createSFFile",
"data" : {
        "ParentId" : "001234567891234",               // Required
        "Name" : "FileName.jpg",                      // Required
        "Body" : "AABBCCDDEEFF...",                   // Required -- Base64 data
        "ContentType" : "image/jpeg",                 // Optional -- Manual entry of content type
        "NetworkId" : "0DB123456789123",              // Optional -- The NetworkId of the current Experience Cloud site. NOTE: this would be required only for your Salesforce Community Users.
        "<Custom_Field>" : "<your custom field data>" // You may specify your custom fields here which may be optional or required depending on your configuration.
    }
};
bridge.send(request, function (responseData) {
    if (responseData.type == "createSFFileResponse") {
        alert('Created Content Document Id: ' + responseData.data);
    }
    else {
        // error code
    }
});

createSFFileFromFilePath

The createSFFileFromFilePath method allows creation of Salesforce Files directly from valid, accessible, device file paths. The intended File parent SObject Id and FilePath are required arguments. The ContentType of the File may be optionally specified in MIME type format, as in the example below. Optionally, you can specify a file name, instead of using the name of the original file. On success, the response data contains the Id of the created ContentDocument.

Multiple create or delete requests MUST NOT run concurrently. If you need to create multiple salesforce files, it is recommend you using the createSFFileFromFilePathBatch endpoint to avoid the effort of using callbacks and/or promises with .then() for continuations.

var request = {
"type" : "createSFFileFromFilePath",
"data" : {
        "ParentId" : "001234567891234",               // Required
        "Name" : "FileName.jpg",                      // Optional
        "ContentType" : "image/jpeg",                 // Optional -- Manual entry of content type
        "FilePath" : "/Valid/Path/To/File.Jpg",       // Required
        "NetworkId" : "0DB123456789123",              // Optional -- The NetworkId of the current Experience Cloud site. NOTE: this would be required only for your Salesforce Community Users.
        "<Custom_Field>" : "<your custom field data>" // You may specify your custom fields here which may be optional or required depending on your configuration.
    }
};
bridge.send(request, function (responseData) {
    if (responseData.type == "createSFFileResponse") {
        alert('Created ContentDocument Id: ' + responseData.data);
    }
    else {
        // error code
    }
});

Pulsar for Salesforce - Documentation

Salesforce Files API