IModelServerClient | Mendix Model SDK

The IModelServerClient interface is used for forwarding calls to the underlying Mendix Model API. Implementations of this interface serve as fully-typed clients for the Model API Server. Default implementation: ModelServerClientImpl. Note that all its methods are asynchronous, with the last two arguments always being a (success) callback and an error callback, and we will only explain the "essential" arguments in their documentation.

Note: this interface is part of the internal API of the Model SDK.

DISCLAIMER: End-users of the SDK should never rely directly on elements of the internal API, e.g. by implementing interfaces or instantiating classes. Anything in this file can be removed, or change signature, even between patch-level SDK versions.

Hierarchy

IModelServerClient

Implemented by

ModelServerClientImpl

Index

Methods

checkAccess

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

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

commitToTeamServer

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

Commits the contents of the working copy with the given id to the team server

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

createWorkingCopy

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

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

createWorkingCopyFromTeamServer

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

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

deleteFile

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

Deletes the file with the specified filepath.

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

deleteWorkingCopy

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

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

deleteWorkingCopyByProject

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

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

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

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

filterUnitsByCustomWidgetId

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

Returns a list of unitIds that contains a specific custom widget

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

getFile

getFile(workingCopyId: string, filePath: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

Downloads the file specified by the supplied filepath.

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

getFiles

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

Returns an array of all filepaths in the working copy.

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

getModelEventSource

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

Returns an EventSource instance that will emit events that occur on the working copy model.

Parameters
- workingCopyId: string
- lastFetchedEventId: number
Returns EventSource

getMyWorkingCopies

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

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

getWorkingCopyByProject

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

Retrieves the working copy id that the given project ID maps to.

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

getWorkingCopyEventSource

getWorkingCopyEventSource(workingCopyId: string): EventSource

Returns an EventSource instance that will emit events that occur on the working copy level.

Parameters
- workingCopyId: string
Returns EventSource

grantAccess

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

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

grantAccessByProject

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

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

importModuleMpk

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

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

Retrieves a unit, as normalized model JSON, by working copy and unit ID.

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

Loads all unit interfaces of the working copy indicated with workingCopyId as an array of normalized model JSON.

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

loadWorkingCopyMetaData

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

Retrieves the top-level working copy information/meta data for the working copy with given workingCopyId.

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

Lock the working copy (will be locked for the currently authenticated openid)

Parameters
- workingCopyId: string
- callback: ICallback<ILockWorkingCopyResponse>
- errorCallback: IErrorCallback
Returns void
Lock the working copy with lockOptions (will be locked for the currently authenticated openid)

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

Uploads the supplied file to the specified filepath.

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

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

revokeAccessByProject

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

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

sendDeltas

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

Sends a sequence of deltas on the working copy with the given workingCopyId to the Model API Server; batched if more than one is passed, as a single delta otherwise.

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

setProjectMembers

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

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

setWorkingCopyMembers

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

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

unlockWorkingCopy

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

Unlock the working copy (will be unlocked for the currently authenticated openid, will fail if it's locked by another openid)

Parameters
- workingCopyId: string
- lockType: LockType | undefined
  
  if specified, only unlock if the working copy has this specified lock
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void

updateWorkingCopyByProject

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

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

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

Hierarchy

Implemented by

Index

Methods

Methods

checkAccess

Parameters

workingCopyId: string

memberOpenId: string

callback: ICallback<boolean>

errorCallback: IErrorCallback

Returns void

commitToTeamServer

Parameters

workingCopyId: string

options: ICommitToTeamServerOptions

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void

createWorkingCopy

Parameters

workingCopyInfo: ICreateWorkingCopyParameters

callback: ICallback<IWorkingCopy>

errorCallback: IErrorCallback

Returns void

createWorkingCopyFromTeamServer

Parameters

workingCopyInfo: ICreateWorkingCopyFromTeamServerParameters

callback: ICallback<IWorkingCopy>

errorCallback: IErrorCallback

Returns void

deleteFile

Parameters

workingCopyId: string

filePath: string

callback: ICallback<number>

errorCallback: IErrorCallback

Returns void

deleteWorkingCopy

Parameters

workingCopyId: string

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void

deleteWorkingCopyByProject

Parameters

projectId: string

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void

exportModuleMpk

Parameters

workingCopyId: string

moduleId: string

outFilePath: string

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void

exportMpk

Parameters

workingCopyId: string

outFilePath: string

callback: ICallback<IExportMpkResponse>

errorCallback: IErrorCallback

Returns void

filterUnitsByCustomWidgetId

Parameters

workingCopyId: string

widgetId: string

callback: ICallback<string[]>

errorCallback: IErrorCallback

Returns void

getFile

Parameters

workingCopyId: string

filePath: string

outFilePath: string

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void