Skip to main content

File Functions

Functions on All Document Types (Audio, File, Image and Video)​

encodeFileAsBase64(Audio | File | Image | Video file)​

  • Returns the contents of file as base64 encoded string
def File file = new File(); // or Image() or Audio() or Video();
file.url = "https://upload.wikimedia.org/wikipedia/commons/e/e9/Royal_Maundy_1867.jpg";
def string base64EncodedFile1 = file.encodeFileAsBase64();
def string base64EncodedFile2 = encodeFileAsBase64(file);
def Image image = new Image();
image.url = "https://upload.wikimedia.org/wikipedia/commons/e/e9/Royal_Maundy_1867.jpg";
def string base64EncodedImage = image.encodeFileAsBase64();
def string base64EncodedImage2 = encodeFileAsBase64(image);

isFile(<Class> object)​

  • Returns a boolean indicating if an object is a valid File
  • You can use the not variant of this function as detailed here
def File file = new File(); // or Image() or Audio() or Video();
log(isFile(file)); // true
log(file.isFile()); // true
def Image image = new Image();
log(isFile(image)); // true
log(image.isFile()); // true
def Employee employee = new Employee();
log(isFile(employee)); // false
log(employee.isFile()); // false

extractFromZipFile(File zipFile)​

  • Returns a list of files after extracting the given zip file
def File zipFile = new File();
// Do some operations with the file
def List<File> files1 = extractFromZipFile(zipFile);
def List<File> files2 = zipFile.extractFromZipFile();

compressToZipFile((File | Audio | Video | Image)... files)​

  • Returns a File after compressing the given files
def File file1 = new File();
def File file2 = new File();
def File file3 = new File();
// Do some operations with the files
def File zipFile1 = compressToZipFile(file1, file2, file3);
def File zipFile2 = compressToZipFile(file1, file2, file3);

Functions on Specific Document Types​

getFileDuration(Audio | Video file)​

  • Returns the duration (in seconds) of an audio or video file
def Audio audio = new Audio();
audio.url = "<Put some audio file url here>";
def double duration1 = getFileDuration(audio);
def double duration2 = audio.getFileDuration();
def Video video = new Video();
video.url = "<Put some video file url here>";
def double duration1 = getFileDuration(video);
def double duration2 = video.getFileDuration();