24Files Apex methods

Parameters

The following capitalized items need to be replaced by your specific values when calling the 24Files Apex methods:

RECORD_ID = ID of the record
USE_ANONYMOUS_AUTH = set to ‘true’ to use anonymous auth or ‘false’ to use authenticated auth
EMAIL_ADDRESS = email address where results should be sent to
CONTENT_VERSION_ID = Salesforce content version id where the file is stored in
PATH = long path including the document library - e.g. /Shared Documents/Accounts/ACME [0015I00000n0T3VQAU]/Opportunities/projectA
FOLDER = This represents the path relative to the base folder.
- For Authenticated Access: The FOLDER variable is relative to the Record Folder.
- Example:
  - To query a “file” in the Record Folder itself, set FOLDER to "file".
  - To query a “file” in a subfolder within the Record Folder, set FOLDER to "subfolder/file".
- For Anonymous Access: The FOLDER variable is relative to the Public Folder, which is the default base path for anonymous access. Files can only be uploaded to the Public Folder or its subfolders.
FOLDER = relative folder to the record folder so - eg so for Get File Link the FOLDER variable to query a “file” from the record folder would be “file” and if the file is located in a subfolder called “subfolder” , the variable would be "subfolder/file"

Note: in case of anonymous access, you can only upload in the public folder and this folder is the standard relative path for anonymous access.

Note that in case of Anonymous Authentication the FOLDER is the path relative from the Public Folder. For Authenticated Authentication, this is the path relative from the Record Folder.

Limitations

With APEX, file uploads are limited to a maximum size of 35 MB per file.
The getFileLink APEX method returns a link with an expiration duration that has been set in the 24Files Settings page in the 24Files Manager app.

Create Single Folder

CODE

sfy_office365.AddFolderGlobalMethod.FolderRequest folderRequest = new sfy_office365.AddFolderGlobalMethod.FolderRequest(RECORD_ID, FOLDER, USE_ANONYMOUS_AUTH);
sfy_office365.CreateFoldersGlobalMethod.createFolder(folderRequest, EMAIL_ADDRESS);

Create Multiple Folders

CODE

sfy_office365.CreateFoldersGlobalMethod.createFolders(new List<sfy_office365.AddFolderGlobalMethod.FolderRequest>(), EMAIL_ADDRESS);

Create Folder Structure

CODE

List<sfy_office365.GenerateFolderStructureGlobalMethod.FolderStructureRequest> generateFolderStructures = new List<sfy_office365.GenerateFolderStructureGlobalMethod.FolderStructureRequest>{new sfy_office365.GenerateFolderStructureGlobalMethod.FolderStructureRequest(RECORD_ID, USE_ANONYMOUS_AUTH, EMAIL_ADDRESS)};
sfy_office365.GenerateFolderStructureGlobalMethod.generateFolderStructure(generateFolderStructures);

Upload File

CODE

sfy_office365.AddFileGlobalMethod.FileRequest uploadFile = new sfy_office365.AddFileGlobalMethod.FileRequest(RECORD_ID, FOLDER, CONTENT_VERSION_ID, USE_ANONYMOUS_AUTH);
sfy_office365.UploadFilesGlobalMethod.uploadFile(uploadFile, EMAIL_ADDRESS);

Upload Files

CODE

sfy_office365.UploadFilesGlobalMethod.uploadFiles(new List<sfy_office365.AddFileGlobalMethod.FileRequest>(), EMAIL_ADDRESS);

Get File Link

Use this method to retrieve a public link for a single file.

CODE

List<sfy_office365.GetFileLinksGlobalMethod.FileLinkRequest> fileLinkRequests = new List<sfy_office365.GetFileLinksGlobalMethod.FileLinkRequest>{new sfy_office365.GetFileLinksGlobalMethod.FileLinkRequest(RECORD_ID,FOLDER, USE_ANONYMOUS_AUTH)};
sfy_office365.GetFileLinksGlobalMethod.getFileLink(fileLinkRequests);

Get File Links

Use this method to retrieve public links for a multiple files for multiple records.

CODE

