Package software.xdev.brevo.model

Class Event

java.lang.Object
software.xdev.brevo.model.Event
public class Event extends Object
Event

  • Field Details

  • Constructor Details

    • Event

      public Event()

  • Method Details

    • eventName

      public Event eventName(@Nonnull String eventName)

    • getEventName

      @Nonnull public String getEventName()
      The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only.
      Returns:
      eventName

    • setEventName

      public void setEventName(@Nonnull String eventName)

    • eventDate

      public Event eventDate(@Nullable String eventDate)

    • getEventDate

      @Nullable public String getEventDate()
      Timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used.
      Returns:
      eventDate

    • setEventDate

      public void setEventDate(@Nullable String eventDate)

    • identifiers

      public Event identifiers(@Nonnull EventIdentifiers identifiers)

    • getIdentifiers

      @Nonnull public EventIdentifiers getIdentifiers()
      Get identifiers
      Returns:
      identifiers

    • setIdentifiers

      public void setIdentifiers(@Nonnull EventIdentifiers identifiers)

    • contactProperties

      public Event contactProperties(@Nullable Map<String,EventContactPropertiesValue> contactProperties)

    • putContactPropertiesItem

      public Event putContactPropertiesItem(String key, EventContactPropertiesValue contactPropertiesItem)

    • getContactProperties

      @Nullable public Map<String,EventContactPropertiesValue> getContactProperties()
      Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37**
      Returns:
      contactProperties

    • setContactProperties

      public void setContactProperties(@Nullable Map<String,EventContactPropertiesValue> contactProperties)

    • eventProperties

      public Event eventProperties(@Nullable Map<String,EventEventPropertiesValue> eventProperties)

    • putEventPropertiesItem

      public Event putEventPropertiesItem(String key, EventEventPropertiesValue eventPropertiesItem)

    • getEventProperties

      @Nullable public Map<String,EventEventPropertiesValue> getEventProperties()
      Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb.
      Returns:
      eventProperties

    • setEventProperties

      public void setEventProperties(@Nullable Map<String,EventEventPropertiesValue> eventProperties)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string