Class Model

Implementation of IModel.

Hierarchy

BaseModel

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Model(_client: IModelServerClient, _errorHandler: IErrorCallback): Model

Inherited from AbstractModel.constructor

Parameters
- _client: IModelServerClient
- _errorHandler: IErrorCallback
Returns Model

Properties

id

id: string

metaModelVersion

metaModelVersion: Version

mxVersionForModel

mxVersionForModel: Version

root

Returns the structural unit of type "Projects$Project" which is the project's root, cast to the appropriate type.

workingCopy

workingCopy: IWorkingCopy

Methods

allBuildingBlocks

allBuildingBlocks(): IBuildingBlock[]

Implementation of IModel.allBuildingBlocks

Inherited from BaseModel.allBuildingBlocks

Returns IBuildingBlock[]

allCodeActions

allCodeActions(): ICodeAction[]

Implementation of IModel.allCodeActions

Inherited from BaseModel.allCodeActions

Returns ICodeAction[]

allConstants

allConstants(): IConstant[]

Implementation of IModel.allConstants

Inherited from BaseModel.allConstants

Returns IConstant[]

allConsumedAppServices

allConsumedAppServices(): IConsumedAppService[]

Implementation of IModel.allConsumedAppServices

Inherited from BaseModel.allConsumedAppServices

Returns IConsumedAppService[]

allConsumedODataServices

allConsumedODataServices(): IConsumedODataService[]

Implementation of IModel.allConsumedODataServices

Inherited from BaseModel.allConsumedODataServices

Returns IConsumedODataService[]

allDataSets

allDataSets(): IDataSet[]

Implementation of IModel.allDataSets

Inherited from BaseModel.allDataSets

Returns IDataSet[]

allDocumentTemplates

allDocumentTemplates(): IDocumentTemplate[]

Implementation of IModel.allDocumentTemplates

Inherited from BaseModel.allDocumentTemplates

Returns IDocumentTemplate[]

allDocuments

allDocuments(): IDocument[]

Implementation of IModel.allDocuments

Inherited from BaseModel.allDocuments

Returns IDocument[]

allDomainModels

allDomainModels(): IDomainModel[]

Implementation of IModel.allDomainModels

Inherited from BaseModel.allDomainModels

Returns IDomainModel[]

allEnumerations

allEnumerations(): IEnumeration[]

Implementation of IModel.allEnumerations

Inherited from BaseModel.allEnumerations

Returns IEnumeration[]

allExportMappings

allExportMappings(): IExportMapping[]

Implementation of IModel.allExportMappings

Inherited from BaseModel.allExportMappings

Returns IExportMapping[]

allFolderBases

allFolderBases(): IFolderBase[]

Implementation of IModel.allFolderBases

Inherited from BaseModel.allFolderBases

Returns IFolderBase[]

allFolders

allFolders(): IFolder[]

Implementation of IModel.allFolders

Inherited from BaseModel.allFolders

Returns IFolder[]

allFormBases

allFormBases(): IFormBase[]

Implementation of IModel.allFormBases

Inherited from BaseModel.allFormBases

Returns IFormBase[]

allImageCollections

allImageCollections(): IImageCollection[]

Implementation of IModel.allImageCollections

Inherited from BaseModel.allImageCollections

Returns IImageCollection[]

allImportMappings

allImportMappings(): IImportMapping[]

Implementation of IModel.allImportMappings

Inherited from BaseModel.allImportMappings

Returns IImportMapping[]

allImportedWebServices

allImportedWebServices(): IImportedWebService[]

Implementation of IModel.allImportedWebServices

Inherited from BaseModel.allImportedWebServices

Returns IImportedWebService[]

allJavaActions

allJavaActions(): IJavaAction[]

Implementation of IModel.allJavaActions

Inherited from BaseModel.allJavaActions

Returns IJavaAction[]

allJavaScriptActions

allJavaScriptActions(): IJavaScriptAction[]

Implementation of IModel.allJavaScriptActions

Inherited from BaseModel.allJavaScriptActions

Returns IJavaScriptAction[]

allJsonStructures

allJsonStructures(): IJsonStructure[]

Implementation of IModel.allJsonStructures

Inherited from BaseModel.allJsonStructures

Returns IJsonStructure[]

allLayouts

allLayouts(): ILayout[]

Implementation of IModel.allLayouts

Inherited from BaseModel.allLayouts

Returns ILayout[]

allMappingDocuments

allMappingDocuments(): IMappingDocument[]

Implementation of IModel.allMappingDocuments

Inherited from BaseModel.allMappingDocuments

Returns IMappingDocument[]

allMenuDocuments

allMenuDocuments(): IMenuDocument[]

Implementation of IModel.allMenuDocuments

Inherited from BaseModel.allMenuDocuments

Returns IMenuDocument[]

allMessageDefinitionCollections

allMessageDefinitionCollections(): IMessageDefinitionCollection[]

Implementation of IModel.allMessageDefinitionCollections

Inherited from BaseModel.allMessageDefinitionCollections

Returns IMessageDefinitionCollection[]

allMicroflowBases

allMicroflowBases(): IMicroflowBase[]

Implementation of IModel.allMicroflowBases

Inherited from BaseModel.allMicroflowBases

Returns IMicroflowBase[]

allMicroflows

allMicroflows(): IMicroflow[]

Implementation of IModel.allMicroflows

Inherited from BaseModel.allMicroflows

Returns IMicroflow[]

allModuleDocuments

allModuleDocuments(): IModuleDocument[]

Implementation of IModel.allModuleDocuments

Inherited from BaseModel.allModuleDocuments

Returns IModuleDocument[]

allModuleSecurities

allModuleSecurities(): IModuleSecurity[]

Implementation of IModel.allModuleSecurities

Inherited from BaseModel.allModuleSecurities

Returns IModuleSecurity[]

allModules

allModules(): IModule[]

Implementation of IModel.allModules

Inherited from BaseModel.allModules

Returns IModule[]

allMxSchemas

allMxSchemas(): IMxSchema[]

Implementation of IModel.allMxSchemas

Inherited from BaseModel.allMxSchemas

Returns IMxSchema[]

allNanoflows

allNanoflows(): INanoflow[]

Implementation of IModel.allNanoflows

Inherited from BaseModel.allNanoflows

Returns INanoflow[]

allNativeLayouts

allNativeLayouts(): INativeLayout[]

Implementation of IModel.allNativeLayouts

Inherited from BaseModel.allNativeLayouts

Returns INativeLayout[]

allNativePages

allNativePages(): INativePage[]

Implementation of IModel.allNativePages

Inherited from BaseModel.allNativePages

Returns INativePage[]

allNavigationDocuments

allNavigationDocuments(): INavigationDocument[]

Implementation of IModel.allNavigationDocuments

Inherited from BaseModel.allNavigationDocuments

Returns INavigationDocument[]

allPageTemplates

allPageTemplates(): IPageTemplate[]

Implementation of IModel.allPageTemplates

Inherited from BaseModel.allPageTemplates

Returns IPageTemplate[]

allPages

allPages(): IPage[]

Implementation of IModel.allPages

Inherited from BaseModel.allPages

Returns IPage[]

allProjectConversions

allProjectConversions(): IProjectConversion[]

Implementation of IModel.allProjectConversions

Inherited from BaseModel.allProjectConversions

Returns IProjectConversion[]

allProjectDocuments

allProjectDocuments(): IProjectDocument[]

Implementation of IModel.allProjectDocuments

Inherited from BaseModel.allProjectDocuments

Returns IProjectDocument[]

allProjectSecurities

allProjectSecurities(): IProjectSecurity[]

Implementation of IModel.allProjectSecurities

Inherited from BaseModel.allProjectSecurities

Returns IProjectSecurity[]

allProjectSettings

allProjectSettings(): IProjectSettings[]

Implementation of IModel.allProjectSettings

Inherited from BaseModel.allProjectSettings

Returns IProjectSettings[]

allProjects

allProjects(): IProject[]

Implementation of IModel.allProjects

Inherited from BaseModel.allProjects

Returns IProject[]

allPublishedAppServices

allPublishedAppServices(): IPublishedAppService[]

Implementation of IModel.allPublishedAppServices

Inherited from BaseModel.allPublishedAppServices

Returns IPublishedAppService[]

allPublishedODataServices

allPublishedODataServices(): IPublishedODataService[]

Implementation of IModel.allPublishedODataServices

Inherited from BaseModel.allPublishedODataServices

Returns IPublishedODataService[]

allPublishedRestServices

allPublishedRestServices(): IPublishedRestService[]

Implementation of IModel.allPublishedRestServices

Inherited from BaseModel.allPublishedRestServices

Returns IPublishedRestService[]

allPublishedServiceBases

allPublishedServiceBases(): IPublishedServiceBase[]

Implementation of IModel.allPublishedServiceBases

Inherited from BaseModel.allPublishedServiceBases

Returns IPublishedServiceBase[]

allPublishedWebServices

allPublishedWebServices(): IPublishedWebService[]

Implementation of IModel.allPublishedWebServices

Inherited from BaseModel.allPublishedWebServices

Returns IPublishedWebService[]

allRegularExpressions

allRegularExpressions(): IRegularExpression[]

Implementation of IModel.allRegularExpressions

Inherited from BaseModel.allRegularExpressions

Returns IRegularExpression[]

allRules

allRules(): IRule[]

Implementation of IModel.allRules

Inherited from BaseModel.allRules

Returns IRule[]

allScheduledEvents

allScheduledEvents(): IScheduledEvent[]

Implementation of IModel.allScheduledEvents

Inherited from BaseModel.allScheduledEvents

Returns IScheduledEvent[]

allServerSideMicroflows

allServerSideMicroflows(): IServerSideMicroflow[]

Implementation of IModel.allServerSideMicroflows

Inherited from BaseModel.allServerSideMicroflows

Returns IServerSideMicroflow[]

allSnippets

allSnippets(): ISnippet[]

Implementation of IModel.allSnippets

Inherited from BaseModel.allSnippets

Returns ISnippet[]

allSystemTextCollections

allSystemTextCollections(): ISystemTextCollection[]

Implementation of IModel.allSystemTextCollections

Inherited from BaseModel.allSystemTextCollections

Returns ISystemTextCollection[]

allTemplateFormBases

allTemplateFormBases(): ITemplateFormBase[]

Implementation of IModel.allTemplateFormBases

Inherited from BaseModel.allTemplateFormBases

Returns ITemplateFormBase[]

allUnits

allUnits(): IAbstractUnit[]

Implementation of IModel.allUnits

Inherited from AbstractModel.allUnits

Returns a defensive collection of all units in this model.

Returns IAbstractUnit[]

allXmlSchemas

allXmlSchemas(): IXmlSchema[]

Implementation of IModel.allXmlSchemas

Inherited from BaseModel.allXmlSchemas

Returns IXmlSchema[]

closeConnection

closeConnection(callback: IVoidCallback, errorCallback?: IErrorCallback): void
closeConnection(): Promise

Implementation of IModel.closeConnection

Inherited from AbstractModel.closeConnection

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.closeConnection

Inherited from AbstractModel.closeConnection

Returns Promise

deleteFile

