Class ParticipantCapabilities

java.lang.Object
software.amazon.awssdk.services.connect.model.ParticipantCapabilities
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParticipantCapabilities.Builder,ParticipantCapabilities>
@Generated("software.amazon.awssdk:codegen") public final class ParticipantCapabilities extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParticipantCapabilities.Builder,ParticipantCapabilities>

The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

See Also:

  • Method Details

    • video

      public final VideoCapability video()

      The configuration having the video and screen sharing capabilities for participants over the call.

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

      Returns:
      The configuration having the video and screen sharing capabilities for participants over the call.
      See Also:

    • videoAsString

      public final String videoAsString()

      The configuration having the video and screen sharing capabilities for participants over the call.

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

      Returns:
      The configuration having the video and screen sharing capabilities for participants over the call.
      See Also:

    • screenShare

      public final ScreenShareCapability screenShare()

      The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.

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

      Returns:
      The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
      See Also:

    • screenShareAsString

      public final String screenShareAsString()

      The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.

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

      Returns:
      The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
      See Also:

    • toBuilder

      public ParticipantCapabilities.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParticipantCapabilities.Builder,ParticipantCapabilities>
      Returns:
      a builder for type T

    • builder

      public static ParticipantCapabilities.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParticipantCapabilities.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.