public class | source

ElectronApi

You can directly use an instance of this class. electronApi

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Private Members
private	_log: *

Method Summary

Public Methods
public	async addOpDependency(options: ):
public	async addOpPackage(data: ):
public	async addProjectOpDir(): *
public	checkNumAssetPatches(): *
public	checkOpName(data: ):
public	checkProjectUpdated(data: ):
public	collectAssets(): *
public	collectOps(): *
public	async createFile(data: ):
public	cycleFullscreen()
public	error(msg: , data: undefined, level: string):
public	errorReport(report: *)
public	async exportPatch(): *
public	async exportPatchBundle(): *
public	fileUpload(data: ):
public	formatOpCode(data: ):
public	async getAllProjectOps(): *
public	getBuildInfo(): *
public	getChangelog(data: ):
public	async getCollectionOpDocs(data: ):
public	getFileDetails(data: ):
public	getFilelist(data: ):
public	getLibraryFileInfo(data: ):
public	getOpCode(data: ):
public	async getOpDocs(data: ):
public	async getOpDocsAll(): *
public	getOpInfo(data: ):
public	getPatch(): *
public	getPatchSummary(): *
public	getProjectOpDirs(): *
public	getRecentPatches(): *
public	async gotoPatch(data: ):
public	init()
public	async installProjectDependencies(): *
public	loadProject(projectFile: *, newProject: undefined, rebuildCache: boolean)
public	async newPatch(): *
public	async opAddCoreLib(data: *)
public	async opAddLib(data: *)
public	async opAttachmentAdd(data: *)
public	async opAttachmentDelete(data: *)
public	async opAttachmentGet(data: ):
public	opAttachmentSave(data: ):
public	opClone(data: ):
public	async opCreate(data: ):
public	opDelete(data: ):
public	async opRemoveCoreLib(data: *)
public	async opRemoveLib(data: *)
public	opRename(data: ):
public	opSaveLayout(data: ):
public	opSetSummary(data: ):
public	opUpdate(data: ):
public	async openDir(options: {}): *
public	async openFileManager(data: ):
public	async openOpDir(options: ):
public	async openProjectDir(): *
public	async patchCreateBackup(): *
public	async removeOpDependency(options: ):
public	async removeProjectOpDir(dirName: ):
public	saveOpCode(data: ):
public	async savePatch(patch: ):
public	async saveProjectAs(data: ):
public	saveProjectOpDirOrder(order: ):
public	saveScreenshot(data: ):
public	saveUserSettings(data: *)
public	async selectDir(data: ):
public	async selectFile(data: ):
public	setIconSaved()
public	setIconUnsaved()
public	setProjectName(options: ):
public	success(msg: , data: undefined, raw: boolean): {"success": boolean, "msg": , "data": *}
public	async talkerMessage(cmd: , data: , topicConfig: {}): *
public	updateFile(data: ):
public	async uploadFileToOp(params: ):

Private Methods
private	_getFullRenameResponse(opDocs: , newName: , oldName: , currentUser: , project: undefined, ignoreVersionGap: boolean, fromRename: boolean, targetDir: boolean): *
private	_getOpDepFromRequest(req: ):
private	async _installOpDependencies(opName: ):

Public Constructors

public constructor() source

Private Members

private _log: * source

Public Methods

public async addOpDependency(options: ): source

Params:

Name	Type	Attribute	Description
options	*

Return:

