CustomDataFunctionExecutor.GetPromptRequestsCore Method

CustomDataFunctionExecutor GetPromptRequestsCore Method

TIBCO Spotfire 6.0 API Reference

Gets the prompt requests that can be constructed based on just the function definition metadata, without an actual function invocation. This is used during the data load phase, to be able to synchronously prompt for e.g. credentials before starting the asynchronous function execution.

Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

protected virtual IEnumerable<Object> GetPromptRequestsCore(
	ImportContext importContext,
	DataFunctionDefinition functionDefinition
)

protected virtual IEnumerable<Object> GetPromptRequestsCore(
	ImportContext importContext,
	DataFunctionDefinition functionDefinition
)

Parameters

importContext: Type: Spotfire.Dxp.Data.Import ImportContext
An import context.

functionDefinition: Type: Spotfire.Dxp.Data.DataFunctions DataFunctionDefinition
The function definition.

Return Value

Type: IEnumerable Object
The prompt models to return, the implementor is expected to use the yield return pattern.