Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DialogProxyTools

Hierarchy

  • DialogProxyTools

Index

Properties

Methods

Properties

Static Private ACTION_PARAMETERS_MODEL_TYPE

ACTION_PARAMETERS_MODEL_TYPE: string = "hxgn.api.dialog.ActionParameters"

Static Private ANNOTATION_MODEL_TYPE

ANNOTATION_MODEL_TYPE: string = "hxgn.api.dialog.Annotation"

Static Private COMMON_FETCH_CLIENT

COMMON_FETCH_CLIENT: FetchClient = new FetchClient()

Static Private CONTENT_STORAGE_KEY

CONTENT_STORAGE_KEY: string = "${userId}.${tenantId}.${contentId}.${sequence}.content"

Static Private DIALOG_MESSAGE_MODEL_TYPE

DIALOG_MESSAGE_MODEL_TYPE: string = "hxgn.api.dialog.DialogMessage"

Static Private DIALOG_STORAGE_KEY

DIALOG_STORAGE_KEY: string = "${userId}.${tenantId}.${dialogId}.dialog"

Static Private EDITOR_DIALOG_MODEL_TYPE

EDITOR_DIALOG_MODEL_TYPE: string = "hxgn.api.dialog.EditorDialog"

Static Private LOGIN_MODEL_TYPE

LOGIN_MODEL_TYPE: string = "hxgn.api.dialog.Login"

Static Private PROPERTY_COMMIT_STORAGE_KEY

PROPERTY_COMMIT_STORAGE_KEY: string = "${userId}.${tenantId}.${dialogId}.${propertyName}.propertycommit"

Static Private PROPERTY_DEF_MODEL_TYPE

PROPERTY_DEF_MODEL_TYPE: string = "hxgn.api.dialog.PropertyDef"

Static Private PROPERTY_MODEL_TYPE

PROPERTY_MODEL_TYPE: string = "hxgn.api.dialog.Property"

Static Private QUERY_DIALOG_MODEL_TYPE

QUERY_DIALOG_MODEL_TYPE: string = "hxgn.api.dialog.QueryDialog"

Static Private RECORD_COMMIT_STORAGE_KEY

RECORD_COMMIT_STORAGE_KEY: string = "${userId}.${tenantId}.${dialogId}.recordcommit"

Static Private RECORD_MODEL_TYPE

RECORD_MODEL_TYPE: string = "hxgn.api.dialog.Record"

Static Private RECORD_SET_MODEL_TYPE

RECORD_SET_MODEL_TYPE: string = "hxgn.api.dialog.RecordSet"

Static Private RECORD_SET_STORAGE_KEY

RECORD_SET_STORAGE_KEY: string = "${userId}.${tenantId}.${dialogId}.recordset"

Static Private RECORD_STORAGE_KEY

RECORD_STORAGE_KEY: string = "${userId}.${tenantId}.${dialogId}.record"

Static Private REDIRECTION_STORAGE_KEY

REDIRECTION_STORAGE_KEY: string = "${userId}.${tenantId}.${stateId}.${actionId}.redirection"

Static Private REFERRING_DIALOG_MODEL_TYPE

REFERRING_DIALOG_MODEL_TYPE: string = "hxgn.api.dialog.ReferringDialog"

Static Private REFERRING_WORKBENCH_MODEL_TYPE

REFERRING_WORKBENCH_MODEL_TYPE: string = "hxgn.api.dialog.ReferringWorkbench"

Static Private SESSION_MODEL_TYPE

SESSION_MODEL_TYPE: string = "hxgn.api.dialog.Session"

Static Private STORAGE_KEY_PREFIX

STORAGE_KEY_PREFIX: string = "${userId}.${tenantId}."

Methods

Static captureDialog

  • captureDialog(userId: string, baseUrl: string, tenantId: string, sessionId: string, dialogId: string, referringDialogId: any): Promise<object>

  • Parameters

    • userId: string
    • baseUrl: string
    • tenantId: string
    • sessionId: string
    • dialogId: string
    • referringDialogId: any

    Returns Promise<object>

Static captureMenuActionRedirectionAndDialog

  • captureMenuActionRedirectionAndDialog(userId: string, baseUrl: string, tenantId: string, sessionId: string, dialogId: string, offlineDialogId: string, actionId: string, targetId: string): Promise<any>

  • Parameters

    • userId: string
    • baseUrl: string
    • tenantId: string
    • sessionId: string
    • dialogId: string
    • offlineDialogId: string
    • actionId: string
    • targetId: string

    Returns Promise<any>

Static captureRecord

  • captureRecord(userId: string, baseUrl: string, tenantId: string, sessionId: string, beforeAndAfterValues: any, listDialogName: string): Promise<RecordVisitor>

Static captureRecordSet

  • captureRecordSet(userId: string, baseUrl: string, tenantId: string, sessionId: string, beforeAndAfterValues: any, listDialogName: string): Promise<RecordSetVisitor>

Static captureWorkbenchActionRedirectionAndDialog

  • captureWorkbenchActionRedirectionAndDialog(userId: string, baseUrl: string, tenantId: string, sessionId: string, workbenchId: string, actionId: string): Promise<any>

  • Parameters

    • userId: string
    • baseUrl: string
    • tenantId: string
    • sessionId: string
    • workbenchId: string
    • actionId: string

    Returns Promise<any>

