Package com.veeva.vault.sdk.api.page

Interface PageEventContext

public interface PageEventContext
Provides information about an event to a page's PageController.onEvent(com.veeva.vault.sdk.api.page.PageEventContext) method and provides methods to create a response.

  • Method Details

    • getEventName

      String getEventName()
      Retrieves the name of this page event.
      Returns:
      the page event name

    • getData

      JsonObject getData()
      Retrieves the data sent from the client as a JSON object.
      Returns:
      the JSON data sent from the client

    • getData

      <U extends UserDefinedModel> U getData(Class<U> userDefinedModelClass)
      Retrieves the data sent from the client as a UserDefinedModel.
      Type Parameters:
      U - the UserDefinedModel type to convert the data into
      Parameters:
      userDefinedModelClass - the UserDefinedModel class that represents the data
      Returns:
      the data sent from the client as a UserDefinedModel

    • newEventResponseBuilder

      PageEventResponse.Builder newEventResponseBuilder()
      Creates a new PageEventResponse.Builder.
      Returns:
      the created PageEventResponse.Builder

    • newEventErrorResponseBuilder

      PageEventErrorResponse.Builder newEventErrorResponseBuilder()
      Creates a new PageEventErrorResponse.Builder.
      Returns:
      the created PageEventErrorResponse.Builder