Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModelSdkClientImpl<IT, CT>

Client class of the Mendix Model SDK. By instantiating this class with appropriate configuration, you can create and read working copies.

Type parameters

Hierarchy

  • ModelSdkClientImpl

Index

Constructors

constructor

Methods

checkAccess

  • checkAccess(workingCopyId: string, memberOpenId: string, callback: ICallback<boolean>, errorCallback: IErrorCallback): void
  • checkAccess(workingCopyId: string, memberOpenId: string): Promise<boolean>
  • Returns whether the member specified to his/her OpenID has (been granted) access to this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise<boolean>

commitToTeamServer

createAndOpenWorkingCopy

createWorkingCopy

createWorkingCopyFromTeamServer

deleteWorkingCopy

  • deleteWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • deleteWorkingCopy(workingCopyId: string): Promise<void>
  • Deletes this working copy from the server, and the (SDK) client.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise<void>

deleteWorkingCopyByProject

  • deleteWorkingCopyByProject(projectId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • deleteWorkingCopyByProject(projectId: string): Promise<void>
  • Deletes the project-to-working copy mapping for given project ID.

    Parameters

    Returns void

  • Parameters

    • projectId: string

    Returns Promise<void>

exportModuleMpk

  • exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string): Promise<void>
  • Exports the module with the specified ID as MPK.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • moduleId: string
    • outFilePath: string

    Returns Promise<void>

exportMpk

  • exportMpk(workingCopyId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • exportMpk(workingCopyId: string, outFilePath: string): Promise<void>
  • Exports this working copy as MPK.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • outFilePath: string

    Returns Promise<void>

getMyWorkingCopies

  • getMyWorkingCopies(callback: ICallback<IWorkingCopy[]>, errorCallback: IErrorCallback): void
  • getMyWorkingCopies(): Promise<IWorkingCopy[]>
  • Retrieves an array of all working copies you are a member of.

    Parameters

    Returns void

  • Returns Promise<IWorkingCopy[]>

getWorkingCopyByProject

  • getWorkingCopyByProject(projectId: string, callback: ICallback<string>, errorCallback: IErrorCallback): void
  • getWorkingCopyByProject(projectId: string): Promise<string>
  • Retrieves the working copy id that the given project ID maps to.

    Parameters

    Returns void

  • Parameters

    • projectId: string

    Returns Promise<string>

grantAccess

  • grantAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • grantAccess(workingCopyId: string, memberOpenId: string): Promise<void>
  • Grants access to the member specified to his/her OpenID on this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise<void>

grantAccessByProject

  • grantAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • grantAccessByProject(projectId: string, memberOpenId: string): Promise<void>
  • Grants access to the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • memberOpenId: string

    Returns Promise<void>

loadWorkingCopyMetaData

lockWorkingCopy

openWorkingCopy

  • openWorkingCopy(workingCopyId: string, callback: ICallback<IT>, errorCallback: IErrorCallback): void
  • openWorkingCopy(workingCopyId: string): Promise<IT>
  • Reads a working copy on the model server so it can be edited.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise<IT>

revokeAccess

  • revokeAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • revokeAccess(workingCopyId: string, memberOpenId: string): Promise<void>
  • Revokes access of the member specified to his/her OpenID on this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise<void>

revokeAccessByProject

  • revokeAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • revokeAccessByProject(projectId: string, memberOpenId: string): Promise<void>
  • Revokes access of the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • memberOpenId: string

    Returns Promise<void>

setProjectMembers

  • setProjectMembers(projectId: string, memberOpenids: string[], callback: IVoidCallback, errorCallback: IErrorCallback): void
  • setProjectMembers(projectId: string, memberOpenids: string[]): Promise<void>
  • Sets all members that have access specified by their OpenID to the default working copy of this project.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • memberOpenids: string[]

    Returns Promise<void>

unlockWorkingCopy

  • unlockWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • unlockWorkingCopy(workingCopyId: string): Promise<void>
  • unlockWorkingCopy(workingCopyId: string, lockType: LockType, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • unlockWorkingCopy(workingCopyId: string, lockType: LockType): Promise<void>
  • Unlock the working copy (will be unlocked for the currently authenticated openid, will fail if it's locked by another openid).

    Provide a lockType to only unlock the working copy if it is locked with this specific type.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • lockType: LockType

    Returns Promise<void>

updateWorkingCopyByProject

  • updateWorkingCopyByProject(projectId: string, workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • updateWorkingCopyByProject(projectId: string, workingCopyId: string): Promise<void>
  • Update the project-to-working copy mapping with the given data.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • workingCopyId: string

    Returns Promise<void>

Generated using TypeDoc