Appearance

API: workspace ​

Source: platform/workspace.ts

Provides a wrapper for the platform's WorkspaceFacade to manage Workspaces, Projects, Folders, and Files.

Usage ​

javascript
import { workspace } from "sdk/platform";
import { response } from "sdk/http";

let workspacesNames = workspace.getWorkspacesNames();

response.println("Workspaces: " + workspacesNames);
response.flush();
response.close();

Classes ​

Workspace ​

@class Workspace
@description Represents a logical container for projects, providing static methods for
high-level workspace management and instance methods for project management within the workspace.

Methods ​

createWorkspace ​

  • createWorkspace (name:string):Workspace

    Creates a new workspace with the given name.

    @param {string} name The name of the workspace to create.
    @returns {Workspace} The newly created Workspace instance.

getWorkspace ​

  • getWorkspace (name:string):Workspace

    Retrieves an existing workspace by name.

    @param {string} name The name of the workspace to retrieve.
    @returns {Workspace} The Workspace instance.

getWorkspacesNames ​

  • getWorkspacesNames ():string[]

    Retrieves the names of all existing workspaces.

    @returns {string[]} An array of workspace names.

deleteWorkspace ​

  • deleteWorkspace (name:string):void

    Deletes the workspace with the specified name.

    @param {string} name The name of the workspace to delete.

getProjects ​

  • getProjects ():Projects

    Gets a collection of all projects within this workspace.

    @returns {Projects} A Projects collection instance.

createProject ​

  • createProject (name:string):Project

    Creates a new project within this workspace.

    @param {string} name The name of the project to create.
    @returns {Project} The newly created Project instance.

getProject ​

  • getProject (name:string):Project

    Retrieves an existing project by name from this workspace.

    @param {string} name The name of the project to retrieve.
    @returns {Project} The Project instance.

deleteProject ​

  • deleteProject (name:string):void

    Deletes a project from this workspace by name.

    @param {string} name The name of the project to delete.

exists ​

  • exists ():boolean

    Checks if the workspace currently exists.

    @returns {boolean} True if the workspace exists, false otherwise.

existsFolder ​

  • existsFolder (path:string):boolean

    Checks if a specific folder path exists within the workspace's filesystem structure.

    @param {string} path The relative path to the folder.
    @returns {boolean} True if the folder exists.

existsFile ​

  • existsFile (path:string):boolean

    Checks if a specific file path exists within the workspace's filesystem structure.

    @param {string} path The relative path to the file.
    @returns {boolean} True if the file exists.

copyProject ​

  • copyProject (source:string, target:string):void

    Copies a project from a source name to a target name within the workspace.

    @param {string} source The name of the project to copy.
    @param {string} target The name of the new project copy.

moveProject ​

  • moveProject (source:string, target:string):void

    Moves a project from a source name to a target name (renaming it).

    @param {string} source The current name of the project.
    @param {string} target The new name/path of the project.

Projects ​

@class Projects
@description A collection/list of projects within a workspace.

Methods ​

size ​

  • size ():number

    Gets the number of projects in the collection.
    @returns {number} The size of the collection.

get ​

  • get (index:number):Project

    Gets a Project instance at the specified index.
    @param {number} index The index of the project.
    @returns {Project} The Project instance.

Project ​

@class Project
@description Represents a Project within a workspace. It provides methods for managing
folders and files within the project.

Methods ​

getName ​

  • getName ():string

    Gets the name of the project.
    @returns {string} The project name.

getPath ​

  • getPath ():string

    Gets the path of the project.
    @returns {string} The project path (relative to the repository/workspace root).

createFolder ​

  • createFolder (path:string):Folder

    Creates a new folder within the project.

    @param {string} path The path of the folder to create (relative to the project root).
    @returns {Folder} The newly created Folder instance.

exists ​

  • exists ():boolean

    Checks if the project itself exists.
    @returns {boolean} True if the project exists.

existsFolder ​

  • existsFolder (path:string):boolean

    Checks if a specific folder path exists within the project.

    @param {string} path The relative path to the folder.
    @returns {boolean} True if the folder exists.

getFolder ​

  • getFolder (path:string):Folder

    Retrieves a folder by its path relative to the project root.

    @param {string} path The relative path to the folder.
    @returns {Folder} The Folder instance.

getFolders ​

  • getFolders (path:string):Folders

    Retrieves a collection of folders at a specific path.

    @param {string} path The path containing the folders to retrieve.
    @returns {Folders} The Folders collection instance.

deleteFolder ​

  • deleteFolder (path:string):void

    Deletes a folder from the project.

    @param {string} path The path of the folder to delete (relative to the project root).

createFile ​

  • createFile (path:string, input:any[]=[]):File

    Creates a new file within the project.

    @param {string} path The path of the file to create (relative to the project root).
    @param {any[]} [input=[]] Optional initial content as a byte array.
    @returns {File} The newly created File instance.

