Home Reference Source
public class | source

ElectronApi

You can directly use an instance of this class. electronApi

Constructor Summary

Public Constructor
public

Member Summary

Private Members
private

_log: *

Method Summary

Public Methods
public

async addOpDependency(options: *): *

public

async addOpPackage(data: *): *

public

async addProjectOpDir(): *

public
public

checkOpName(data: *): *

public

checkProjectUpdated(data: *): *

public
public

collectOps(): *

public

async createFile(data: *): *

public
public

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

public

async exportPatch(): *

public

async exportPatchBundle(): *

public

fileUpload(data: *): *

public

formatOpCode(data: *): *

public

async getAllProjectOps(): *

public
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
public
public

async gotoPatch(data: *): *

public

init()

public
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 openAssetDir(data: *): *

public

async openDir(options: {}): *

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
public
public

setProjectName(options: *): *

public

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

public

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

public

updateFile(data: *): *

Private Methods
private

_findNewAssetFilename(targetDir: *, fileName: *): *

private

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

private

async _installOpDependencies(opName: *): *

Public Constructors

public constructor() source

Private Members

private _log: * source

Public Methods

public async addOpDependency(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public async addOpPackage(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async addProjectOpDir(): * source

Return:

*

public checkNumAssetPatches(): * source

Return:

*

public checkOpName(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public checkProjectUpdated(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public collectAssets(): * source

Return:

*

public collectOps(): * source

Return:

*

public async createFile(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public cycleFullscreen() source

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

Params:

NameTypeAttributeDescription
msg *
data undefined
  • optional
  • default: undefined
level string
  • optional
  • default: warn

Return:

*

public async exportPatch(): * source

Return:

*

public async exportPatchBundle(): * source

Return:

*

public fileUpload(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public formatOpCode(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async getAllProjectOps(): * source

Return:

*

public getBuildInfo(): * source

Return:

*

public getChangelog(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async getCollectionOpDocs(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public getFileDetails(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public getFilelist(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public getLibraryFileInfo(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public getOpCode(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async getOpDocs(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async getOpDocsAll(): * source

Return:

*

public getOpInfo(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public getPatch(): * source

Return:

*

public getProjectOpDirs(): * source

Return:

*

public getRecentPatches(): * source

Return:

*

public async gotoPatch(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public init() source

public async installProjectDependencies(): * source

Return:

*

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

Params:

NameTypeAttributeDescription
projectFile *
newProject undefined
  • optional
  • default: undefined
rebuildCache boolean
  • optional
  • default: true

public async newPatch(): * source

Return:

*

public async opAddCoreLib(data: *) source

Params:

NameTypeAttributeDescription
data *

public async opAddLib(data: *) source

Params:

NameTypeAttributeDescription
data *

public async opAttachmentAdd(data: *) source

Params:

NameTypeAttributeDescription
data *

public async opAttachmentDelete(data: *) source

Params:

NameTypeAttributeDescription
data *

public async opAttachmentGet(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opAttachmentSave(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opClone(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async opCreate(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opDelete(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async opRemoveCoreLib(data: *) source

Params:

NameTypeAttributeDescription
data *

public async opRemoveLib(data: *) source

Params:

NameTypeAttributeDescription
data *

public opRename(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opSaveLayout(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opSetSummary(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public opUpdate(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async openAssetDir(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

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

Params:

NameTypeAttributeDescription
options {}
  • optional
  • default: {}

Return:

*

public async openOpDir(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public async openProjectDir(): * source

Return:

*

public async patchCreateBackup(): * source

Return:

*

public async removeOpDependency(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

public async removeProjectOpDir(dirName: *): * source

Params:

NameTypeAttributeDescription
dirName *

Return:

*

public saveOpCode(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async savePatch(patch: *): * source

Params:

NameTypeAttributeDescription
patch *

Return:

*

public async saveProjectAs(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public saveProjectOpDirOrder(order: *): * source

Params:

NameTypeAttributeDescription
order *

Return:

*

public saveScreenshot(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public saveUserSettings(data: *) source

Params:

NameTypeAttributeDescription
data *

public async selectDir(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public async selectFile(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

public setIconSaved() source

public setIconUnsaved() source

public setProjectName(options: *): * source

Params:

NameTypeAttributeDescription
options *

Return:

*

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

Params:

NameTypeAttributeDescription
msg *
data *
raw boolean
  • optional
  • default: false

Return:

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

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

Params:

NameTypeAttributeDescription
cmd *
data *
topicConfig {}
  • optional
  • default: {}

Return:

*

public updateFile(data: *): * source

Params:

NameTypeAttributeDescription
data *

Return:

*

Private Methods

private _findNewAssetFilename(targetDir: *, fileName: *): * source

Params:

NameTypeAttributeDescription
targetDir *
fileName *

Return:

*

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

Params:

NameTypeAttributeDescription
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 async _installOpDependencies(opName: *): * source

Params:

NameTypeAttributeDescription
opName *

Return:

*