Class ProxySession

    • Method Detail

      • voiceConnectorId

        public final String voiceConnectorId()

        The Voice Connector ID.

        Returns:
        The Voice Connector ID.
      • proxySessionId

        public final String proxySessionId()

        The proxy session ID.

        Returns:
        The proxy session ID.
      • name

        public final String name()

        The proxy session name.

        Returns:
        The proxy session name.
      • expiryMinutes

        public final Integer expiryMinutes()

        The number of minutes allowed for the proxy session.

        Returns:
        The number of minutes allowed for the proxy session.
      • capabilities

        public final List<Capability> capabilities()

        The proxy session capabilities.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapabilities() method.

        Returns:
        The proxy session capabilities.
      • hasCapabilities

        public final boolean hasCapabilities()
        For responses, this returns true if the service returned a value for the Capabilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • capabilitiesAsStrings

        public final List<String> capabilitiesAsStrings()

        The proxy session capabilities.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapabilities() method.

        Returns:
        The proxy session capabilities.
      • createdTimestamp

        public final Instant createdTimestamp()

        The created time stamp, in ISO 8601 format.

        Returns:
        The created time stamp, in ISO 8601 format.
      • updatedTimestamp

        public final Instant updatedTimestamp()

        The updated time stamp, in ISO 8601 format.

        Returns:
        The updated time stamp, in ISO 8601 format.
      • endedTimestamp

        public final Instant endedTimestamp()

        The ended time stamp, in ISO 8601 format.

        Returns:
        The ended time stamp, in ISO 8601 format.
      • hasParticipants

        public final boolean hasParticipants()
        For responses, this returns true if the service returned a value for the Participants property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • participants

        public final List<Participant> participants()

        The proxy session participants.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParticipants() method.

        Returns:
        The proxy session participants.
      • geoMatchLevel

        public final GeoMatchLevel geoMatchLevel()

        The preference for matching the country or area code of the proxy phone number with that of the first participant.

        If the service returns an enum value that is not available in the current SDK version, geoMatchLevel will return GeoMatchLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from geoMatchLevelAsString().

        Returns:
        The preference for matching the country or area code of the proxy phone number with that of the first participant.
        See Also:
        GeoMatchLevel
      • geoMatchLevelAsString

        public final String geoMatchLevelAsString()

        The preference for matching the country or area code of the proxy phone number with that of the first participant.

        If the service returns an enum value that is not available in the current SDK version, geoMatchLevel will return GeoMatchLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from geoMatchLevelAsString().

        Returns:
        The preference for matching the country or area code of the proxy phone number with that of the first participant.
        See Also:
        GeoMatchLevel
      • geoMatchParams

        public final GeoMatchParams geoMatchParams()

        The country and area code for the proxy phone number.

        Returns:
        The country and area code for the proxy phone number.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)