ProjectsUtil
Extends:
Constructor Summary
| Public Constructor | ||
| public |
|
|
Member Summary
| Public Members | ||
| public |
CABLES_PROJECT_FILE_EXTENSION: string |
|
| Private Members | ||
| private |
_dirInfos: * |
|
| private |
|
|
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 |
getAbsoluteOpDirFromHierarchy(opName: *): * |
|
| public |
getAssetPath(projectId: *): * |
|
| public |
getAssetPathUrl(projectId: *): string |
|
| public |
getNewProjectName(randomize: boolean): string |
|
| public |
getOpDirs(currentProject: *): * |
|
| public |
getOpDocsInProjectDirs(project: *, rebuildCache: boolean): * |
|
| public |
getProjectFileName(project: *): * |
|
| public |
getProjectOpDirs(project: *, includeOsDir: boolean, reverse: boolean, addLocalCoreIfPackaged: boolean): * |
|
| public |
getScreenShotFileName(proj: *, ext: *): * |
|
| public |
getScreenShotPath(pId: *): * |
|
| public |
getSummary(project: *): {"allowEdit": boolean, "title": *, "owner": *, "description": *, "licence": *} |
|
| public |
getUsedAssetFilenames(project: *, includeLibraryAssets: boolean): * |
|
| public |
|
|
| public |
isFixedPositionOpDir(dir: *): * |
|
| public |
removeOpDir(project: *, opDir: *): * |
|
| public |
reorderOpDirs(currentProject: *, order: *): * |
|
| public |
writeProjectToFile(projectFile: *, project: undefined, patch: undefined) |
|
Public Constructors
public constructor() source
Public Members
public CABLES_PROJECT_FILE_EXTENSION: string source
Private Members
private _dirInfos: * source
private _projectOpDocs: * source
Public Methods
public addOpDir(project: *, opDir: *, atTop: boolean): * source
Params:
| Name | Type | Attribute | Description |
| project | * | ||
| opDir | * | ||
| atTop | boolean |
|
Return:
| * |
public generateNewProject(owner: *): {"_id": *, "shortId": *, "name": *, "description": *, "userId": *, "cachedUsername": *, "created": *, "updated": *, "visibility": string, "ops": *, "settings": *, "userList": *, "teams": *, "log": *} source
Params:
| Name | Type | Attribute | Description |
| owner | * |
Return:
| {"_id": *, "shortId": *, "name": *, "description": *, "userId": *, "cachedUsername": *, "created": *, "updated": *, "visibility": string, "ops": *, "settings": *, "userList": *, "teams": *, "log": *} |
public getAbsoluteOpDirFromHierarchy(opName: *): * source
Params:
| Name | Type | Attribute | Description |
| opName | * |
Return:
| * |
public getAssetPath(projectId: *): * source
Params:
| Name | Type | Attribute | Description |
| projectId | * |
Return:
| * |
public getAssetPathUrl(projectId: *): string source
Params:
| Name | Type | Attribute | Description |
| projectId | * |
Return:
| string |
public getNewProjectName(randomize: boolean): string source
Params:
| Name | Type | Attribute | Description |
| randomize | boolean |
|
Return:
| string |
public getOpDirs(currentProject: *): * source
Params:
| Name | Type | Attribute | Description |
| currentProject | * |
Return:
| * |
public getOpDocsInProjectDirs(project: *, rebuildCache: boolean): * source
Params:
| Name | Type | Attribute | Description |
| project | * | ||
| rebuildCache | boolean |
|
Return:
| * |
public getProjectFileName(project: *): * source
Params:
| Name | Type | Attribute | Description |
| project | * |
Return:
| * |
public getProjectOpDirs(project: *, includeOsDir: boolean, reverse: boolean, addLocalCoreIfPackaged: boolean): * source
Params:
| Name | Type | Attribute | Description |
| project | * | ||
| includeOsDir | boolean |
|
|
| reverse | boolean |
|
|
| addLocalCoreIfPackaged | boolean |
|
Return:
| * |
public getScreenShotFileName(proj: *, ext: *): * source
Params:
| Name | Type | Attribute | Description |
| proj | * | ||
| ext | * |
Return:
| * |
public getSummary(project: *): {"allowEdit": boolean, "title": *, "owner": *, "description": *, "licence": *} source
Params:
| Name | Type | Attribute | Description |
| project | * |
Return:
| {"allowEdit": boolean, "title": *, "owner": *, "description": *, "licence": *} |
public getUsedAssetFilenames(project: *, includeLibraryAssets: boolean): * source
Params:
| Name | Type | Attribute | Description |
| project | * | ||
| includeLibraryAssets | boolean |
|
Return:
| * |
public invalidateProjectCaches() source
public removeOpDir(project: *, opDir: *): * source
Params:
| Name | Type | Attribute | Description |
| project | * | ||
| opDir | * |
Return:
| * |
public reorderOpDirs(currentProject: *, order: *): * source
Params:
| Name | Type | Attribute | Description |
| currentProject | * | ||
| order | * |
Return:
| * |
public writeProjectToFile(projectFile: *, project: undefined, patch: undefined) source
Params:
| Name | Type | Attribute | Description |
| projectFile | * | ||
| project | undefined |
|
|
| patch | undefined |
|