new IncisorApp()
METHODS
-
async getApplicationSettings() returns {IncrCommsResponseObject}
-
Returns an IncrCommsResponseObject whose '.payload' member is copy of the Incisor ApplicationSettings in javascript object form. In order to update the ApplicationSettings, pass 'IncisorApp.setApplicationSettings' a version of this payload that contains the desired modifications.
Returns:
IncrCommsResponseObject -
async getProjectSettings() returns {IncrCommsResponseObject}
-
Returns an IncrCommsResponseObject whose '.payload' member is copy of the current ProjectSettings of the currently open project in javascript object form. In order to update the ProjectSettings, pass 'IncisorApp.setProjectSettings' a version of this payload that contains the desired modifications.
Returns:
IncrCommsResponseObject -
async hostLocalDirectory(directoryPath, isPathRelative (opt), allowRemoteHosting (opt), enableGzip (opt)) returns {IncrCommsResponseObject}
-
Begins hosting files in the given directory, and returns an IncrCommsResponseObject whose '.payload' member contains the port selected by Incisor® to host from.
Parameters:
Name Type Attributes Default Description directoryPathstring The relative or absolute path to the directory to host files from.
isPathRelativeboolean <optional>
Bool stating if the given path is relative to the project path or an absolute path. If an absolute path is used that is outside of the project directory, the 'allowUniversalFileIO' item in application settings must be set to true. [DEFAULT: true]
allowRemoteHostingboolean <optional>
Bool stating if external connections can make requests from this host. If true, the 'allowRemoteHosting' item in application settings must also be set to true. [DEFAULT: false]
enableGzipboolean <optional>
Bool stating files hosted from this connection should be compressed using 'gzip'. [DEFAULT: true]
Returns:
IncrCommsResponseObject -
async openTabToUrl(url) returns {IncrCommsResponseObject}
-
Opens a new tab in the browser at the given url without requiring user interaction.
Parameters:
Name Type Attributes Default Description urlstring The url to open the new browser tab to.
Returns:
IncrCommsResponseObject -
async setApplicationSettings(applicationSettings, commitToDisk (opt)) returns {IncrCommsResponseObject}
-
Updates the Incisor® application settings in memory. The current ApplicationSettings can be retrieved using 'IncisorApp.getApplicationSettings', modified, and updated using this function. ApplicationSettings updated using this method will be automatically validated against the internal Incisor® schema.
Parameters:
Name Type Attributes Default Description applicationSettingsobject The desired ApplicationSettings to update Incisor® with.
commitToDiskboolean <optional>
Boolean determining if the new settings are immediately saved on disk, ensuring their persistence on subsequent application launches. [DEFAULT: false]
Returns:
IncrCommsResponseObject -
async setProjectSettings(projectSettings) returns {IncrCommsResponseObject}
-
Updates the ProjectSettings of the currently open project in memory. The current ProjectSettings can be retrieved using 'IncisorApp.getProjectSettings', modified, and updated using this function. ProjectSettings updated using this method will be automatically validated against the internal Incisor® schema. Once updated, the current project must be saved in order for the changes to be reflected in the ProjectSettings.json file within the project directory.
Parameters:
Name Type Attributes Default Description projectSettingsobject The desired ProjectSettings to update the project with.
Returns:
IncrCommsResponseObject -
async stopHostingLocalDirectory(directoryPath, isPathRelative (opt)) returns {IncrCommsResponseObject}
-
Ends hosting files from the given directory, freeing up the associated port.
Parameters:
Name Type Attributes Default Description directoryPathstring The relative or absolute path to the directory to stop hosting files from.
isPathRelativeboolean <optional>
Bool stating if the given path is relative to the project path or an absolute path. [DEFAULT: true]
Returns:
IncrCommsResponseObject