Static clearAllStorageAt

  • clearAllStorageAt(userId: string, tenantId: string): Promise<void>

Static commonFetchClient

Static constructDialogMessageModel

  • constructDialogMessageModel(message: string): object

Static constructLoginModel

  • constructLoginModel(userId: string, password: string): object

Static constructNullRedirection

  • constructNullRedirection(tenantId: string, sessionId: string): StringDictionary

  • Construct an empty null redirection with the following defaults: referringObject will be a type of "hxgn.api.dialog.ReferringDialog" dialogAlias=null dialogName=null dialogMode='READ' actionId=null dialogId=null refreshNeeded=true id=randomly generated value

    Parameters

    • tenantId: string
    • sessionId: string

    Returns StringDictionary

Static constructNullRedirectionId

  • constructNullRedirectionId(): string

Static constructRedirectionStorageKey

  • constructRedirectionStorageKey(userId: string, tenantId: string, stateId: string, actionId: string): string

Static constructRequestNotValidDuringOfflineMode

  • constructRequestNotValidDuringOfflineMode(action: string, resourcePath: string): JsonClientResponse

Static isActionParametersModel

  • isActionParametersModel(jsonObject: object): boolean

Static isAnnotationModel

  • isAnnotationModel(jsonObject: object): boolean

Static isDialogModel

  • isDialogModel(jsonObject: object): boolean

Static isLoginModel

  • isLoginModel(jsonObject: object): boolean

Static isPropertyDefModel

  • isPropertyDefModel(jsonObject: object): boolean

Static isPropertyModel

  • isPropertyModel(jsonObject: object): boolean

Static isRecordModel

  • isRecordModel(jsonObject: object): boolean

Static isRecordSetModel

  • isRecordSetModel(jsonObject: object): boolean

Static isReferringDialogModel

  • isReferringDialogModel(jsonObject: object): boolean

Static isReferringWorkbenchModel

  • isReferringWorkbenchModel(jsonObject: object): boolean

Static isSessionModel

  • isSessionModel(jsonObject: object): boolean

Static readDialogAsOfflineResponse

Static readDialogAsVisitor

Static readDialogRedirectionAsVisitor

  • readDialogRedirectionAsVisitor(userId: string, tenantId: string, stateId: string, actionId: string): Promise<DialogRedirectionVisitor>

Static readMenuActionRedirectionAsOfflineResponse

Static readMenuActionRedirectionAsVisitor

Static readPropertyCommit

  • readPropertyCommit(userId: string, tenantId: string, dialogId: string, propertyName: string): Promise<any>

Static readRecordAsOfflineResponse

Static readRecordAsVisitor

  • readRecordAsVisitor(userId: string, tenantId: string, dialogId: string): Promise<RecordVisitor>

Static readRecordAsVisitorFromRequest

Static readRecordCommitAsVisitor

  • readRecordCommitAsVisitor(userId: string, tenantId: string, dialogId: string): Promise<RecordVisitor>

Static readRecordSetAsOfflineResponse

Static readRecordSetAsVisitor

Static readSessionContentAsOfflineResponse

Static readSessionContentAsVisitor

  • readSessionContentAsVisitor(userId: string, tenantId: string, contentId: string, sequence: number): Promise<LargePropertyVisitor>

Static readWorkbenchActionRedirectionAsOfflineResponse

Static showAllStorageKeys

  • showAllStorageKeys(): Promise<void>

Static showAllStorageKeysAndValues

  • showAllStorageKeysAndValues(): Promise<void>

Static showStoredDialogNavigation

  • showStoredDialogNavigation(): Promise<void>

Static writeContentChunk

  • writeContentChunk(userId: string, tenantId: string, contentId: string, sequence: number, largePropertyVisitor: LargePropertyVisitor): Promise<void>

Static writeContentRedirection

  • writeContentRedirection(userId: string, tenantId: string, stateId: string, actionId: string, contentRedirectionVistor: ContentRedirectionVisitor): Promise<void>

Static writeDialog

  • writeDialog(userId: string, tenantId: string, dialogVisitor: DialogVisitor): Promise<void>

Static writeDialogRedirection

  • writeDialogRedirection(userId: string, tenantId: string, stateId: string, actionId: string, dialogRedirectionVistor: DialogRedirectionVisitor): Promise<void>

Static writePropertyCommit

  • writePropertyCommit(userId: string, tenantId: string, dialogId: string, propertyName: string, writeLargePropertyParametersVisitor: WriteLargePropertyParametersVisitor): Promise<void>

Static writeRecord

  • writeRecord(userId: string, tenantId: string, dialogId: string, recordVisitor: RecordVisitor): Promise<void>

Static writeRecordCommit

  • writeRecordCommit(userId: string, tenantId: string, dialogId: string, recordVisitor: RecordVisitor): Promise<void>

Static writeRecordSet

  • writeRecordSet(userId: string, tenantId: string, dialogId: string, recordSetVisitor: RecordSetVisitor): Promise<void>

Generated using TypeDoc