List<sfy_office365.GetFileLinksGlobalMethodBatch.FileLinkRequestBatch> fileLinkRequestsBatch = new List<sfy_office365.GetFileLinksGlobalMethodBatch.FileLinkRequestBatch>
{
    new sfy_office365.GetFileLinksGlobalMethodBatch.FileLinkRequestBatch(
        RECORD_ID_1,
        FOLDER_1,
        USE_ANONYMOUS_AUTH
    ),
    new sfy_office365.GetFileLinksGlobalMethodBatch.FileLinkRequestBatch(
        RECORD_ID_2,
        FOLDER_2,
        USE_ANONYMOUS_AUTH
    ),
    new sfy_office365.GetFileLinksGlobalMethodBatch.FileLinkRequestBatch(
        RECORD_ID_3,
        FOLDER_3,
        USE_ANONYMOUS_AUTH
    )
};

sfy_office365.GetFileLinksGlobalMethodBatch.getFileLinkBatch(fileLinkRequestsBatch);

Metadata Sync

24Files allows you to sync Salesforce fields to SharePoint metadata at the time when a new record is created. Use this Apex method to enable a sync at other times, e.g. when records fields are updated.

CODE

sfy_office365.X24FilesMetadataSync.metadataSync(List<String> recordIds);

Rename Record Folder

Use this Apex method to rename the record folder in SharePoint, e.g. triggered by a change of the record folder name in Salesforce.

CODE

sfy_office365.X24FilesRenameRecordFolder.renameRecordFolders(List<String> recordIds);

Get Folder Path

Use this Apex method to retrieve the folder paths for specified records in SharePoint, typically as part of integrations or automations involving SharePoint folder structures.

CODE

List<List<Id>> recordIds = new List<List<Id>>{ new List<Id>{ RECORD_ID  } };
List<List<sfy_office365.GetFolderPathResponse>> responses = sfy_office365.X24FilesSharepointGetFolderPath.getFolderPath(recordIds);

Move Folder

Use this Apex method to move folders within SharePoint by specifying the old and new paths. This method can be utilized as part of an automation process where folder paths need to be updated.

CODE

sfy_office365.FilesMoveRequest req = new sfy_office365.FilesMoveRequest(PATH_from, PATH_to);
List<sfy_office365.FilesMoveRequest> requests = new List<sfy_office365.FilesMoveRequest>();
requests.add(req);
List<sfy_office365.X24FIlesSharepointMove.Response> responses = sfy_office365.X24FIlesSharepointMove.moveFolder(new List<List<sfy_office365.FilesMoveRequest>> {requests})[0];

Remove Files

Use this Apex method to remove specified files from SharePoint, typically for scenarios where files need to be deleted based on Salesforce record information.

CODE

sfy_office365.FileRemoveRequest req = new sfy_office365.FileRemoveRequest(RECORD_ID, FOLDER, USE_ANONYMOUS_AUTH);
List<sfy_office365.FileRemoveRequest> requests = new List<sfy_office365.FileRemoveRequest>();
requests.add(req);
List<sfy_office365.X24FIlesSharepointRemove.Response> responses = sfy_office365.X24FIlesSharepointRemove.removeFiles(new List<List<sfy_office365.FileRemoveRequest>> {requests})[0];

Remove Folders

Use this Apex method to remove a specified folder from SharePoint.

CODE

sfy_office365.FolderRemoveRequest req = new sfy_office365.FolderRemoveRequest(RECORD_ID,FOLDER, USE_ANONYMOUS_AUTH);
List<sfy_office365.FolderRemoveRequest> requests = new List<sfy_office365.FolderRemoveRequest>();
requests.add(req);
List<sfy_office365.X24FIlesSharepointRemoveFolder.Response> responses = sfy_office365.X24FIlesSharepointRemove.removeFolders(new List<List<sfy_office365.FolderRemoveRequest>> {requests})[0];

Upload Metadata

Use this Apex method to upload metadata to SharePoint.

CODE

List<sfy_office365.SharepointMetadata> metadata = new List<sfy_office365.SharepointMetadata>{new sfy_office365.SharepointMetadata(SHAREPOINT_FIELD, VALUE)};
sfy_office365.UploadMetadataRequest request = new sfy_office365.UploadMetadataRequest(RECORD_ID, filename,FOLDER,metadata);
List<sfy_office365.UploadMetadataRequest> innerList = new List<sfy_office365.UploadMetadataRequest>{ request };
List<List<sfy_office365.UploadMetadataRequest>> outerList = new List<List<sfy_office365.UploadMetadataRequest>>{ innerList };
sfy_office365.X24UploadMetadata.uploadMetadata(outerList);