Package com.azure.messaging.eventgrid.systemevents

Class AcsEmailEngagementTrackingReportReceivedEventData

java.lang.Object
com.azure.messaging.eventgrid.systemevents.AcsEmailEngagementTrackingReportReceivedEventData
All Implemented Interfaces:
com.azure.json.JsonSerializable<AcsEmailEngagementTrackingReportReceivedEventData>
public final class AcsEmailEngagementTrackingReportReceivedEventData extends Object implements com.azure.json.JsonSerializable<AcsEmailEngagementTrackingReportReceivedEventData>
Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.

  • Method Details

    • getSender

      public String getSender()
      Get the sender property: The Sender Email Address.
      Returns:
      the sender value.

    • getRecipient

      public String getRecipient()
      Get the recipient property: The Recipient Email Address.
      Returns:
      the recipient value.

    • getMessageId

      public String getMessageId()
      Get the messageId property: The Id of the email that has been sent.
      Returns:
      the messageId value.

    • getUserActionTimestamp

      public OffsetDateTime getUserActionTimestamp()
      Get the userActionTimestamp property: The time at which the user interacted with the email.
      Returns:
      the userActionTimestamp value.

    • getEngagementContext

      public String getEngagementContext()
      Get the engagementContext property: The context of the type of engagement user had with email.
      Returns:
      the engagementContext value.

    • getUserAgent

      public String getUserAgent()
      Get the userAgent property: The user agent interacting with the email.
      Returns:
      the userAgent value.

    • getEngagementType

      public AcsUserEngagement getEngagementType()
      Get the engagementType property: The type of engagement user have with email.
      Returns:
      the engagementType value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AcsEmailEngagementTrackingReportReceivedEventData>
      Throws:
      IOException

    • fromJson

      public static AcsEmailEngagementTrackingReportReceivedEventData fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AcsEmailEngagementTrackingReportReceivedEventData from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AcsEmailEngagementTrackingReportReceivedEventData if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AcsEmailEngagementTrackingReportReceivedEventData.