Class Event

    • Method Detail

      • appPackageName

        public final String appPackageName()

        The package name of the app that's recording the event.

        Returns:
        The package name of the app that's recording the event.
      • appTitle

        public final String appTitle()

        The title of the app that's recording the event.

        Returns:
        The title of the app that's recording the event.
      • appVersionCode

        public final String appVersionCode()

        The version number of the app that's recording the event.

        Returns:
        The version number of the app that's recording the event.
      • hasAttributes

        public final boolean hasAttributes()
        For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • attributes

        public final Map<String,​String> attributes()

        One or more custom attributes that are associated with the event.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

        Returns:
        One or more custom attributes that are associated with the event.
      • clientSdkVersion

        public final String clientSdkVersion()

        The version of the SDK that's running on the client device.

        Returns:
        The version of the SDK that's running on the client device.
      • eventType

        public final String eventType()

        The name of the event.

        Returns:
        The name of the event.
      • hasMetrics

        public final boolean hasMetrics()
        For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • metrics

        public final Map<String,​Double> metrics()

        One or more custom metrics that are associated with the event.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

        Returns:
        One or more custom metrics that are associated with the event.
      • sdkName

        public final String sdkName()

        The name of the SDK that's being used to record the event.

        Returns:
        The name of the SDK that's being used to record the event.
      • session

        public final Session session()

        Information about the session in which the event occurred.

        Returns:
        Information about the session in which the event occurred.
      • timestamp

        public final String timestamp()

        The date and time, in ISO 8601 format, when the event occurred.

        Returns:
        The date and time, in ISO 8601 format, when the event occurred.
      • serializableBuilderClass

        public static Class<? extends Event.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)