Interface DataProviderResult

Result structure from calls to GetDataProviderData

interface DataProviderResult {
    clientProviders?: { [key: string]: ClientDataProviderQuery };
    data?: { [key: string]: any };
    exceptions?: { [key: string]: DataProviderExceptionDetails };
    resolvedProviders?: ResolvedDataProvider[];
    scopeName?: string;
    scopeValue?: string;
    sharedData?: { [key: string]: any };
}

Properties

clientProviders? data? exceptions? resolvedProviders? scopeName? scopeValue? sharedData?

Properties

OptionalclientProviders

clientProviders?: { [key: string]: ClientDataProviderQuery }

This is the set of data providers that were requested, but either they were defined as client providers, or as remote providers that failed and may be retried by the client.

Optionaldata

data?: { [key: string]: any }

Property bag of data keyed off of the data provider contribution id

Optionalexceptions

exceptions?: { [key: string]: DataProviderExceptionDetails }

Set of exceptions that occurred resolving the data providers.

OptionalresolvedProviders

resolvedProviders?: ResolvedDataProvider[]

List of data providers resolved in the data-provider query

OptionalscopeName

scopeName?: string

Scope name applied to this data provider result.

OptionalscopeValue

scopeValue?: string

Scope value applied to this data provider result.

OptionalsharedData

sharedData?: { [key: string]: any }

Property bag of shared data that was contributed to by any of the individual data providers

Settings

Member Visibility

On This Page

Properties