existsFile ​

  • existsFile (path:string):boolean

    Checks if a specific file path exists within the project.

    @param {string} path The relative path to the file.
    @returns {boolean} True if the file exists.

getFile ​

  • getFile (path:string):File

    Retrieves a file by its path relative to the project root.

    @param {string} path The relative path to the file.
    @returns {File} The File instance.

getFiles ​

  • getFiles (path:string):Files

    Retrieves a collection of files at a specific path.

    @param {string} path The path containing the files to retrieve.
    @returns {Files} The Files collection instance.

deleteFile ​

  • deleteFile (path:string):void

    Deletes a file from the project.

    @param {string} path The path of the file to delete (relative to the project root).

Folders ​

@class Folders
@description A collection/list of folders.

Methods ​

size ​

  • size ():number

    Gets the number of folders in the collection.
    @returns {number} The size of the collection.

get ​

  • get (index:number):Folder

    Gets a Folder instance at the specified index.
    @param {number} index The index of the folder.
    @returns {Folder} The Folder instance.

Files ​

@class Files
@description A collection/list of files.

Methods ​

size ​

  • size ():number

    Gets the number of files in the collection.
    @returns {number} The size of the collection.

get ​

  • get (index:number):File

    Gets a File instance at the specified index.
    @param {number} index The index of the file.
    @returns {File} The File instance.

Folder ​

@class Folder
@description Represents a directory or folder within a project, providing methods for
managing sub-folders and files.

Methods ​

getName ​

  • getName ():string

    Gets the name of the folder.
    @returns {string} The folder name.

getPath ​

  • getPath ():string

    Gets the full path of the folder.
    @returns {string} The folder path.

createFolder ​

  • createFolder (path:string):Folder

    Creates a new sub-folder within this folder.

    @param {string} path The path of the sub-folder to create (relative to this folder).
    @returns {Folder} The newly created Folder instance.

exists ​

  • exists ():boolean

    Checks if the folder itself exists.
    @returns {boolean} True if the folder exists.

existsFolder ​

  • existsFolder (path:string):boolean

    Checks if a specific sub-folder path exists within this folder.

    @param {string} path The relative path to the sub-folder.
    @returns {boolean} True if the sub-folder exists.

getFolder ​

  • getFolder (path:string):Folder

    Retrieves a sub-folder by its path relative to this folder.

    @param {string} path The relative path to the sub-folder.
    @returns {Folder} The Folder instance.

getFolders ​

  • getFolders (path:string):Folders

    Retrieves a collection of folders at a specific path relative to this folder.

    @param {string} path The path containing the folders to retrieve.
    @returns {Folders} The Folders collection instance.

deleteFolder ​

  • deleteFolder (path:string):void

    Deletes a sub-folder from this folder.

    @param {string} path The path of the sub-folder to delete (relative to this folder).

createFile ​

  • createFile (path:string, input:any[]=[]):File

    Creates a new file within this folder.

    @param {string} path The path of the file to create (relative to this folder).
    @param {any[]} [input=[]] Optional initial content as a byte array.
    @returns {File} The newly created File instance.

existsFile ​

  • existsFile (path:string):boolean

    Checks if a specific file path exists within this folder.

    @param {string} path The relative path to the file.
    @returns {boolean} True if the file exists.

getFile ​

  • getFile (path:string):File

    Retrieves a file by its path relative to this folder.

    @param {string} path The relative path to the file.
    @returns {File} The File instance.

getFiles ​

  • getFiles (path:string):Files

    Retrieves a collection of files at a specific path relative to this folder.

    @param {string} path The path containing the files to retrieve.
    @returns {Files} The Files collection instance.

deleteFile ​

  • deleteFile (path:string):void

    Deletes a file from this folder.

    @param {string} path The path of the file to delete (relative to this folder).

File ​

@class File
@description Represents a file (resource) within the workspace, providing methods for
content access and manipulation.

Methods ​

getName ​

  • getName ():string

    Gets the name of the file.
    @returns {string} The file name.

getPath ​

  • getPath ():string

    Gets the full path of the file.
    @returns {string} The file path.

getContentType ​

  • getContentType ():string

    Gets the content type (MIME type) of the file.
    @returns {string} The content type string.

isBinary ​

  • isBinary ():boolean

    Checks if the file content is determined to be binary.
    @returns {boolean} True if binary, false if text.

getContent ​

  • getContent ():any[]

    Gets the content of the file as a JavaScript-friendly byte array.
    @returns {any[]} The content bytes.

getText ​

  • getText ():string

    Gets the content of the file as a text string.
    @returns {string} The text content.

setContent ​

  • setContent (input:any[]):void

    Sets the content of the file using a byte array.
    @param {any[]} input The new content bytes.

setText ​

  • setText (input:string):void

    Sets the content of the file using a text string.
    The string is converted to a byte array before saving.
    @param {string} input The new text content.

exists ​

  • exists ():boolean

    Checks if the file exists.
    @returns {boolean} True if the file exists.