ChimeSdkMeetings class
The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.
Constructors
- ChimeSdkMeetings({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchCreateAttendee(
{required List< CreateAttendeeRequestItem> attendees, required String meetingId}) → Future<BatchCreateAttendeeResponse> - Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
batchUpdateAttendeeCapabilitiesExcept(
{required AttendeeCapabilities capabilities, required List< AttendeeIdItem> excludedAttendeeIds, required String meetingId}) → Future<void> -
Updates
AttendeeCapabilitiesexcept the capabilities listed in anExcludedAttendeeIdstable. When using capabilities, be aware of these corner cases: -
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createAttendee(
{required String externalUserId, required String meetingId, AttendeeCapabilities? capabilities}) → Future< CreateAttendeeResponse> - Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
createMeeting(
{required String externalMeetingId, required String mediaRegion, String? clientRequestToken, MediaPlacementNetworkType? mediaPlacementNetworkType, MeetingFeaturesConfiguration? meetingFeatures, String? meetingHostId, NotificationsConfiguration? notificationsConfiguration, String? primaryMeetingId, List< Tag> ? tags, List<String> ? tenantIds}) → Future<CreateMeetingResponse> - Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
-
createMeetingWithAttendees(
{required List< CreateAttendeeRequestItem> attendees, required String externalMeetingId, required String mediaRegion, String? clientRequestToken, MediaPlacementNetworkType? mediaPlacementNetworkType, MeetingFeaturesConfiguration? meetingFeatures, String? meetingHostId, NotificationsConfiguration? notificationsConfiguration, String? primaryMeetingId, List<Tag> ? tags, List<String> ? tenantIds}) → Future<CreateMeetingWithAttendeesResponse> - Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.
-
deleteAttendee(
{required String attendeeId, required String meetingId}) → Future< void> -
Deletes an attendee from the specified Amazon Chime SDK meeting and
deletes their
JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide. -
deleteMeeting(
{required String meetingId}) → Future< void> - Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
getAttendee(
{required String attendeeId, required String meetingId}) → Future< GetAttendeeResponse> - Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
getMeeting(
{required String meetingId}) → Future< GetMeetingResponse> - Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
listAttendees(
{required String meetingId, int? maxResults, String? nextToken}) → Future< ListAttendeesResponse> - Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
-
listTagsForResource(
{required String resourceARN}) → Future< ListTagsForResourceResponse> - Returns a list of the tags available for the specified resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
startMeetingTranscription(
{required String meetingId, required TranscriptionConfiguration transcriptionConfiguration}) → Future< void> -
Starts transcription for the specified
meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. -
stopMeetingTranscription(
{required String meetingId}) → Future< void> -
Stops transcription for the specified
meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. -
tagResource(
{required String resourceARN, required List< Tag> tags}) → Future<void> - The resource that supports tags.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceARN, required List< String> tagKeys}) → Future<void> - Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
-
updateAttendeeCapabilities(
{required String attendeeId, required AttendeeCapabilities capabilities, required String meetingId}) → Future< UpdateAttendeeCapabilitiesResponse> - The capabilities that you want to update. When using capabilities, be aware of these corner cases:
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited