DialogService | catavolt-sdk

Hierarchy

DialogService

Index

Properties

Static Private ATTACHMENT_PATH

ATTACHMENT_PATH: string = "upload/path"

Static Private EDITOR_SERVICE_NAME

EDITOR_SERVICE_NAME: string = "EditorService"

Static Private EDITOR_SERVICE_PATH

EDITOR_SERVICE_PATH: string = 'soi-json-v02/' + DialogService.EDITOR_SERVICE_NAME

Static Private QUERY_SERVICE_NAME

QUERY_SERVICE_NAME: string = "QueryService"

Static Private QUERY_SERVICE_PATH

QUERY_SERVICE_PATH: string = 'soi-json-v02/' + DialogService.QUERY_SERVICE_NAME

Methods

Static addAttachment

addAttachment(dialogHandle: DialogHandle, attachment: Attachment, sessionContext: SessionContext): Future<void>

- Defined in catavolt/dialog.ts:4821
Parameters
- dialogHandle: DialogHandle
- attachment: Attachment
- sessionContext: SessionContext
Returns Future<void>

Static changePaneMode

changePaneMode(dialogHandle: DialogHandle, paneMode: PaneMode, sessionContext: SessionContext): Future<XChangePaneModeResult>

- Defined in catavolt/dialog.ts:4837
Parameters
- dialogHandle: DialogHandle
- paneMode: PaneMode
- sessionContext: SessionContext
Returns Future<XChangePaneModeResult>

Static closeEditorModel

