Options
All
  • Public
  • Public/Protected
  • All
Menu

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: {@link 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

Index

Methods

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

    Returns void

  • deleteFile(workingCopyId: string, filePath: string, callback: ICallback<number>, errorCallback: IErrorCallback): void
  • Deletes the file with the specified filepath.

    Parameters

    Returns void

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

    Parameters

    Returns void

  • exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • 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

  • Downloads the file specified by the supplied filepath.

    Parameters

    Returns void

  • 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

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

    Parameters

    Returns void

  • getWorkingCopyEventSource(workingCopyId: string): EventSource
  • Returns an EventSource instance that will emit events that occur on the working copy level.

    Parameters

    • workingCopyId: string

    Returns EventSource

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

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    Returns void

  • 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

  • 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

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

    Parameters

    Returns void

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

    Parameters

    Returns void

Generated using TypeDoc