Package com.veeva.vault.sdk.api.page
Interface PageController
- All Superinterfaces:
com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<PageLoadContext>
public interface PageController
extends com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<PageLoadContext>
Provides data upon loading a page or responding to events after a page has been loaded.
-
Method Summary
Modifier and TypeMethodDescriptiondefault PageEventResponseonEvent(PageEventContext pageEventContext) Optional method invoked by an event sent from the client.default PageLoadResponseonLoad(PageLoadContext pageLoadContext) Optional method invoked upon request to load a page.
-
Method Details
-
onLoad
Optional method invoked upon request to load a page.- Parameters:
pageLoadContext- information about the page instance and methods for constructing a response- Returns:
- a
PageLoadResponsecontaining data to return to the client
-
onEvent
Optional method invoked by an event sent from the client.- Parameters:
pageEventContext- information about the event and specific data sent from the client- Returns:
- a
PageEventResponsecontaining data to return to the client
-