References

Class Summary

Static Public Class Summary
public	IntentManager Intent manager
public	IproApiError
public	SetContextError
public	VariantNotFoundError

Interface Summary

Static Public Interface Summary
public	Action Interface each action.js has to implement
public	InsightProvider Interface each ipro.js has to implement

Typedef Summary

Static Public Typedef Summary
public	ActionExecution(intentType: StandardIntent \| string, intentOptions: Object): Object: function(intenType: IntentType, options: Object): Promise<Object> \| Object The execute function of an Action
public	ActionMetadata: Object The metadata of an action.
public	ActionsMetadata: Object<IntentType, ActionMetadata> The metadata of a collection of actions implemented in one action.js file.
public	Configuration: Object
public	Context: Object<EntityType, Array<EntityId> \| Array<EntityObject>> The result of a context query.
public	ContextChangeHandler: function(ipro: InsightProvider, contextQuery: ContextQuery): void Callback function to inform an application that the context of an insightProvider has changed.
public	ContextQuery: Object<EntityType, ContextQueryOptions> An Object whose keys are the EntityTypes to query and whose values are the ContextQueryOptions for the requested entity.
public	ContextQueryOptions: Object The options for a context query for a specific EntityType.
public	ContextResultType: string Indicates the return type of the context query.
public	ContextReturnType: Object this typedef is experimental. Enum of context return types.
public	ContextSelector: Object enum of ContextSelector's . Exposed into global namespace `sap.pdms.ipro.api.ContextSelector`
public	ContextSelector: string Defines what result set should be returned from a `getContext` call.
public	EntityId: string An identifier for a single entity.
public	EntityObject: Object An object which describes an entity.
public	EntityType: string An EntityType as string.
public	Feature: Object this typedef is experimental. The supported features of an ipro.
public	Framework: Object this typedef was deprecated. In PDMS 1.0 SP00 the application was loading UI5 and NATIVE (other) ipros differently. As of PDMS 1.0 SP02 all ipros are loaded in the same way, hence this information is not required anymore. the ui framework being used by the ipro.
public	InsightProviderDataInterface: Object this typedef is experimental. Not actively used by any application as of PDMS 1.0 FP02. The data input and output for an ipro.
public	InsightProviderMetadata: Object The metadata of an ipro.
public	InsightProviderOptions: Object Options for creating an ipro
public	IntentHandler(insightProvider: Object, intentType: StandardIntent \| string, intentParams: IntentParams): function(): void Callback function to inform an application of an intent of an insightProvider.
public	IntentParams: any The intent specific parameters.
public	Pagination: Object this typedef is experimental. Not actively used by any application or ipro as of PDMS 1.0 FP02. Allows to restrict the number of entities returned from a context query.
public	Size: Object The size of an ipro
public	StandardIntent: Object enum for standard intents.