deleteFile(filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
deleteFile(filePath: string): Promise

Implementation of IModel.deleteFile

Inherited from AbstractModel.deleteFile

Parameters
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.deleteFile

Inherited from AbstractModel.deleteFile

Parameters
- filePath: string
Returns Promise

deleteWorkingCopy

deleteWorkingCopy(callback: IVoidCallback, errorCallback?: IErrorCallback): void
deleteWorkingCopy(): Promise

Implementation of IModel.deleteWorkingCopy

Inherited from AbstractModel.deleteWorkingCopy

Deletes this working copy from the server, and the (SDK) client.

Parameters
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.deleteWorkingCopy

Inherited from AbstractModel.deleteWorkingCopy

Returns Promise

exportModuleMpk

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

Implementation of IModel.exportModuleMpk

Inherited from AbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.exportModuleMpk

Inherited from AbstractModel.exportModuleMpk

Parameters
- moduleId: string
- outFilePath: string
Returns Promise

exportMpk

exportMpk(outFilePath: string, callback: IVoidCallback, errorCallback?: IErrorCallback): void
exportMpk(outFilePath: string): Promise

Implementation of IModel.exportMpk

Inherited from AbstractModel.exportMpk

Parameters
- outFilePath: string
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.exportMpk

Inherited from AbstractModel.exportMpk

Parameters
- outFilePath: string
Returns Promise

filterUnitsByCustomWidgetId

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

Implementation of IModel.filterUnitsByCustomWidgetId

Inherited from AbstractModel.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.filterUnitsByCustomWidgetId

Inherited from AbstractModel.filterUnitsByCustomWidgetId

Parameters
- workingCopyId: string
- widgetId: string
Returns Promise

findAppServiceActionByQualifiedName

findAppServiceActionByQualifiedName(qname: string): IAppServiceAction

Implementation of IModel.findAppServiceActionByQualifiedName

Inherited from BaseModel.findAppServiceActionByQualifiedName

Parameters
- qname: string
Returns IAppServiceAction

findAppServiceActionParameterByQualifiedName

findAppServiceActionParameterByQualifiedName(qname: string): IAppServiceActionParameter

Implementation of IModel.findAppServiceActionParameterByQualifiedName

Inherited from BaseModel.findAppServiceActionParameterByQualifiedName

Parameters
- qname: string
Returns IAppServiceActionParameter

findAssociationBaseByQualifiedName

findAssociationBaseByQualifiedName(qname: string): IAssociationBase

Implementation of IModel.findAssociationBaseByQualifiedName

Inherited from BaseModel.findAssociationBaseByQualifiedName

Parameters
- qname: string
Returns IAssociationBase

findAttributeByQualifiedName

findAttributeByQualifiedName(qname: string): IAttribute

Implementation of IModel.findAttributeByQualifiedName

Inherited from BaseModel.findAttributeByQualifiedName

Parameters
- qname: string
Returns IAttribute

findConstantByQualifiedName

findConstantByQualifiedName(qname: string): IConstant

Implementation of IModel.findConstantByQualifiedName

Inherited from BaseModel.findConstantByQualifiedName

Parameters
- qname: string
Returns IConstant

findDataSetByQualifiedName

findDataSetByQualifiedName(qname: string): IDataSet

Implementation of IModel.findDataSetByQualifiedName

Inherited from BaseModel.findDataSetByQualifiedName

Parameters
- qname: string
Returns IDataSet

findDataSetParameterByQualifiedName

findDataSetParameterByQualifiedName(qname: string): IDataSetParameter

Implementation of IModel.findDataSetParameterByQualifiedName

Inherited from BaseModel.findDataSetParameterByQualifiedName

Parameters
- qname: string
Returns IDataSetParameter

findDocumentTemplateByQualifiedName

findDocumentTemplateByQualifiedName(qname: string): IDocumentTemplate

Implementation of IModel.findDocumentTemplateByQualifiedName

Inherited from BaseModel.findDocumentTemplateByQualifiedName

Parameters
- qname: string
Returns IDocumentTemplate

findEntityByQualifiedName

findEntityByQualifiedName(qname: string): IEntity

Implementation of IModel.findEntityByQualifiedName

Inherited from BaseModel.findEntityByQualifiedName

Parameters
- qname: string
Returns IEntity

findEnumerationByQualifiedName

findEnumerationByQualifiedName(qname: string): IEnumeration

Implementation of IModel.findEnumerationByQualifiedName

Inherited from BaseModel.findEnumerationByQualifiedName

Parameters
- qname: string
Returns IEnumeration

findEnumerationValueByQualifiedName

findEnumerationValueByQualifiedName(qname: string): IEnumerationValue

Implementation of IModel.findEnumerationValueByQualifiedName

Inherited from BaseModel.findEnumerationValueByQualifiedName

Parameters
- qname: string
Returns IEnumerationValue

findExportMappingByQualifiedName

findExportMappingByQualifiedName(qname: string): IExportMapping

Implementation of IModel.findExportMappingByQualifiedName

Inherited from BaseModel.findExportMappingByQualifiedName

Parameters
- qname: string
Returns IExportMapping

findImageByQualifiedName

findImageByQualifiedName(qname: string): IImage

Implementation of IModel.findImageByQualifiedName

Inherited from BaseModel.findImageByQualifiedName

Parameters
- qname: string
Returns IImage

findImportMappingByQualifiedName

findImportMappingByQualifiedName(qname: string): IImportMapping

Implementation of IModel.findImportMappingByQualifiedName

Inherited from BaseModel.findImportMappingByQualifiedName

Parameters
- qname: string
Returns IImportMapping

findImportedWebServiceByQualifiedName

findImportedWebServiceByQualifiedName(qname: string): IImportedWebService

Implementation of IModel.findImportedWebServiceByQualifiedName

Inherited from BaseModel.findImportedWebServiceByQualifiedName

Parameters
- qname: string
Returns IImportedWebService

findJavaActionByQualifiedName

findJavaActionByQualifiedName(qname: string): IJavaAction

Implementation of IModel.findJavaActionByQualifiedName

Inherited from BaseModel.findJavaActionByQualifiedName

Parameters
- qname: string
Returns IJavaAction

findJavaActionParameterByQualifiedName

findJavaActionParameterByQualifiedName(qname: string): IJavaActionParameter

Implementation of IModel.findJavaActionParameterByQualifiedName

Inherited from BaseModel.findJavaActionParameterByQualifiedName

Parameters
- qname: string
Returns IJavaActionParameter

findJavaScriptActionByQualifiedName

findJavaScriptActionByQualifiedName(qname: string): IJavaScriptAction

Implementation of IModel.findJavaScriptActionByQualifiedName

Inherited from BaseModel.findJavaScriptActionByQualifiedName

Parameters
- qname: string
Returns IJavaScriptAction

findJavaScriptActionParameterByQualifiedName

findJavaScriptActionParameterByQualifiedName(qname: string): IJavaScriptActionParameter

Implementation of IModel.findJavaScriptActionParameterByQualifiedName

Inherited from BaseModel.findJavaScriptActionParameterByQualifiedName

Parameters
- qname: string
Returns IJavaScriptActionParameter

findJsonStructureByQualifiedName

findJsonStructureByQualifiedName(qname: string): IJsonStructure

Implementation of IModel.findJsonStructureByQualifiedName

Inherited from BaseModel.findJsonStructureByQualifiedName

Parameters
- qname: string
Returns IJsonStructure

findLayoutByQualifiedName

findLayoutByQualifiedName(qname: string): ILayout

Implementation of IModel.findLayoutByQualifiedName

Inherited from BaseModel.findLayoutByQualifiedName

Parameters
- qname: string
Returns ILayout

findLayoutParameterByQualifiedName

findLayoutParameterByQualifiedName(qname: string): ILayoutParameter

Implementation of IModel.findLayoutParameterByQualifiedName

Inherited from BaseModel.findLayoutParameterByQualifiedName

Parameters
- qname: string
Returns ILayoutParameter

findMenuDocumentByQualifiedName

findMenuDocumentByQualifiedName(qname: string): IMenuDocument

Implementation of IModel.findMenuDocumentByQualifiedName

Inherited from BaseModel.findMenuDocumentByQualifiedName

Parameters
- qname: string
Returns IMenuDocument

findMessageDefinitionByQualifiedName

findMessageDefinitionByQualifiedName(qname: string): IMessageDefinition

Implementation of IModel.findMessageDefinitionByQualifiedName

Inherited from BaseModel.findMessageDefinitionByQualifiedName

Parameters
- qname: string
Returns IMessageDefinition

findMicroflowByQualifiedName

findMicroflowByQualifiedName(qname: string): IMicroflow

Implementation of IModel.findMicroflowByQualifiedName

Inherited from BaseModel.findMicroflowByQualifiedName

Parameters
- qname: string
Returns IMicroflow

findMicroflowParameterByQualifiedName

findMicroflowParameterByQualifiedName(qname: string): IMicroflowParameter

Implementation of IModel.findMicroflowParameterByQualifiedName

Inherited from BaseModel.findMicroflowParameterByQualifiedName

Parameters
- qname: string
Returns IMicroflowParameter

findModuleByQualifiedName

findModuleByQualifiedName(qname: string): IModule | null

Implementation of IModel.findModuleByQualifiedName

Parameters
- qname: string
Returns IModule | null

findModuleRoleByQualifiedName

findModuleRoleByQualifiedName(qname: string): IModuleRole

Implementation of IModel.findModuleRoleByQualifiedName

Inherited from BaseModel.findModuleRoleByQualifiedName

Parameters
- qname: string
Returns IModuleRole

findNanoflowByQualifiedName

findNanoflowByQualifiedName(qname: string): INanoflow

Implementation of IModel.findNanoflowByQualifiedName

Inherited from BaseModel.findNanoflowByQualifiedName

Parameters
- qname: string
Returns INanoflow

findNanoflowParameterByQualifiedName

findNanoflowParameterByQualifiedName(qname: string): INanoflowParameter

Implementation of IModel.findNanoflowParameterByQualifiedName

Inherited from BaseModel.findNanoflowParameterByQualifiedName

Parameters
- qname: string
Returns INanoflowParameter

findNativeLayoutByQualifiedName

findNativeLayoutByQualifiedName(qname: string): INativeLayout

Implementation of IModel.findNativeLayoutByQualifiedName

Inherited from BaseModel.findNativeLayoutByQualifiedName

Parameters
- qname: string
Returns INativeLayout

findNativeLayoutParameterByQualifiedName

findNativeLayoutParameterByQualifiedName(qname: string): INativeLayoutParameter

Implementation of IModel.findNativeLayoutParameterByQualifiedName

Inherited from BaseModel.findNativeLayoutParameterByQualifiedName

Parameters
- qname: string
Returns INativeLayoutParameter

findNativePageByQualifiedName

findNativePageByQualifiedName(qname: string): INativePage

Implementation of IModel.findNativePageByQualifiedName

Inherited from BaseModel.findNativePageByQualifiedName

Parameters
- qname: string
Returns INativePage

findNavigationProfileByQualifiedName

findNavigationProfileByQualifiedName(qname: string): INavigationProfile

Implementation of IModel.findNavigationProfileByQualifiedName

Inherited from BaseModel.findNavigationProfileByQualifiedName

Parameters
- qname: string
Returns INavigationProfile

findPageByQualifiedName

findPageByQualifiedName(qname: string): IPage

Implementation of IModel.findPageByQualifiedName

Inherited from BaseModel.findPageByQualifiedName

Parameters
- qname: string
Returns IPage

findRegularExpressionByQualifiedName

findRegularExpressionByQualifiedName(qname: string): IRegularExpression

Implementation of IModel.findRegularExpressionByQualifiedName

Inherited from BaseModel.findRegularExpressionByQualifiedName

Parameters
- qname: string
Returns IRegularExpression

findRuleByQualifiedName

findRuleByQualifiedName(qname: string): IRule

Implementation of IModel.findRuleByQualifiedName

Inherited from BaseModel.findRuleByQualifiedName

Parameters
- qname: string
Returns IRule

findRuleParameterByQualifiedName

findRuleParameterByQualifiedName(qname: string): IRuleParameter

Implementation of IModel.findRuleParameterByQualifiedName

Inherited from BaseModel.findRuleParameterByQualifiedName

Parameters
- qname: string
Returns IRuleParameter

findSnippetByQualifiedName

findSnippetByQualifiedName(qname: string): ISnippet

Implementation of IModel.findSnippetByQualifiedName

Inherited from BaseModel.findSnippetByQualifiedName

Parameters
- qname: string
Returns ISnippet

findUserRoleByQualifiedName

findUserRoleByQualifiedName(qname: string): IUserRole

Implementation of IModel.findUserRoleByQualifiedName

Inherited from BaseModel.findUserRoleByQualifiedName

Parameters
- qname: string
Returns IUserRole

findXmlSchemaByQualifiedName

findXmlSchemaByQualifiedName(qname: string): IXmlSchema

Implementation of IModel.findXmlSchemaByQualifiedName

Inherited from BaseModel.findXmlSchemaByQualifiedName

Parameters
- qname: string
Returns IXmlSchema

getAppEnvironmentStatus

getAppEnvironmentStatus(callback: ICallback<IEnvironmentStatus>, errorCallback: IErrorCallback): void
getAppEnvironmentStatus(): Promise

Implementation of IModel.getAppEnvironmentStatus

Inherited from AbstractModel.getAppEnvironmentStatus

Parameters
- callback: ICallback<IEnvironmentStatus>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getAppEnvironmentStatus

Inherited from AbstractModel.getAppEnvironmentStatus

Returns Promise

getAppEnvironmentStatusV2

getAppEnvironmentStatusV2(callback: ICallback<IEnvironmentStatus>, errorCallback: IErrorCallback): void
getAppEnvironmentStatusV2(): Promise

Implementation of IModel.getAppEnvironmentStatusV2

Inherited from AbstractModel.getAppEnvironmentStatusV2

Parameters
- callback: ICallback<IEnvironmentStatus>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getAppEnvironmentStatusV2

Inherited from AbstractModel.getAppEnvironmentStatusV2

Returns Promise

getAppUpdateStatus

getAppUpdateStatus(jobId: string, callback: ICallback<IDeployJobStatus>, errorCallback: IErrorCallback): void
getAppUpdateStatus(jobId: string): Promise

Implementation of IModel.getAppUpdateStatus

Inherited from AbstractModel.getAppUpdateStatus

Parameters
- jobId: string
- callback: ICallback<IDeployJobStatus>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getAppUpdateStatus

Inherited from AbstractModel.getAppUpdateStatus

Parameters
- jobId: string
Returns Promise

getFile

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

Inherited from AbstractModel.getFile

Parameters
- filePath: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFile

Inherited from AbstractModel.getFile

Parameters
- filePath: string
- outFilePath: string
Returns Promise

getFilePaths

getFilePaths(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
getFilePaths(): Promise

Implementation of IModel.getFilePaths

Inherited from AbstractModel.getFilePaths

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFilePaths

Inherited from AbstractModel.getFilePaths

Returns Promise

getFiles

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

Inherited from AbstractModel.getFiles

Parameters
- callback: ICallback<string[]>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFiles

Inherited from AbstractModel.getFiles

Returns Promise
Inherited from AbstractModel.getFiles

Parameters
- options: IGetFilesOptions
- callback: ICallback<string[] | any>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.getFiles

Inherited from AbstractModel.getFiles

Parameters
- options: IGetFilesOptions
Returns Promise

handleError

handleError(message: string, errorCallback: IErrorCallback | undefined): void

Inherited from AbstractModel.handleError

Parameters
- message: string
- errorCallback: IErrorCallback | undefined
Returns void

importModuleMpk

importModuleMpk(mpkPath: string | Blob, callback: IVoidCallback, errorCallback?: IErrorCallback): void
importModuleMpk(mpkPath: string | Blob): Promise

Implementation of IModel.importModuleMpk

Inherited from AbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
- callback: IVoidCallback
- Optional errorCallback: IErrorCallback
Returns void
Implementation of IModel.importModuleMpk

Inherited from AbstractModel.importModuleMpk

Parameters
- mpkPath: string | Blob
Returns Promise

loadUnitById

loadUnitById<T>(id: string, forceRefresh: boolean | undefined, callback: ICallback<T>, errorCallback?: IErrorCallback): void
loadUnitById<T>(id: string, forceRefresh: boolean | undefined): Promise

Inherited from AbstractModel.loadUnitById

Fetches a complete unit. The result might be returned from the cache.

Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
- callback: ICallback<T>
- Optional errorCallback: IErrorCallback
Returns void
Inherited from AbstractModel.loadUnitById

Type parameters
- T: IAbstractUnit
Parameters
- id: string
- forceRefresh: boolean | undefined
Returns Promise

onEventProcessed

onEventProcessed(callback: IVoidCallback): void

Implementation of IModel.onEventProcessed

Inherited from AbstractModel.onEventProcessed

Parameters
- callback: IVoidCallback
Returns void

putFile

putFile(inFilePath: string | Blob, filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
putFile(inFilePath: string | Blob, filePath: string): Promise

Implementation of IModel.putFile

Inherited from AbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.putFile

Inherited from AbstractModel.putFile

Parameters
- inFilePath: string | Blob
- filePath: string
Returns Promise

setErrorHandler

setErrorHandler(callback: IErrorCallback): void

Implementation of IModel.setErrorHandler

Inherited from AbstractModel.setErrorHandler

Parameters
- callback: IErrorCallback
Returns void

startAppUpdate

startAppUpdate(callback: ICallback<IDeployJobStatus>, errorCallback: IErrorCallback): void
startAppUpdate(): Promise

Implementation of IModel.startAppUpdate

Inherited from AbstractModel.startAppUpdate

Parameters
- callback: ICallback<IDeployJobStatus>
- errorCallback: IErrorCallback
Returns void
Implementation of IModel.startAppUpdate

Inherited from AbstractModel.startAppUpdate

Returns Promise

startReceivingEvents

startReceivingEvents(): void

Implementation of IModel.startReceivingEvents

Inherited from AbstractModel.startReceivingEvents

Returns void

stopReceivingEvents

stopReceivingEvents(): void

Implementation of IModel.stopReceivingEvents

Inherited from AbstractModel.stopReceivingEvents

Returns void

Static createSdkClient

createSdkClient(connectionConfig: ISdkConfig): ModelSdkClientImpl<IModel, Model>

Parameters
- connectionConfig: ISdkConfig
Returns ModelSdkClientImpl<IModel, Model>

Generated using TypeDoc