Interface CreateAttendeeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ChimeSdkMeetingsRequest.Builder, CopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>, SdkBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAttendeeRequest
@Mutable @NotThreadSafe public static interface CreateAttendeeRequest.Builder extends ChimeSdkMeetingsRequest.Builder, SdkPojo, CopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>

  • Method Details

    • meetingId

      CreateAttendeeRequest.Builder meetingId(String meetingId)

      The unique ID of the meeting.

      Parameters:
      meetingId - The unique ID of the meeting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalUserId

      CreateAttendeeRequest.Builder externalUserId(String externalUserId)

      The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

      Parameters:
      externalUserId - The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

      Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

      Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      CreateAttendeeRequest.Builder capabilities(AttendeeCapabilities capabilities)

      The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      Parameters:
      capabilities - The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      default CreateAttendeeRequest.Builder capabilities(Consumer<AttendeeCapabilities.Builder> capabilities)

      The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

      You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see .

      When using capabilities, be aware of these corner cases:

      • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.

      • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.

      • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

      • When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.

      • When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

      This is a convenience method that creates an instance of the AttendeeCapabilities.Builder avoiding the need to create one manually via AttendeeCapabilities.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilities(AttendeeCapabilities).

      Parameters:
      capabilities - a consumer that will call methods on AttendeeCapabilities.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateAttendeeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAttendeeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.