Class InteractionLifecycleEvent


  • public class InteractionLifecycleEvent
    extends java.lang.Object
    An interaction lifecycle event has occurred. This could indicate that an interaction has started, resumed, been suspended, ended, or failed.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String reason
      Only set if type is "failed".
      java.lang.String sourceUri
      The interaction URN.
      java.lang.String type
      Can be either "started", "resumed", "suspended", "ended" or "failed".
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isTypeEnded()
      Returns whether the InteractionLifecycleEvent has a type of "ended".
      boolean isTypeResumed()
      Returns whether the InteractionLifecycleEvent has a type of "resumed".
      boolean isTypeStarted()
      Returns whether the InteractionLifecycleEvent has a type of "started".
      boolean isTypeSuspended()
      Returns whether the InteractionLifecycleEvent has a type of "suspended".
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • type

        @SerializedName("type")
        public java.lang.String type
        Can be either "started", "resumed", "suspended", "ended" or "failed".
      • reason

        @SerializedName("reason")
        public java.lang.String reason
        Only set if type is "failed". Reason for failure.
      • sourceUri

        @SerializedName("source_uri")
        public java.lang.String sourceUri
        The interaction URN.
    • Constructor Detail

      • InteractionLifecycleEvent

        public InteractionLifecycleEvent()
    • Method Detail

      • isTypeStarted

        public boolean isTypeStarted()
        Returns whether the InteractionLifecycleEvent has a type of "started".
        Returns:
        true if the type is "started", false otherwise.
      • isTypeEnded

        public boolean isTypeEnded()
        Returns whether the InteractionLifecycleEvent has a type of "ended".
        Returns:
        true if the type is "ended", false otherwise.
      • isTypeResumed

        public boolean isTypeResumed()
        Returns whether the InteractionLifecycleEvent has a type of "resumed".
        Returns:
        true if the type is "resumed", false otherwise.
      • isTypeSuspended

        public boolean isTypeSuspended()
        Returns whether the InteractionLifecycleEvent has a type of "suspended".
        Returns:
        true if the type is "suspended", false otherwise.