Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IModelServerClient

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

Index

Methods

checkAccess

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

    Returns void

commitToTeamServer

createWorkingCopy

createWorkingCopyFromTeamServer

deleteFile

  • Deletes the file with the specified filepath.

    Parameters

    Returns void

deleteWorkingCopy

deleteWorkingCopyByProject

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

    Parameters

    Returns void

exportModuleMpk

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

    Returns void

exportMpk

filterUnitsByCustomWidgetId

  • filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string, callback: ICallback<string[]>, errorCallback: IErrorCallback): void
  • Returns a list of unitIds that contains a specific custom widget

    Parameters

    Returns void

getAppEnvironmentStatus

getAppEnvironmentStatusV2

getAppUpdateStatus

getFile

  • Downloads the file specified by the supplied filepath.

    Parameters

    Returns void

getFiles

getModelEventSource

  • getModelEventSource(workingCopyId: string, lastFetchedEventId: number): EventSource
  • Returns an EventSource instance that will emit events that occur on the working copy.

    Parameters

    • workingCopyId: string
    • lastFetchedEventId: number

    Returns EventSource

getMyWorkingCopies

getWorkingCopyByProject

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

    Parameters

    Returns void

grantAccess

grantAccessByProject

importModuleMpk

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

    Returns void

loadUnitById

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

    Parameters

    Returns void

loadUnitInterfaces

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

    Parameters

    Returns void

loadWorkingCopyMetaData

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

    Parameters

    Returns void

lockWorkingCopy

putFile

  • putFile(workingCopyId: string, inFilePath: string | Blob, filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • Uploads the supplied file to the specified filepath.

    Parameters

    Returns void

revokeAccess

revokeAccessByProject

sendDeltas

  • 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

    Returns void

startAppUpdate

unlockWorkingCopy

  • 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

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

    Parameters

    Returns void

Generated using TypeDoc