Home Reference Source 
import {SharedProjectsUtil} from 'cables-shared-api'
public class | source

SharedProjectsUtil

Extends:

cables_dev/shared/api/shared_util.js~SharedUtil → SharedProjectsUtil

Member Summary

Public Members
public get

Method Summary

Public Methods
public

getAssetLibs(project: *): *

public

getAssetPath(projectId: *): *

public

getAssetPathUrl(projectId: *): *

public

getAvailableLibs(project: *): *

public

getBackup(project: *): *

public
public

getCreditsTextArray(proj: *): *

public

getLicenceTextArray(proj: *): *

public

getNewProjectName(randomize: boolean): *

public

getProjectAssetPorts(proj: *, includeLibraryAssets: boolean): *

public

getProjectExampleOps(proj: *): *

public

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

public

getScreenShotPath(pId: *): *

public

makeExportable(p: *, keepAlso: *[]): *

public

makeReadable(ps: *, keepOps: *, allowEdit: *): {} | *[] | *

reduces the object to information that can be sent "over the wire", removes private information, will add isExample and opExampleFor information for projects that are marked as an example for ops *
public

saveProjectScreenshot(proj: *, bodyScreenshot: *): *

Private Methods
private

_makeProjectReadable(project: *, keepOps: boolean, allowEdit: boolean): *

Public Members

public get utilName: * source

Public Methods

public getAssetLibs(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public getAssetPath(projectId: *): * source

Params:

NameTypeAttributeDescription
projectId *

Return:

*

public getAssetPathUrl(projectId: *): * source

Params:

NameTypeAttributeDescription
projectId *

Return:

*

public getAvailableLibs(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public getBackup(project: *): * source

Params:

NameTypeAttributeDescription
project *

Return:

*

public getCoreLibs(): * source

Return:

*

public getCreditsTextArray(proj: *): * source

Params:

NameTypeAttributeDescription
proj *

Return:

*

public getLicenceTextArray(proj: *): * source

Params:

NameTypeAttributeDescription
proj *

Return:

*

public getNewProjectName(randomize: boolean): * source

Params:

NameTypeAttributeDescription
randomize boolean
  • optional
  • default: false

Return:

*

public getProjectAssetPorts(proj: *, includeLibraryAssets: boolean): * source

Params:

NameTypeAttributeDescription
proj *
includeLibraryAssets boolean
  • optional
  • default: false

Return:

*

public getProjectExampleOps(proj: *): * source

Params:

NameTypeAttributeDescription
proj *

Return:

*

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

Params:

NameTypeAttributeDescription
proj *
ext *

Return:

*

public getScreenShotPath(pId: *): * source

Params:

NameTypeAttributeDescription
pId *

Return:

*

public makeExportable(p: *, keepAlso: *[]): * source

Params:

NameTypeAttributeDescription
p *
keepAlso *[]
  • optional
  • default: []

Return:

*

public makeReadable(ps: *, keepOps: *, allowEdit: *): {} | *[] | * source

reduces the object to information that can be sent "over the wire", removes private information, will add isExample and opExampleFor information for projects that are marked as an example for ops *

Params:

NameTypeAttributeDescription
ps *

project or array of projects
keepOps *

do not remove ops from the project (i.e. in export)
allowEdit *

Return:

{} | *[] | *

project or array of projects

public saveProjectScreenshot(proj: *, bodyScreenshot: *): * source

Params:

NameTypeAttributeDescription
proj *
bodyScreenshot *

Return:

*

Private Methods

private _makeProjectReadable(project: *, keepOps: boolean, allowEdit: boolean): * source

Params:

NameTypeAttributeDescription
project *
keepOps boolean
  • optional
  • default: false
allowEdit boolean
  • optional
  • default: false

Return:

*