Package com.mypurecloud.sdk.v2.model

Class Session

java.lang.Object
com.mypurecloud.sdk.v2.model.Session
All Implemented Interfaces:
Serializable
public class Session extends Object implements Serializable
Session
See Also:

  • Constructor Details

    • Session

      public Session()

    • Session

      public Session(Boolean initWithEmptyList)

  • Method Details

    • id

      public Session id(String id)
      The ID of the session.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • externalContact

      public Session externalContact(AddressableEntityRef externalContact)
      The external contact associated with this session.

    • getExternalContact

      public AddressableEntityRef getExternalContact()

    • setExternalContact

      public void setExternalContact(AddressableEntityRef externalContact)

    • customerId

      public Session customerId(String customerId)
      Primary identifier of the customer in the source where the events for the session originate from.

    • getCustomerId

      public String getCustomerId()

    • setCustomerId

      public void setCustomerId(String customerId)

    • customerIdType

      public Session customerIdType(String customerIdType)
      Type of source customer identifier (e.g. cookie, email, phone).

    • getCustomerIdType

      public String getCustomerIdType()

    • setCustomerIdType

      public void setCustomerIdType(String customerIdType)

    • type

      public Session type(String type)
      Session types indicate the type or category of sessions (e.g. web, app).

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • externalId

      public Session externalId(String externalId)
      Unique identifier in the external system where the events for the session originate from.

    • getExternalId

      public String getExternalId()

    • setExternalId

      public void setExternalId(String externalId)

    • externalUrl

      public Session externalUrl(String externalUrl)
      A URL that identifies an external system-of-record resource that may have more detailed information on the session.

    • getExternalUrl

      public String getExternalUrl()

    • setExternalUrl

      public void setExternalUrl(String externalUrl)

    • shortId

      public Session shortId(String shortId)
      Shortened numeric identifier of 4-6 digits.

    • getShortId

      public String getShortId()

    • setShortId

      public void setShortId(String shortId)

    • outcomeAchievements

      public Session outcomeAchievements(List<OutcomeAchievement> outcomeAchievements)
      Deprecated. List of the outcome achievements by the customer in this session. Journey Outcomes is being removed. See https://help.genesys.cloud/announcements/genesys-cloud/deprecation-journey-outcomes/

    • getOutcomeAchievements

      public List<OutcomeAchievement> getOutcomeAchievements()

    • setOutcomeAchievements

      public void setOutcomeAchievements(List<OutcomeAchievement> outcomeAchievements)

    • segmentAssignments

      public Session segmentAssignments(List<SessionSegmentAssignment> segmentAssignments)
      List of the segment assignments to the customer in this session.

    • getSegmentAssignments

      public List<SessionSegmentAssignment> getSegmentAssignments()

    • setSegmentAssignments

      public void setSegmentAssignments(List<SessionSegmentAssignment> segmentAssignments)

    • attributes

      public Session attributes(Map<String,CustomEventAttribute> attributes)
      Attributes projected from the session's event stream.

    • getAttributes

      public Map<String,CustomEventAttribute> getAttributes()

    • setAttributes

      public void setAttributes(Map<String,CustomEventAttribute> attributes)

    • attributeLists

      public Session attributeLists(Map<String,CustomEventAttributeList> attributeLists)
      List-type attributes projected from the session's event stream.

    • getAttributeLists

      public Map<String,CustomEventAttributeList> getAttributeLists()

    • setAttributeLists

      public void setAttributeLists(Map<String,CustomEventAttributeList> attributeLists)

    • browser

      public Session browser(Browser browser)
      Customer's browser.

    • getBrowser

      public Browser getBrowser()

    • setBrowser

      public void setBrowser(Browser browser)

    • device

      public Session device(Device device)
      Customer's device.

    • getDevice

      public Device getDevice()

    • setDevice

      public void setDevice(Device device)

    • geolocation

      public Session geolocation(JourneyGeolocation geolocation)
      Customer's geolocation.

    • getGeolocation

      public JourneyGeolocation getGeolocation()

    • setGeolocation

      public void setGeolocation(JourneyGeolocation geolocation)

    • ipAddress

      public Session ipAddress(String ipAddress)
      Customer's IP address.

    • getIpAddress

      public String getIpAddress()

    • setIpAddress

      public void setIpAddress(String ipAddress)

    • ipOrganization

      public Session ipOrganization(String ipOrganization)
      Customer's IP-based organization or ISP name.

    • getIpOrganization

      public String getIpOrganization()

    • setIpOrganization

      public void setIpOrganization(String ipOrganization)

    • lastPage

      public Session lastPage(JourneyPage lastPage)
      The webpage where the customer's last web interaction occurred.

    • getLastPage

      public JourneyPage getLastPage()

    • setLastPage

      public void setLastPage(JourneyPage lastPage)

    • mktCampaign

      public Session mktCampaign(JourneyCampaign mktCampaign)
      Marketing / traffic source information.

    • getMktCampaign

      public JourneyCampaign getMktCampaign()

    • setMktCampaign

      public void setMktCampaign(JourneyCampaign mktCampaign)

    • referrer

      public Session referrer(Referrer referrer)
      Identifies the page URL that originally generated the request for the current page being viewed.

    • getReferrer

      public Referrer getReferrer()

    • setReferrer

      public void setReferrer(Referrer referrer)

    • app

      public Session app(JourneyApp app)
      Application that the customer is interacting with (for app sessions).

    • getApp

      public JourneyApp getApp()

    • setApp

      public void setApp(JourneyApp app)

    • sdkLibrary

      public Session sdkLibrary(SdkLibrary sdkLibrary)
      SDK library used to generate the events for the session (for app and web sessions).

    • getSdkLibrary

      public SdkLibrary getSdkLibrary()

    • setSdkLibrary

      public void setSdkLibrary(SdkLibrary sdkLibrary)

    • networkConnectivity

      public Session networkConnectivity(NetworkConnectivity networkConnectivity)
      Information relating to the device's network connectivity (for app sessions).

    • getNetworkConnectivity

      public NetworkConnectivity getNetworkConnectivity()

    • setNetworkConnectivity

      public void setNetworkConnectivity(NetworkConnectivity networkConnectivity)

    • searchTerms

      public Session searchTerms(List<String> searchTerms)
      Search terms associated with the session.

    • getSearchTerms

      public List<String> getSearchTerms()

    • setSearchTerms

      public void setSearchTerms(List<String> searchTerms)

    • userAgentString

      public Session userAgentString(String userAgentString)
      String identifying the user agent.

    • getUserAgentString

      public String getUserAgentString()

    • setUserAgentString

      public void setUserAgentString(String userAgentString)

    • durationInSeconds

      public Session durationInSeconds(Integer durationInSeconds)
      Indicates how long the session has been active (valid for an individual device).

    • getDurationInSeconds

      public Integer getDurationInSeconds()

    • setDurationInSeconds

      public void setDurationInSeconds(Integer durationInSeconds)

    • eventCount

      public Session eventCount(Integer eventCount)
      The count of all events performed during the session.

    • getEventCount

      public Integer getEventCount()

    • setEventCount

      public void setEventCount(Integer eventCount)

    • pageviewCount

      public Session pageviewCount(Integer pageviewCount)
      The count of all pageviews performed during the session.

    • getPageviewCount

      public Integer getPageviewCount()

    • setPageviewCount

      public void setPageviewCount(Integer pageviewCount)

    • screenviewCount

      public Session screenviewCount(Integer screenviewCount)
      The count of all screenviews performed during the session.

    • getScreenviewCount

      public Integer getScreenviewCount()

    • setScreenviewCount

      public void setScreenviewCount(Integer screenviewCount)

    • lastEvent

      public Session lastEvent(SessionLastEvent lastEvent)
      Information about the most recent event in this session.

    • getLastEvent

      public SessionLastEvent getLastEvent()

    • setLastEvent

      public void setLastEvent(SessionLastEvent lastEvent)

    • conversation

      public Session conversation(AddressableEntityRef conversation)
      The conversation for this session.

    • getConversation

      public AddressableEntityRef getConversation()

    • setConversation

      public void setConversation(AddressableEntityRef conversation)

    • lastConnectedQueue

      public Session lastConnectedQueue(ConnectedQueue lastConnectedQueue)
      The last queue connected to this session.

    • getLastConnectedQueue

      public ConnectedQueue getLastConnectedQueue()

    • setLastConnectedQueue

      public void setLastConnectedQueue(ConnectedQueue lastConnectedQueue)

    • lastConnectedUser

      public Session lastConnectedUser(ConnectedUser lastConnectedUser)
      The last user connected to this session.

    • getLastConnectedUser

      public ConnectedUser getLastConnectedUser()

    • setLastConnectedUser

      public void setLastConnectedUser(ConnectedUser lastConnectedUser)

    • lastUserDisposition

      public Session lastUserDisposition(ConversationUserDisposition lastUserDisposition)
      The last user disposition connected to this session.

    • getLastUserDisposition

      public ConversationUserDisposition getLastUserDisposition()

    • setLastUserDisposition

      public void setLastUserDisposition(ConversationUserDisposition lastUserDisposition)

    • conversationChannels

      public Session conversationChannels(List<ConversationChannel> conversationChannels)
      Represents the channels used for this conversation.

    • getConversationChannels

      public List<ConversationChannel> getConversationChannels()

    • setConversationChannels

      public void setConversationChannels(List<ConversationChannel> conversationChannels)

    • originatingDirection

      public Session originatingDirection(Session.OriginatingDirectionEnum originatingDirection)
      The original direction of the conversation.

    • getOriginatingDirection

      public Session.OriginatingDirectionEnum getOriginatingDirection()

    • setOriginatingDirection

      public void setOriginatingDirection(Session.OriginatingDirectionEnum originatingDirection)

    • conversationSubject

      public Session conversationSubject(String conversationSubject)
      The subject for the conversation, for example an email subject.

    • getConversationSubject

      public String getConversationSubject()

    • setConversationSubject

      public void setConversationSubject(String conversationSubject)

    • lastUserDisconnectType

      public Session lastUserDisconnectType(Session.LastUserDisconnectTypeEnum lastUserDisconnectType)
      Disconnect reason for the last user connected to the conversation.

    • getLastUserDisconnectType

      public Session.LastUserDisconnectTypeEnum getLastUserDisconnectType()

    • setLastUserDisconnectType

      public void setLastUserDisconnectType(Session.LastUserDisconnectTypeEnum lastUserDisconnectType)

    • lastAcdOutcome

      public Session lastAcdOutcome(Session.LastAcdOutcomeEnum lastAcdOutcome)
      Last ACD outcome for the conversation.

    • getLastAcdOutcome

      public Session.LastAcdOutcomeEnum getLastAcdOutcome()

    • setLastAcdOutcome

      public void setLastAcdOutcome(Session.LastAcdOutcomeEnum lastAcdOutcome)

    • authenticated

      public Session authenticated(Boolean authenticated)
      Indicates whether or not the session is authenticated.

    • getAuthenticated

      public Boolean getAuthenticated()

    • setAuthenticated

      public void setAuthenticated(Boolean authenticated)

    • divisionIds

      public Session divisionIds(List<String> divisionIds)
      List of division IDs associated with the session.

    • getDivisionIds

      public List<String> getDivisionIds()

    • setDivisionIds

      public void setDivisionIds(List<String> divisionIds)

    • lastScreen

      public Session lastScreen(String lastScreen)
      The app screen name where the customer's last app interaction occurred.

    • getLastScreen

      public String getLastScreen()

    • setLastScreen

      public void setLastScreen(String lastScreen)

    • caseAssociations

      public Session caseAssociations(List<JourneyCaseAssociation> caseAssociations)
      Cases associated with the session - conversation only.

    • getCaseAssociations

      public List<JourneyCaseAssociation> getCaseAssociations()

    • setCaseAssociations

      public void setCaseAssociations(List<JourneyCaseAssociation> caseAssociations)

    • caseEntity

      public Session caseEntity(AddressableEntityRef caseEntity)
      The case this session refers to.

    • getCaseEntity

      public AddressableEntityRef getCaseEntity()

    • setCaseEntity

      public void setCaseEntity(AddressableEntityRef caseEntity)

    • caseReference

      public Session caseReference(String caseReference)
      The reference for this case.

    • getCaseReference

      public String getCaseReference()

    • setCaseReference

      public void setCaseReference(String caseReference)

    • caseStatus

      public Session caseStatus(Session.CaseStatusEnum caseStatus)
      The status of this case.

    • getCaseStatus

      public Session.CaseStatusEnum getCaseStatus()

    • setCaseStatus

      public void setCaseStatus(Session.CaseStatusEnum caseStatus)

    • getSelfUri

      public String getSelfUri()

    • createdDate

      public Session createdDate(Date createdDate)
      Timestamp indicating when the session was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getCreatedDate

      public Date getCreatedDate()

    • setCreatedDate

      public void setCreatedDate(Date createdDate)

    • endedDate

      public Session endedDate(Date endedDate)
      Timestamp indicating when the session was ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getEndedDate

      public Date getEndedDate()

    • setEndedDate

      public void setEndedDate(Date endedDate)

    • awayDate

      public Session awayDate(Date awayDate)
      Timestamp indicating when the visitor should be considered as away. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getAwayDate

      public Date getAwayDate()

    • setAwayDate

      public void setAwayDate(Date awayDate)

    • idleDate

      public Session idleDate(Date idleDate)
      Timestamp indicating when the visitor should be considered as idle. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getIdleDate

      public Date getIdleDate()

    • setIdleDate

      public void setIdleDate(Date idleDate)

    • 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