Home Reference Source
public class | source

ProjectsUtil

You can directly use an instance of this class. projectsUtil

Extends:

cables-shared-api~SharedProjectsUtil → ProjectsUtil

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

addOpDir(project: *, opDir: *, atTop: boolean): *

public

generateNewProject(owner: *): {"_id": *, "shortId": *, "name": *, "description": *, "userId": *, "cachedUsername": *, "created": *, "updated": *, "visibility": string, "ops": *, "settings": *, "userList": *, "teams": *, "log": *}

public

getAssetPath(projectId: *): *

public

getAssetPathUrl(projectId: *): string

public

getProjectFileName(project: *): *

public

getProjectOpDirs(project: *, includeOsDir: boolean, reverse: boolean): *

public

getScreenShotFileName(proj: *, ext: *): *

public

getScreenShotPath(pId: *): *

public

getUsedAssetFilenames(project: *, includeLibraryAssets: boolean): *

public
public

removeOpDir(project: *, opDir: *): *

public

writeProjectToFile(projectFile: *, project: undefined, patch: undefined)

Public Constructors

public constructor() source

Public Members

public CABLES_PROJECT_FILE_EXTENSION: string source

Public Methods

public addOpDir(project: *, opDir: *, atTop: boolean): * source

Params:

NameTypeAttributeDescription
project *
opDir *
atTop boolean
  • optional
  • default: false

Return:

*

public generateNewProject(owner: *): {"_id": *, "shortId": *, "name": *, "description": *, "userId": *, "cachedUsername": *, "created": *, "updated": *, "visibility": string, "ops": *, "settings": *, "userList": *, "teams": *, "log": *} source

Params:

NameTypeAttributeDescription
owner *

Return:

{"_id": *, "shortId": *, "name": *, "description": *, "userId": *, "cachedUsername": *, "created": *, "updated": *, "visibility": string, "ops": *, "settings": *, "userList": *, "teams": *, "log": *}

public getAssetPath(projectId: *): * source

Params:

NameTypeAttributeDescription
projectId *

Return:

*

public getAssetPathUrl(projectId: *): string source

Params:

NameTypeAttributeDescription
projectId *

Return:

string

public getProjectFileName(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public getProjectOpDirs(project: *, includeOsDir: boolean, reverse: boolean): * source

Params:

NameTypeAttributeDescription
project *
includeOsDir boolean
  • optional
  • default: true
reverse boolean
  • optional
  • default: false

Return:

*

public getScreenShotFileName(proj: *, ext: *): * source

Params:

NameTypeAttributeDescription
proj *
ext *

Return:

*

public getScreenShotPath(pId: *): * source

Params:

NameTypeAttributeDescription
pId *

Return:

*

public getUsedAssetFilenames(project: *, includeLibraryAssets: boolean): * source

Params:

NameTypeAttributeDescription
project *
includeLibraryAssets boolean
  • optional
  • default: false

Return:

*

public isFixedPositionOpDir(dir: *): * source

Params:

NameTypeAttributeDescription
dir *

Return:

*

public removeOpDir(project: *, opDir: *): * source

Params:

NameTypeAttributeDescription
project *
opDir *

Return:

*

public writeProjectToFile(projectFile: *, project: undefined, patch: undefined) source

Params:

NameTypeAttributeDescription
projectFile *
project undefined
  • optional
  • default: undefined
patch undefined
  • optional
  • default: undefined