Package com.intercom.api.types

Class Visitor

java.lang.Object
com.intercom.api.types.Visitor
public final class Visitor extends Object

  • Method Details

    • getType

      public String getType()
      Returns:
      Value is 'visitor'

    • getId

      public String getId()
      Returns:
      The Intercom defined id representing the Visitor.

    • getUserId

      public String getUserId()
      Returns:
      Automatically generated identifier for the Visitor.

    • getAnonymous

      public boolean getAnonymous()
      Returns:
      Identifies if this visitor is anonymous.

    • getEmail

      public String getEmail()
      Returns:
      The email of the visitor.

    • getPhone

      public Optional<String> getPhone()
      Returns:
      The phone number of the visitor.

    • getName

      public Optional<String> getName()
      Returns:
      The name of the visitor.

    • getPseudonym

      public Optional<String> getPseudonym()
      Returns:
      The pseudonym of the visitor.

    • getAvatar

      public Optional<Visitor.Avatar> getAvatar()

    • getAppId

      public String getAppId()
      Returns:
      The id of the app the visitor is associated with.

    • getCompanies

      public Optional<Visitor.Companies> getCompanies()

    • getLocationData

      public Optional<Visitor.LocationData> getLocationData()

    • getLasRequestAt

      public Optional<Integer> getLasRequestAt()
      Returns:
      The time the Lead last recorded making a request.

    • getCreatedAt

      public int getCreatedAt()
      Returns:
      The time the Visitor was added to Intercom.

    • getRemoteCreatedAt

      public Optional<Integer> getRemoteCreatedAt()
      Returns:
      The time the Visitor was added to Intercom.

    • getSignedUpAt

      public int getSignedUpAt()
      Returns:
      The time the Visitor signed up for your product.

    • getUpdatedAt

      public Optional<Integer> getUpdatedAt()
      Returns:
      The last time the Visitor was updated.

    • getSessionCount

      public Optional<Integer> getSessionCount()
      Returns:
      The number of sessions the Visitor has had.

    • getSocialProfiles

      public Optional<Visitor.SocialProfiles> getSocialProfiles()

    • getOwnerId

      public Optional<String> getOwnerId()
      Returns:
      The id of the admin that owns the Visitor.

    • getUnsubscribedFromEmails

      public Optional<Boolean> getUnsubscribedFromEmails()
      Returns:
      Whether the Visitor is unsubscribed from emails.

    • getMarkedEmailAsSpam

      public Optional<Boolean> getMarkedEmailAsSpam()
      Returns:
      Identifies if this visitor has marked an email as spam.

    • getHasHardBounced

      public Optional<Boolean> getHasHardBounced()
      Returns:
      Identifies if this visitor has had a hard bounce.

    • getTags

      public Optional<Visitor.Tags> getTags()

    • getSegments

      public Optional<Visitor.Segments> getSegments()

    • getCustomAttributes

      public Optional<Map<String,Object>> getCustomAttributes()
      Returns:
      The custom attributes you have set on the Visitor.

    • getReferrer

      public Optional<String> getReferrer()
      Returns:
      The referer of the visitor.

    • getUtmCampaign

      public Optional<String> getUtmCampaign()
      Returns:
      The utm_campaign of the visitor.

    • getUtmContent

      public Optional<String> getUtmContent()
      Returns:
      The utm_content of the visitor.

    • getUtmMedium

      public Optional<String> getUtmMedium()
      Returns:
      The utm_medium of the visitor.

    • getUtmSource

      public Optional<String> getUtmSource()
      Returns:
      The utm_source of the visitor.

    • getUtmTerm

      public Optional<String> getUtmTerm()
      Returns:
      The utm_term of the visitor.

    • getDoNotTrack

      public Optional<Boolean> getDoNotTrack()
      Returns:
      Identifies if this visitor has do not track enabled.

    • equals

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

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static Visitor.IdStage builder()