Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DialogApi

Hierarchy

  • DialogApi

Implemented by

Index

Properties

Methods

Properties

lastServiceActivity

lastServiceActivity: Date

Methods

addAttachment

  • addAttachment(tenantId: string, sessionId: string, dialogId: string, attachment: Attachment): Promise<void>

addClientListener

changeMode

changeView

  • changeView(tenantId: string, sessionId: string, dialogId: string, viewId: string): Promise<Dialog>

createSession

deleteDialog

  • deleteDialog(tenantId: string, sessionId: string, dialogId: string): Promise<object>

  • Parameters

    • tenantId: string
    • sessionId: string
    • dialogId: string

    Returns Promise<object>

deleteSession

  • deleteSession(tenantId: string, sessionId: string): Promise<object>

getActions

  • getActions(tenantId: string, sessionId: string, dialogId: string): Promise<Array<Menu>>

getAvailableValues

  • getAvailableValues(tenantId: string, sessionId: string, dialogId: string, propertyName: string, availableValuesParams: AvailableValuesParameters): Promise<Array<any>>

getContent

getDialog

  • getDialog(tenantId: string, sessionId: string, dialogId: string): Promise<Dialog>

getEditorProperty

getMode

  • getMode(tenantId: string, sessionId: string, dialogId: string): Promise<ViewMode>

getQueryProperty

getRecord

  • getRecord(tenantId: string, sessionId: string, dialogId: string): Promise<Record>

getRecords

getRedirection

  • getRedirection(tenantId: string, sessionId: string, redirectionId: string): Promise<Redirection>

getSession

  • getSession(tenantId: string, sessionId: string): Promise<Session>

getView

  • getView(tenantId: string, sessionId: string, dialogId: string): Promise<View>

getViews

  • getViews(tenantId: string, sessionId: string, dialogId: string): Promise<Array<ViewDescriptor>>

getWorkbench

  • getWorkbench(tenantId: string, sessionId: string, workbenchId: string): Promise<Workbench>

getWorkbenchActions

  • getWorkbenchActions(tenantId: string, sessionId: string, workbenchId: string): Promise<Array<WorkbenchAction>>

getWorkbenches

  • getWorkbenches(tenantId: string, sessionId: string): Promise<Array<Workbench>>

isAnyUserInBriefcaseMode

  • isAnyUserInBriefcaseMode(tenantId: string): Promise<boolean>

isUserInBriefcaseMode

  • isUserInBriefcaseMode(userInfo: __type): Promise<boolean>

performAction

  • performAction(tenantId: string, sessionId: string, dialogId: string, actionId: string, actionParameters: ActionParameters): Promise<Redirection>

performWorkbenchAction

  • performWorkbenchAction(tenantId: string, sessionId: string, workbenchId: string, actionId: string): Promise<Redirection>

propertyChange

putRecord

removeClientListener

streamUrl

  • streamUrl(tentantId: string, sessionId: string, url: string): Promise<StreamProducer>

writeProperty

  • writeProperty(tenantId: string, sessionId: string, dialogId: string, propertyName: string, writeLargePropertyParams: WriteLargePropertyParameters): Promise<object>

Generated using TypeDoc