closeEditorModel(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<VoidResult>

- Defined in catavolt/dialog.ts:4852
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<VoidResult>

Static getActiveColumnDefs

getActiveColumnDefs(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<XGetActiveColumnDefsResult>

- Defined in catavolt/dialog.ts:4879
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<XGetActiveColumnDefsResult>

Static getAvailableEditorViewDescs

getAvailableEditorViewDescs(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<XGetAvailableViewDescsResult>

- Defined in catavolt/dialog.ts:4892
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<XGetAvailableViewDescsResult>

Static getAvailableQueryViewDescs

getAvailableQueryViewDescs(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<XGetAvailableViewDescsResult>

- Defined in catavolt/dialog.ts:4904
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<XGetAvailableViewDescsResult>

Static getAvailableValues

getAvailableValues(dialogHandle: DialogHandle, propertyName: string, pendingWrites: EntityRec, sessionContext: SessionContext): Future<XGetAvailableValuesResult>

- Defined in catavolt/dialog.ts:4862
Parameters
- dialogHandle: DialogHandle
- propertyName: string
- pendingWrites: EntityRec
- sessionContext: SessionContext
Returns Future<XGetAvailableValuesResult>

Static getEditorModelMenuDefs

getEditorModelMenuDefs(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<Array<MenuDef>>

- Defined in catavolt/dialog.ts:4916
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<Array<MenuDef>>

Static getEditorModelPaneDef

getEditorModelPaneDef(dialogHandle: DialogHandle, paneId: string, sessionContext: SessionContext): Future<XPaneDef>

- Defined in catavolt/dialog.ts:4929
Parameters
- dialogHandle: DialogHandle
- paneId: string
- sessionContext: SessionContext
Returns Future<XPaneDef>

Static getQueryModelMenuDefs

getQueryModelMenuDefs(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<Array<MenuDef>>

- Defined in catavolt/dialog.ts:4943
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<Array<MenuDef>>

Static getSelectedEditorViewId

getSelectedEditorViewId(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<ViewId>

- Defined in catavolt/dialog.ts:4955
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<ViewId>

Static getSelectedQueryViewId

getSelectedQueryViewId(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<ViewId>

- Defined in catavolt/dialog.ts:4966
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<ViewId>

Static openEditorModelFromRedir

openEditorModelFromRedir(redirection: DialogRedirection, sessionContext: SessionContext): Future<XOpenEditorModelResult>

- Defined in catavolt/dialog.ts:4977
Parameters
- redirection: DialogRedirection
- sessionContext: SessionContext
Returns Future<XOpenEditorModelResult>

Static openQueryModelFromRedir

openQueryModelFromRedir(redirection: DialogRedirection, sessionContext: SessionContext): Future<XOpenQueryModelResult>

- Defined in catavolt/dialog.ts:4995
Parameters
- redirection: DialogRedirection
- sessionContext: SessionContext
Returns Future<XOpenQueryModelResult>

Static performEditorAction

performEditorAction(dialogHandle: DialogHandle, actionId: string, pendingWrites: EntityRec, sessionContext: SessionContext): Future<Redirection>

- Defined in catavolt/dialog.ts:5013
Parameters
- dialogHandle: DialogHandle
- actionId: string
- pendingWrites: EntityRec
- sessionContext: SessionContext
Returns Future<Redirection>

Static performQueryAction

performQueryAction(dialogHandle: DialogHandle, actionId: string, targets: Array<string>, sessionContext: SessionContext): Future<Redirection>

- Defined in catavolt/dialog.ts:5035
Parameters
- dialogHandle: DialogHandle
- actionId: string
- targets: Array<string>
- sessionContext: SessionContext
Returns Future<Redirection>

Static processSideEffects

processSideEffects(dialogHandle: DialogHandle, sessionContext: SessionContext, propertyName: string, propertyValue: any, pendingWrites: EntityRec): Future<XPropertyChangeResult>

- Defined in catavolt/dialog.ts:5064
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
- propertyName: string
- propertyValue: any
- pendingWrites: EntityRec
Returns Future<XPropertyChangeResult>

Static queryQueryModel

queryQueryModel(dialogHandle: DialogHandle, direction: QueryDirection, maxRows: number, fromObjectId: string, sessionContext: SessionContext): Future<XQueryResult>

- Defined in catavolt/dialog.ts:5082
Parameters
- dialogHandle: DialogHandle
- direction: QueryDirection
- maxRows: number
- fromObjectId: string
- sessionContext: SessionContext
Returns Future<XQueryResult>

Static readEditorModel

readEditorModel(dialogHandle: DialogHandle, sessionContext: SessionContext): Future<XReadResult>

- Defined in catavolt/dialog.ts:5107
Parameters
- dialogHandle: DialogHandle
- sessionContext: SessionContext
Returns Future<XReadResult>

Static readEditorProperty

readEditorProperty(dialogHandle: DialogHandle, propertyName: string, readSeq: number, readLength: number, sessionContext: SessionContext): Future<XReadPropertyResult>

- Defined in catavolt/dialog.ts:5118
Parameters
- dialogHandle: DialogHandle
- propertyName: string
- readSeq: number
- readLength: number
- sessionContext: SessionContext
Returns Future<XReadPropertyResult>

Static readQueryProperty

readQueryProperty(dialogHandle: DialogHandle, propertyName: string, objectId: string, readSeq: number, readLength: number, sessionContext: SessionContext): Future<XReadPropertyResult>

- Defined in catavolt/dialog.ts:5135
Parameters
- dialogHandle: DialogHandle
- propertyName: string
- objectId: string
- readSeq: number
- readLength: number
- sessionContext: SessionContext
Returns Future<XReadPropertyResult>

Static setSelectedEditorViewId

setSelectedEditorViewId(dialogHandle: DialogHandle, viewId: ViewId, sessionContext: SessionContext): Future<XOpenEditorModelResult>

- Defined in catavolt/dialog.ts:5153
Parameters
- dialogHandle: DialogHandle
- viewId: ViewId
- sessionContext: SessionContext
Returns Future<XOpenEditorModelResult>

Static setSelectedQueryViewId

setSelectedQueryViewId(dialogHandle: DialogHandle, viewId: ViewId, sessionContext: SessionContext): Future<XOpenQueryModelResult>

- Defined in catavolt/dialog.ts:5165
Parameters
- dialogHandle: DialogHandle
- viewId: ViewId
- sessionContext: SessionContext
Returns Future<XOpenQueryModelResult>

Static writeEditorModel

writeEditorModel(dialogHandle: DialogHandle, entityRec: EntityRec, sessionContext: SessionContext): Future<Either<Redirection, XWriteResult>>

- Defined in catavolt/dialog.ts:5177
Parameters
- dialogHandle: DialogHandle
- entityRec: EntityRec
- sessionContext: SessionContext
Returns Future<Either<Redirection, XWriteResult>>

Static writeProperty

writeProperty(dialogHandle: DialogHandle, propertyName: string, data: string, append: boolean, sessionContext: SessionContext): Future<XWritePropertyResult>

- Defined in catavolt/dialog.ts:5200
Parameters
- dialogHandle: DialogHandle
- propertyName: string
- data: string
- append: boolean
- sessionContext: SessionContext
Returns Future<XWritePropertyResult>

Hierarchy

Index

Properties

Methods

Properties

Static Private ATTACHMENT_PATH

Static Private EDITOR_SERVICE_NAME

Static Private EDITOR_SERVICE_PATH

Static Private QUERY_SERVICE_NAME

Static Private QUERY_SERVICE_PATH

Methods

Static addAttachment

Parameters

dialogHandle: DialogHandle

attachment: Attachment

sessionContext: SessionContext

Returns Future<void>

Static changePaneMode

Parameters

dialogHandle: DialogHandle

paneMode: PaneMode

sessionContext: SessionContext

Returns Future<XChangePaneModeResult>

Static closeEditorModel

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<VoidResult>

Static getActiveColumnDefs

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<XGetActiveColumnDefsResult>

Static getAvailableEditorViewDescs

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<XGetAvailableViewDescsResult>

Static getAvailableQueryViewDescs

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<XGetAvailableViewDescsResult>

Static getAvailableValues

Parameters

dialogHandle: DialogHandle

propertyName: string

pendingWrites: EntityRec

sessionContext: SessionContext

Returns Future<XGetAvailableValuesResult>

Static getEditorModelMenuDefs

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<Array<MenuDef>>

Static getEditorModelPaneDef

Parameters

dialogHandle: DialogHandle

paneId: string

sessionContext: SessionContext

Returns Future<XPaneDef>

Static getQueryModelMenuDefs

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<Array<MenuDef>>

Static getSelectedEditorViewId

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<ViewId>

Static getSelectedQueryViewId

Parameters

dialogHandle: DialogHandle

sessionContext: SessionContext

Returns Future<ViewId>

Static openEditorModelFromRedir

Parameters

redirection: DialogRedirection

sessionContext: SessionContext