Package com.nagra.otvaa.sdk

Enum OtvAaError

java.lang.Object
java.lang.Enum<OtvAaError>
com.nagra.otvaa.sdk.OtvAaError
All Implemented Interfaces:
Serializable, Comparable<OtvAaError>
public enum OtvAaError extends Enum<OtvAaError>
Enumeration of errors

eg OtvAaErrors.ALREADY_INITIALISED

Each error enum unit has an error code and a description string.

  • Enum Constant Details

    • OK

      public static final OtvAaError OK
      Successful return

    • ALREADY_INITIALISED

      public static final OtvAaError ALREADY_INITIALISED
      An attempt to initialise an already initialised agent is not permitted. You may want to call OtvAnalyticsAgent.updateConfig(org.json.JSONObject) instead, or close the exiting one first.

    • AGENT_NOT_INITIALISED

      public static final OtvAaError AGENT_NOT_INITIALISED
      An attempt to submit activities to an agent before it was first initialised with endpoints.

    • APP_NOT_STARTED

      public static final OtvAaError APP_NOT_STARTED
      The OtvActivity.AppStart activity must be the first activity to submit after initialising the agent or after submitting OtvActivity.AppEnd.

    • CAN_ONLY_UPDATE_EXISTING_DESTINATION

      public static final OtvAaError CAN_ONLY_UPDATE_EXISTING_DESTINATION
      When using OtvAnalyticsAgent.updateConfig(org.json.JSONObject), only pre-configured destinations can be updated. New destination endpoints are not permitted with this method.

    • INVALID_ACTIVITY

      public static final OtvAaError INVALID_ACTIVITY
      Unrecognised or malformed (e.g. missing/wrong metadata) activity was submitted.

    • INVALID_DESTINATION_CONFIGURATION

      public static final OtvAaError INVALID_DESTINATION_CONFIGURATION
      The destination specified was not configured yet, or badly configured.

    • INVALID_CONFIGURATION

      public static final OtvAaError INVALID_CONFIGURATION
      Invalid configuration of account id metadata.

    • WRAPPER_ALREADY_INITIALISED

      public static final OtvAaError WRAPPER_ALREADY_INITIALISED
      An attempt to initialise an already initialised wrapper is not permitted. You may want to call OtvAnalyticsAgentWrapper.updateConfig(org.json.JSONObject, org.json.JSONObject) instead, or close the exiting one first.

    • WRAPPER_NOT_INITIALISED

      public static final OtvAaError WRAPPER_NOT_INITIALISED
      An attempt to submit activities to a wrapper before it was first initialised.

    • INVALID_POSITION_CALLBACK

      public static final OtvAaError INVALID_POSITION_CALLBACK
      Not in use

    • PLAYER_CHANGED_DURING_PLAYBACK

      public static final OtvAaError PLAYER_CHANGED_DURING_PLAYBACK
      Trying to change (assign) the player while an existing playback session already exists is not permitted. Stop the existing session, and then update the player reference

    • PLAYER_NOT_SET

      public static final OtvAaError PLAYER_NOT_SET
      Trying to submit a OtvActivity.PlaybackStart activity before a player was set using OtvAnalyticsAgentWrapper.setPlayer(java.lang.Object, int).

    • USE_WRAPPER_METHOD

      public static final OtvAaError USE_WRAPPER_METHOD
      An attempt to submit a OtvActivity.AppStart or OtvActivity.PlaybackStart activity with the wrapper must be made through OtvAnalyticsAgentWrapper.appStart(org.json.JSONObject) or OtvAnalyticsAgentWrapper.playbackStart(org.json.JSONObject, com.nagra.otvaa.sdk.insightwrapper.ContentInfoHolder, com.nagra.otvaa.sdk.insightwrapper.UserInfoHolder) respectively.

    • CANT_POPULATE_METADATA_WITHOUT_PLAYER

      public static final OtvAaError CANT_POPULATE_METADATA_WITHOUT_PLAYER
      A playback-related activity must have a player reference provided for the wrapper to get the additional necessary metadata.

    • ONLY_ONE_PLAYBACK_SESSION

      public static final OtvAaError ONLY_ONE_PLAYBACK_SESSION
      Multiple playback sessions are currently not permitted.

    • INVALID_URL_FOR_UAV

      public static final OtvAaError INVALID_URL_FOR_UAV
      A URL for the UAV endpoint is missing or malformed.

    • NO_TOKEN_FOR_UAV

      public static final OtvAaError NO_TOKEN_FOR_UAV
      Configuration of the UAV requires a token in the configuration.

    • ONLY_TOKEN_CAN_BE_UPDATED_FOR_UAV

      public static final OtvAaError ONLY_TOKEN_CAN_BE_UPDATED_FOR_UAV
      An attempt to update the UAV endpoint, but only the token can be updated (for licence renewal).

    • UAV_HTTP_ERROR

      public static final OtvAaError UAV_HTTP_ERROR
      Encountered an HTTP error when trying to submit an activity to the UAV endpoint.

    • UNABLE_TO_SEND_TO_UAV

      public static final OtvAaError UNABLE_TO_SEND_TO_UAV
      Encountered an unknown error when trying to submit an activity to the UAV endpoint.

    • UAV_TIMEOUT

      public static final OtvAaError UAV_TIMEOUT
      Encountered a imeout exception when trying to submit an activity to the UAV endpoint.

    • INVALID_TOKEN_FOR_UAV

      public static final OtvAaError INVALID_TOKEN_FOR_UAV
      The token required for configuring access to the UAV was invalid.

    • INSIGHT_CANT_CREATE_WRAPPER

      public static final OtvAaError INSIGHT_CANT_CREATE_WRAPPER
      Unable to create Insight wrapper. The 'extra' field should contain an error code to explain reason.

    • INSIGHT_CANT_START_SESSION

      public static final OtvAaError INSIGHT_CANT_START_SESSION
      Unable to start Insight session. The 'extra' field should contain an error code to explain reason.

  • Method Details

    • values

      public static OtvAaError[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static OtvAaError valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public int getCode()
      Get the error code
      Returns:
      the unique error code associated with this error

    • getName

      public String getName()
      Get the error name
      Returns:
      a readable string containing the name of the error

    • getDescription

      public String getDescription()
      Get the error description
      Returns:
      a string describing the nature of the error

    • findByCode

      public static OtvAaError findByCode(int xCode)
      A cross-reference to find the error associated by its code
      Returns:
      the error associated with the code, or null if not found

    • findByName

      public static OtvAaError findByName(String xName)
      A cross-reference to find the error associated by its name
      Returns:
      the error associated with the code, or null if not found