UIPassthroughContractBase
UIPassthroughContractBase : {addVizToPinboard: {request: {liveboardId?: string , newLiveboardName?: string , newTabName?: string , newVizDescription?: string , newVizName: string , tabId?: string , vizId?: string } , response: {liveboardId: string , tabId: string , vizId: string } } , drillDown: {request: {autoDrillDown?: boolean , columnGuid?: string , points: {clickedPoint?: string , selectedPoints?: string[] } , vizId?: string } , response: unknown } , getAnswerPageConfig: {request: {vizId?: string } , response: any } , getAnswerSession: {request: {vizId?: string } , response: {embedAnswerData?: Record< string, any > , session: SessionInterface } } , getAvailableUiPassthroughs: {request: any , response: {keys: string[] } } , getDiscoverabilityStatus: {request: any , response: {isDiscoverabilityCheckboxUnselectedPerOrg: boolean , shouldShowDiscoverability: boolean } } , getExportRequestForCurrentPinboard: {request: Record< string, never > , response: {data: {v2Content: string } , type: GetExportRequestForCurrentPinboard# } } , getFilters: {request: {vizId?: _string } , response: {liveboardFilters: LiveboardFilter[] , runtimeFilters: RuntimeFilter[] } } , getGroups: {request: Record< string, never > , response: {Groups: LiveboardGroup[] , numberOfGroups: number , orderedGroupIds: string[] } } , getIframeUrl: {request: Record< string, never > , response: {iframeUrl: string } } , getParameters: {request: Record< string, never > , response: {parameters: LiveboardParameter[] } } , getPinboardPageConfig: {request: any , response: any } , getTML: {request: {includeNonExecutedSearchTokens?: boolean , vizId?: string } , response: Record< string, any > } , getTabs: {request: Record< string, never > , response: {Tabs: LiveboardTab[] , numberOfTabs: number , orderedTabIds: string[] } } , getUnsavedAnswerTML: {request: {sessionId?: string , vizId?: string } , response: {tml: string } } , saveAnswer: {request: {description: string , isDiscoverable?: boolean , name: string , vizId?: string } , response: {answerId: string , saveResponse?: any , shareResponse?: any } } , updateFilters: {request: {filter?: FilterUpdate , filters?: FilterUpdate[] } , response: unknown } }
Defined in : embed/hostEventClient/contracts.ts
Parameters
- addVizToPinboard
-
-
addVizToPinboard: {request: {liveboardId?: string , newLiveboardName?: string , newTabName?: string , newVizDescription?: string , newVizName: string , tabId?: string , vizId?: string } , response: {liveboardId: string , tabId: string , vizId: string } }
-
Parameters
- request
-
-
request: {liveboardId?: string , newLiveboardName?: string , newTabName?: string , newVizDescription?: string , newVizName: string , tabId?: string , vizId?: string }
-
Parameters
- liveboardId
-
Optional
-
liveboardId: string
-
- newLiveboardName
-
Optional
-
newLiveboardName: string
-
- newTabName
-
Optional
-
newTabName: string
-
- newVizDescription
-
Optional
-
newVizDescription: string
-
- newVizName
-
-
newVizName: string
-
- tabId
-
Optional
-
tabId: string
-
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: {liveboardId: string , tabId: string , vizId: string }
-
Parameters
- liveboardId
-
-
liveboardId: string
-
- tabId
-
-
tabId: string
-
- vizId
-
-
vizId: string
-
- drillDown
-
-
drillDown: {request: {autoDrillDown?: boolean , columnGuid?: string , points: {clickedPoint?: string , selectedPoints?: string[] } , vizId?: string } , response: unknown }
-
Parameters
- request
-
-
request: {autoDrillDown?: boolean , columnGuid?: string , points: {clickedPoint?: string , selectedPoints?: string[] } , vizId?: string }
-
Parameters
- autoDrillDown
-
Optional
-
autoDrillDown: boolean
-
- columnGuid
-
Optional
-
columnGuid: string
-
- points
-
-
points: {clickedPoint?: string , selectedPoints?: string[] }
-
Parameters
- clickedPoint
-
Optional
-
clickedPoint: string
-
- selectedPoints
-
Optional
-
selectedPoints: string[]
-
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: unknown
-
- getAnswerPageConfig
-
-
getAnswerPageConfig: {request: {vizId?: string } , response: any }
-
Parameters
- request
-
-
request: {vizId?: string }
-
Parameters
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: any
-
- getAnswerSession
-
-
getAnswerSession: {request: {vizId?: string } , response: {embedAnswerData?: Record< string, any > , session: SessionInterface } }
-
Parameters
- request
-
-
request: {vizId?: string }
-
Parameters
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: {embedAnswerData?: Record< string, any > , session: SessionInterface }
-
Parameters
- embedAnswerData
-
Optional
-
embedAnswerData: Record< string, any >
-
- session
-
-
session: SessionInterface
-
- getAvailableUiPassthroughs
-
-
getAvailableUiPassthroughs: {request: any , response: {keys: string[] } }
-
Parameters
- request
-
-
request: any
-
- response
-
-
response: {keys: string[] }
-
Parameters
- keys
-
-
keys: string[]
-
- getDiscoverabilityStatus
-
-
getDiscoverabilityStatus: {request: any , response: {isDiscoverabilityCheckboxUnselectedPerOrg: boolean , shouldShowDiscoverability: boolean } }
-
Parameters
- request
-
-
request: any
-
- response
-
-
response: {isDiscoverabilityCheckboxUnselectedPerOrg: boolean , shouldShowDiscoverability: boolean }
-
Parameters
- isDiscoverabilityCheckboxUnselectedPerOrg
-
-
isDiscoverabilityCheckboxUnselectedPerOrg: boolean
-
- shouldShowDiscoverability
-
-
shouldShowDiscoverability: boolean
-
- getExportRequestForCurrentPinboard
-
-
getExportRequestForCurrentPinboard: {request: Record< string, never > , response: {data: {v2Content: string } , type: GetExportRequestForCurrentPinboard } }
-
Parameters
- request
-
-
request: Record< string, never >
-
- response
-
-
response: {data: {v2Content: string } , type: GetExportRequestForCurrentPinboard }
-
Parameters
- data
-
-
data: {v2Content: string }
-
Parameters
- v2Content
-
-
v2Content: string
-
- type
-
-
type: UIPassthroughEvent.GetExportRequestForCurrentPinboard
-
- getFilters
-
-
getFilters: {request: {vizId?: string } , response: {liveboardFilters: LiveboardFilter[] , runtimeFilters: RuntimeFilter[] } }
-
Parameters
- request
-
-
request: {vizId?: string }
-
Parameters
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: {liveboardFilters: LiveboardFilter[] , runtimeFilters: RuntimeFilter[] }
-
Parameters
- liveboardFilters
-
-
liveboardFilters: LiveboardFilter[]
-
- runtimeFilters
-
-
runtimeFilters: RuntimeFilter[]
-
- getGroups
-
-
getGroups: {request: Record< string, never > , response: {Groups: LiveboardGroup[] , numberOfGroups: number , orderedGroupIds: string[] } }
-
Parameters
- request
-
-
request: Record< string, never >
-
- response
-
-
response: {Groups: LiveboardGroup[] , numberOfGroups: number , orderedGroupIds: string[] }
-
Parameters
- Groups
-
-
Groups: LiveboardGroup[]
-
- numberOfGroups
-
-
numberOfGroups: number
-
- orderedGroupIds
-
-
orderedGroupIds: string[]
-
- getIframeUrl
-
-
getIframeUrl: {request: Record< string, never > , response: {iframeUrl: string } }
-
Parameters
- request
-
-
request: Record< string, never >
-
- response
-
-
response: {iframeUrl: string }
-
Parameters
- iframeUrl
-
-
iframeUrl: string
-
- getParameters
-
-
getParameters: {request: Record< string, never > , response: {parameters: LiveboardParameter[] } }
-
Parameters
- request
-
-
request: Record< string, never >
-
- response
-
-
response: {parameters: LiveboardParameter[] }
-
Parameters
- parameters
-
-
parameters: LiveboardParameter[]
-
- getPinboardPageConfig
-
-
getPinboardPageConfig: {request: any , response: any }
-
Parameters
- request
-
-
request: any
-
- response
-
-
response: any
-
- getTML
-
-
getTML: {request: {includeNonExecutedSearchTokens?: boolean , vizId?: string } , response: Record< string, any > }
-
Parameters
- request
-
-
request: {includeNonExecutedSearchTokens?: boolean , vizId?: string }
-
Parameters
- includeNonExecutedSearchTokens
-
Optional
-
includeNonExecutedSearchTokens: boolean
-
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: Record< string, any >
-
- getTabs
-
-
getTabs: {request: Record< string, never > , response: {Tabs: LiveboardTab[] , numberOfTabs: number , orderedTabIds: string[] } }
-
Parameters
- request
-
-
request: Record< string, never >
-
- response
-
-
response: {Tabs: LiveboardTab[] , numberOfTabs: number , orderedTabIds: string[] }
-
Parameters
- Tabs
-
-
Tabs: LiveboardTab[]
-
- numberOfTabs
-
-
numberOfTabs: number
-
- orderedTabIds
-
-
orderedTabIds: string[]
-
- getUnsavedAnswerTML
-
-
getUnsavedAnswerTML: {request: {sessionId?: string , vizId?: string } , response: {tml: string } }
-
Parameters
- request
-
-
request: {sessionId?: string , vizId?: string }
-
Parameters
- sessionId
-
Optional
-
sessionId: string
-
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: {tml: string }
-
Parameters
- tml
-
-
tml: string
-
- saveAnswer
-
-
saveAnswer: {request: {description: string , isDiscoverable?: boolean , name: string , vizId?: string } , response: {answerId: string , saveResponse?: any , shareResponse?: any } }
-
Parameters
- request
-
-
request: {description: string , isDiscoverable?: boolean , name: string , vizId?: string }
-
Parameters
- description
-
-
description: string
-
- isDiscoverable
-
Optional
-
isDiscoverable: boolean
-
- name
-
-
name: string
-
- vizId
-
Optional
-
vizId: string
-
- response
-
-
response: {answerId: string , saveResponse?: any , shareResponse?: any }
-
Parameters
- answerId
-
-
answerId: string
-
- saveResponse
-
Optional
-
saveResponse: any
-
- shareResponse
-
Optional
-
shareResponse: any
-
- updateFilters
-
-
updateFilters: {request: {filter?: FilterUpdate , filters?: FilterUpdate[] } , response: unknown }
-
Parameters
- request
-
-
request: {filter?: FilterUpdate , filters?: FilterUpdate[] }
-
Parameters
- filter
-
Optional
-
filter: FilterUpdate
-
- filters
-
Optional
-
filters: FilterUpdate[]
-
- response
-
-
response: unknown
-