• Home
• aws.sdk.kotlin
• chimesdkmeetings-jvm
• 1.3.12
• source code
• CreateAttendeeRequest.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.aws.sdk.kotlin.services.chimesdkmeetings.model.CreateAttendeeRequest.kt Maven / Gradle / Ivy

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.chimesdkmeetings.model

import aws.smithy.kotlin.runtime.SdkDsl

public class CreateAttendeeRequest private constructor(builder: Builder) {
    /**
     * 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.
     */
    public val capabilities: aws.sdk.kotlin.services.chimesdkmeetings.model.AttendeeCapabilities? = builder.capabilities
    /**
     * 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.
     */
    public val externalUserId: kotlin.String? = builder.externalUserId
    /**
     * The unique ID of the meeting.
     */
    public val meetingId: kotlin.String? = builder.meetingId

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.chimesdkmeetings.model.CreateAttendeeRequest = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("CreateAttendeeRequest(")
        append("capabilities=$capabilities,")
        append("externalUserId=*** Sensitive Data Redacted ***,")
        append("meetingId=$meetingId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = capabilities?.hashCode() ?: 0
        result = 31 * result + (externalUserId?.hashCode() ?: 0)
        result = 31 * result + (meetingId?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as CreateAttendeeRequest

        if (capabilities != other.capabilities) return false
        if (externalUserId != other.externalUserId) return false
        if (meetingId != other.meetingId) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.chimesdkmeetings.model.CreateAttendeeRequest = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * 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.
         */
        public var capabilities: aws.sdk.kotlin.services.chimesdkmeetings.model.AttendeeCapabilities? = null
        /**
         * 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.
         */
        public var externalUserId: kotlin.String? = null
        /**
         * The unique ID of the meeting.
         */
        public var meetingId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.chimesdkmeetings.model.CreateAttendeeRequest) : this() {
            this.capabilities = x.capabilities
            this.externalUserId = x.externalUserId
            this.meetingId = x.meetingId
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.chimesdkmeetings.model.CreateAttendeeRequest = CreateAttendeeRequest(this)

        /**
         * construct an [aws.sdk.kotlin.services.chimesdkmeetings.model.AttendeeCapabilities] inside the given [block]
         */
        public fun capabilities(block: aws.sdk.kotlin.services.chimesdkmeetings.model.AttendeeCapabilities.Builder.() -> kotlin.Unit) {
            this.capabilities = aws.sdk.kotlin.services.chimesdkmeetings.model.AttendeeCapabilities.invoke(block)
        }

        internal fun correctErrors(): Builder {
            return this
        }
    }
}