Class ModelServerClientImpl

Default implementation of IModelServerClient.

Hierarchy

ModelServerClientImpl

Implements

IModelServerClient

Index

Constructors

constructor

Properties

getTaskDelayInMs

Methods

Constructors

constructor

new ModelServerClientImpl(config: ISdkConfig): ModelServerClientImpl

Parameters
- config: ISdkConfig
Returns ModelServerClientImpl

Properties

getTaskDelayInMs

getTaskDelayInMs: number

Methods

checkAccess

checkAccess(workingCopyId: string, memberOpenId: string, callback: ICallback<boolean>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.checkAccess

Parameters
- workingCopyId: string
- memberOpenId: string
- callback: ICallback<boolean>
- errorCallback: IErrorCallback
Returns void

commitToTeamServer

commitToTeamServer(workingCopyId: string, options: ICommitToTeamServerOptions, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.commitToTeamServer

Parameters
- workingCopyId: string
- options: ICommitToTeamServerOptions
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

createWorkingCopy

createWorkingCopy(workingCopyInfo: ICreateWorkingCopyParameters, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.createWorkingCopy

Parameters
- workingCopyInfo: ICreateWorkingCopyParameters
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void

createWorkingCopyFromTeamServer

createWorkingCopyFromTeamServer(workingCopyInfo: ICreateWorkingCopyFromTeamServerParameters, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.createWorkingCopyFromTeamServer

Parameters
- workingCopyInfo: ICreateWorkingCopyFromTeamServerParameters
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void

deleteFile

deleteFile(workingCopyId: string, filePath: string, callback: ICallback<number>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.deleteFile

Parameters
- workingCopyId: string
- filePath: string
- callback: ICallback<number>
- errorCallback: IErrorCallback
Returns void

deleteWorkingCopy

deleteWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.deleteWorkingCopy

Parameters
- workingCopyId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

deleteWorkingCopyByProject

deleteWorkingCopyByProject(projectId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.deleteWorkingCopyByProject

Deletes the project-to-working copy mapping for given project ID.

Parameters
- projectId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

exportModuleMpk

exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.exportModuleMpk

Parameters
- workingCopyId: string
- moduleId: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

exportMpk

exportMpk(workingCopyId: string, outFilePath: string, callback: ICallback<IExportMpkResponse>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.exportMpk

Parameters
- workingCopyId: string
- outFilePath: string
- callback: ICallback<IExportMpkResponse>
- errorCallback: IErrorCallback
Returns void

filterUnitsByCustomWidgetId

filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string, callback: ICallback<string[]>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void

getFile

getFile(workingCopyId: string, filePath: string, outFilePath: string, callback: ICallback<any>, errorCallback: IErrorCallback): void

Parameters
- workingCopyId: string
- filePath: string
- outFilePath: string
- callback: ICallback<any>
- errorCallback: IErrorCallback
Returns void

getFiles

getFiles(workingCopyId: string, options: IGetFilesOptions, callback: ICallback<any>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.getFiles

Parameters
- workingCopyId: string
- options: IGetFilesOptions
- callback: ICallback<any>
- errorCallback: IErrorCallback
Returns void

getModelEventSource

getModelEventSource(workingCopyId: string, lastEventId: number): EventSource

Implementation of IModelServerClient.getModelEventSource

Parameters
- workingCopyId: string
- lastEventId: number
Returns EventSource

getMyWorkingCopies

getMyWorkingCopies(callback: ICallback<IWorkingCopy[]>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.getMyWorkingCopies

Parameters
- callback: ICallback<IWorkingCopy[]>
- errorCallback: IErrorCallback
Returns void

getWorkingCopyByProject

getWorkingCopyByProject(projectId: string, callback: ICallback<string>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.getWorkingCopyByProject

Parameters
- projectId: string
- callback: ICallback<string>
- errorCallback: IErrorCallback
Returns void

getWorkingCopyEventSource

getWorkingCopyEventSource(workingCopyId: string): EventSource

Implementation of IModelServerClient.getWorkingCopyEventSource

Parameters
- workingCopyId: string
Returns EventSource

grantAccess

grantAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.grantAccess

Parameters
- workingCopyId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

grantAccessByProject

grantAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.grantAccessByProject

Parameters
- projectId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

importModuleMpk

importModuleMpk(workingCopyId: string, mpkPath: string | Blob, callback: ICallback<string>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.importModuleMpk

Parameters
- workingCopyId: string
- mpkPath: string | Blob
- callback: ICallback<string>
- errorCallback: IErrorCallback
Returns void

loadUnitById

loadUnitById(workingCopyId: string, unitId: string, callback: ICallback<ILoadUnitResponse>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.loadUnitById

Parameters
- workingCopyId: string
- unitId: string
- callback: ICallback<ILoadUnitResponse>
- errorCallback: IErrorCallback
Returns void

loadUnitInterfaces

loadUnitInterfaces(workingCopyId: string, callback: ICallback<ILoadUnitInterfacesResponse>, errorCallback: IErrorCallback, rootUnitId?: undefined | string): void

Implementation of IModelServerClient.loadUnitInterfaces

Parameters
- workingCopyId: string
- callback: ICallback<ILoadUnitInterfacesResponse>
- errorCallback: IErrorCallback
- Optional rootUnitId: undefined | string
Returns void

loadWorkingCopyMetaData

loadWorkingCopyMetaData(workingCopyId: string, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.loadWorkingCopyMetaData

Parameters
- workingCopyId: string
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void

lockWorkingCopy

lockWorkingCopy(workingCopyId: string, callback: ICallback<ILockWorkingCopyResponse>, errorCallback: IErrorCallback): void
lockWorkingCopy(workingCopyId: string, lockOptions: ILockWorkingCopyOptions | LockType, callback: ICallback<ILockWorkingCopyResponse>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.lockWorkingCopy

Parameters
- workingCopyId: string
- callback: ICallback<ILockWorkingCopyResponse>
- errorCallback: IErrorCallback
Returns void
Implementation of IModelServerClient.lockWorkingCopy

Parameters
- workingCopyId: string
- lockOptions: ILockWorkingCopyOptions | LockType
- callback: ICallback<ILockWorkingCopyResponse>
- errorCallback: IErrorCallback
Returns void

putFile

putFile(workingCopyId: string, inFilePath: string | Blob, filePath: string, callback: ICallback<number>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.putFile

Parameters
- workingCopyId: string
- inFilePath: string | Blob
- filePath: string
- callback: ICallback<number>
- errorCallback: IErrorCallback
Returns void

revokeAccess

revokeAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.revokeAccess

Parameters
- workingCopyId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

revokeAccessByProject

revokeAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.revokeAccessByProject

Parameters
- projectId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

sendDeltas

sendDeltas(workingCopyId: string, deltas: Delta[], callback: ICallback<ISendDeltasResult>, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.sendDeltas

Parameters
- workingCopyId: string
- deltas: Delta[]
- callback: ICallback<ISendDeltasResult>
- errorCallback: IErrorCallback
Returns void

setProjectMembers

setProjectMembers(projectId: string, memberOpenids: string[], callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.setProjectMembers

Parameters
- projectId: string
- memberOpenids: string[]
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

setWorkingCopyMembers

setWorkingCopyMembers(workingCopyId: string, memberOpenIds: string[], callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.setWorkingCopyMembers

Parameters
- workingCopyId: string
- memberOpenIds: string[]
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

unlockWorkingCopy

unlockWorkingCopy(workingCopyId: string, lockType: LockType | undefined, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.unlockWorkingCopy

Parameters
- workingCopyId: string
- lockType: LockType | undefined
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

updateWorkingCopyByProject

updateWorkingCopyByProject(projectId: string, workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Implementation of IModelServerClient.updateWorkingCopyByProject

Update the project-to-working copy mapping with the given data.

Parameters
- projectId: string
- workingCopyId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

Generated using TypeDoc