public async addOpPackage(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async addProjectOpDir(): * source

Return:

public checkNumAssetPatches(): * source

Return:

public checkOpName(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public checkProjectUpdated(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public collectAssets(): * source

Return:

public collectOps(): * source

Return:

public async createFile(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public cycleFullscreen() source

public error(msg: , data: undefined, level: string): source

Params:

Name	Type	Attribute	Description
msg	*
data	undefined	optional default: undefined
level	string	optional default: warn

Return:

public errorReport(report: *) source

Params:

Name	Type	Attribute	Description
report	*

public async exportPatch(): * source

Return:

public async exportPatchBundle(): * source

Return:

public fileUpload(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public formatOpCode(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async getAllProjectOps(): * source

Return:

public getBuildInfo(): * source

Return:

public getChangelog(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async getCollectionOpDocs(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public getFileDetails(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public getFilelist(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public getLibraryFileInfo(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public getOpCode(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async getOpDocs(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async getOpDocsAll(): * source

Return:

public getOpInfo(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public getPatch(): * source

Return:

public getPatchSummary(): * source

Return:

public getProjectOpDirs(): * source

Return:

public getRecentPatches(): * source

Return:

public async gotoPatch(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public init() source

public async installProjectDependencies(): * source

Return:

public loadProject(projectFile: *, newProject: undefined, rebuildCache: boolean) source

Params:

Name	Type	Attribute	Description
projectFile	*
newProject	undefined	optional default: undefined
rebuildCache	boolean	optional default: true

public async newPatch(): * source

Return:

public async opAddCoreLib(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async opAddLib(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async opAttachmentAdd(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async opAttachmentDelete(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async opAttachmentGet(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opAttachmentSave(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opClone(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async opCreate(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opDelete(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async opRemoveCoreLib(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async opRemoveLib(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public opRename(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opSaveLayout(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opSetSummary(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public opUpdate(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async openDir(options: {}): * source

Params:

Name	Type	Attribute	Description
options	{}	optional default: {}

Return:

public async openFileManager(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async openOpDir(options: ): source

Params:

Name	Type	Attribute	Description
options	*

Return:

public async openProjectDir(): * source

Return:

public async patchCreateBackup(): * source

Return:

public async removeOpDependency(options: ): source

Params:

Name	Type	Attribute	Description
options	*

Return:

public async removeProjectOpDir(dirName: ): source

Params:

Name	Type	Attribute	Description
dirName	*

Return:

public saveOpCode(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async savePatch(patch: ): source

Params:

Name	Type	Attribute	Description
patch	*

Return:

public async saveProjectAs(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public saveProjectOpDirOrder(order: ): source

Params:

Name	Type	Attribute	Description
order	*

Return:

public saveScreenshot(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public saveUserSettings(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public async selectDir(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async selectFile(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public setIconSaved() source

public setIconUnsaved() source

public setProjectName(options: ): source

Params:

Name	Type	Attribute	Description
options	*

Return:

public success(msg: , data: undefined, raw: boolean): {"success": boolean, "msg": , "data": *} source

Params:

Name	Type	Attribute	Description
msg	*
data	undefined	optional default: undefined
raw	boolean	optional default: false

Return:

{"success": boolean, "msg": *, "data": *}

public async talkerMessage(cmd: , data: , topicConfig: {}): * source

Params:

Name	Type	Attribute	Description
cmd	*
data	*
topicConfig	{}	optional default: {}

Return:

public updateFile(data: ): source

Params:

Name	Type	Attribute	Description
data	*

Return:

public async uploadFileToOp(params: ): source

Params:

Name	Type	Attribute	Description
params	*

Return:

Private Methods

private _getFullRenameResponse(opDocs: , newName: , oldName: , currentUser: , project: undefined, ignoreVersionGap: boolean, fromRename: boolean, targetDir: boolean): * source

Params:

Name	Type	Attribute	Description
opDocs	*
newName	*
oldName	*
currentUser	*
project	undefined	optional default: undefined
ignoreVersionGap	boolean	optional default: false
fromRename	boolean	optional default: false
targetDir	boolean	optional default: false

Return:

private _getOpDepFromRequest(req: ): source

Params:

Name	Type	Attribute	Description
req	*

Return:

private async _installOpDependencies(opName: ): source

Params:

Name	Type	Attribute	Description
opName	*

ElectronApi

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Private Members

private _log: * source

Public Methods

public async addOpDependency(options: *): * source

Params:

Return:

public async addOpPackage(data: *): * source

Params:

Return:

public async addProjectOpDir(): * source

Return:

public checkNumAssetPatches(): * source

Return:

public checkOpName(data: *): * source

Params:

Return:

public checkProjectUpdated(data: *): * source

Params:

Return:

public collectAssets(): * source

Return:

public collectOps(): * source

Return:

public async createFile(data: *): * source

Params:

Return:

public cycleFullscreen() source

public error(msg: *, data: undefined, level: string): * source

Params:

Return:

public errorReport(report: *) source

Params:

public async exportPatch(): * source

Return:

public async exportPatchBundle(): * source

Return:

public fileUpload(data: *): * source

Params:

Return:

public formatOpCode(data: *): * source

Params:

Return:

public async getAllProjectOps(): * source

Return:

public getBuildInfo(): * source

Return:

public getChangelog(data: *): * source

Params:

Return:

public async getCollectionOpDocs(data: *): * source

Params:

Return:

public getFileDetails(data: *): * source

Params:

Return:

public getFilelist(data: *): * source

Params:

Return:

public getLibraryFileInfo(data: *): * source

Params:

Return:

public getOpCode(data: *): * source

Params:

Return:

public async getOpDocs(data: *): * source

Params:

Return:

public async getOpDocsAll(): * source

Return:

public getOpInfo(data: *): * source

Params:

Return:

public getPatch(): * source

Return:

public async addOpDependency(options: ): source

public async addOpPackage(data: ): source

public checkOpName(data: ): source

public checkProjectUpdated(data: ): source

public async createFile(data: ): source

public error(msg: , data: undefined, level: string): source

public fileUpload(data: ): source

public formatOpCode(data: ): source

public getChangelog(data: ): source

public async getCollectionOpDocs(data: ): source

public getFileDetails(data: ): source

public getFilelist(data: ): source

public getLibraryFileInfo(data: ): source

public getOpCode(data: ): source

public async getOpDocs(data: ): source

public getOpInfo(data: ): source

public async gotoPatch(data: ): source

public async opAttachmentGet(data: ): source

public opAttachmentSave(data: ): source

public opClone(data: ): source

public async opCreate(data: ): source

public opDelete(data: ): source

public opRename(data: ): source

public opSaveLayout(data: ): source

public opSetSummary(data: ): source

public opUpdate(data: ): source

public async openFileManager(data: ): source

public async openOpDir(options: ): source

public async removeOpDependency(options: ): source