File

The method allows you to update the content of a file on the disk without creating a new file. The version created via this method is saved in the file’s history. The method is used in cases when the file’s body can be obtained from different sources or generated in a script. The comment field contains the description to the new version. In the example below you can see how to add a file version after uploading it from an external resource. As the comment, you can specify that the file is uploaded from an external resource. The context includes:

• downloadUrl. A string that contains the URL from which the file is downloaded.
• newName. The file’s new name.
• file. The file stored on the disk.

  const  fileResponse = await fetch(Context.data.downloadUrl);
  const fileContent =  await fileResponse.arrayBuffer(); 
  const newName = Context.data.fileName;  
  await Context.data.file.addVersion(newName, fileContent, 'The file is  uploaded from an external resource'); 
  

The shortcut version of this method, FileItem.addVersion, uses a download link to add a new file version. The link allows uploading the file’ s content, and a new file version is created from it. You can add a comment to the new file version. In the example below, you can see how to add a new file version using a download link. The context includes:

• downloadUrl. A String type variable storing the file’s download link.
• newName. The file’s new name.
• file. The file on the disk.

  const  newName = Context.data.fileName;
  await Context.data.file.addVersionFromLink( newName, Context.data.downloadUrl); 
  

The method moves the current file to the recycle bin for deletion.

    // Example of deleting all files created by a user (some  user_id) 
    const userID = '1a8286d3-a222-4b8b-a860-84f6505a708a'; 
     const searchFiles = await System.files.search(). 
         where(file => file .__createdBy.eq(userID)). 
         all(); 
   for (let i = 0; i <  searchFiles.length; i += 1) { 
     await searchFiles[i].delete(); 
   } 

The example shows how to search for the first file version. The file’s ID is retrieved from the context. To get all versions, use the offset parameter. Versions are found in the descending order of the version number, from the most recent to older ones. The first version’s number is 1.

// Get file ID 
const fileUUID = Context.data.fileID;  
if(!fileUUID) { 
 return; 
} 
// Search for a file 
const file = await  System.files.search().where(x => x.__id.eq(fileUUID)).first(); 
if(!file) {  
 return; 
} 
// Get all file versions; if there are no versions, an error  is returned 
let allFileVersions: FileVersionItem[] = []; 
let verCount = 0;  
let offset = 0; 
const limit = 20; 
do { 
 const versions = await file. getVersions(limit, offset); 
 verCount = versions.length; 
 offset = offset +  verCount; 
 allFileVersions.push(...versions); 
} while (verCount === limit)  
if(!allFileVersions.length === 0) { 
 throw new Error('The file has no  versions'); 
} 
const firstVersion = allFileVersions.find(ver => ver.version  === 1); 
// Get the file’s body 
const url = await firstVersion. getDownloadUrl(); 
const content = fetch(url); 

The method is used to move a file to the specified directory.

    // Example of searching for all .doc и .docx files in a directory and  moving them to another directory 
    const directoryID = '0520723d-5e32-4d37 -8eca-175853a2ec88'; 
    const searchFiles = await System.files.search().  
         where(file => file.directory.eq(directoryID)). 
         all();  
    // Create a new directory 
   const newDirectory = await System. directories.create('Documents', directoryID); 
   searchFiles!.forEach(async  file => { 
        let format = file.data.__name.split('.').reverse()[0];  
        if (format=='doc' || format=='docx') { 
             await file. move(newDirectory.data.__id); 
        }; 
   }); 

The method is used to change the current file’s name.

  //  Example of renaming a file used in the context 
  const fileUUID = Context. data.fileID; 
  if(!fileUUID) { 
      return; 
  } 
  // Search for the  file 
  const file = await System.files.search().where(x => x.__id. eq(fileUUID)).first(); 
  if(!file) { 
      return; 
  } 
  await file. rename('New Name.txt'); 

Subscribing to a file allows users to get notifications about changes made to the file, new versions, and other events.

Unsubscribing from a file allows you to stop getting notifications about changes made to the file.