Skip to content

Commit 0ec07b8

Browse files
authored
Update doc (#652)
1 parent 54f556c commit 0ec07b8

File tree

1,599 files changed

+5014
-4859
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,599 files changed

+5014
-4859
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Unreleased
1+
## [0.24.0] - 2025-02-20
22

33
### Fixed
44
* When meeting has ended normally, but not initiated by the client, send a meetingEnded event rather than a meetingFailed event.

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/-default-event-analytics-controller.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>Default</span><wbr><span>Event</span><wbr><span>Analytic
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">logger<span class="token operator">: </span><a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html">Logger</a><span class="token punctuation">, </span></span><span class="parameter ">meetingSessionConfiguration<span class="token operator">: </span><a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html">MeetingSessionConfiguration</a><span class="token punctuation">, </span></span><span class="parameter ">meetingStatsCollector<span class="token operator">: </span><a href="../-meeting-stats-collector/index.html">MeetingStatsCollector</a><span class="token punctuation">, </span></span><span class="parameter ">eventReporter<span class="token operator">: </span><a href="../../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html">EventReporter</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/add-event-analytics-observer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>add</span><wbr><span>Event</span><wbr><span>Analytics</s
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="add-event-analytics-observer.html"><span class="token function">addEventAnalyticsObserver</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">observer<span class="token operator">: </span><a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Add specified <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":amazon-chime-sdk:dokkaHtmlPartial/release" data-filterable-set=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>observer</span></span></u></div></span></div><div><div class="title"><p class="paragraph">: <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a> - The observer to subscribe to events with.</p></div></div></div></div></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/get-common-event-attributes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>get</span><wbr><span>Common</span><wbr><span>Event</span
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="get-common-event-attributes.html"><span class="token function">getCommonEventAttributes</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-event-attributes/index.html">EventAttributes</a></div><p class="paragraph">Retrieve common attributes, including deviceName, osName, and more.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/get-meeting-history.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@
6363
<div class="cover ">
6464
<h1 class="cover"><span>get</span><wbr><span>Meeting</span><wbr><span><span>History</span></span></h1>
6565
</div>
66-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="get-meeting-history.html"><span class="token function">getMeetingHistory</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../-meeting-history-event/index.html">MeetingHistoryEvent</a><span class="token operator">&gt;</span></div><p class="paragraph">Retrieve meeting history.</p></div></div>
66+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="get-meeting-history.html"><span class="token function">getMeetingHistory</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../-meeting-history-event/index.html">MeetingHistoryEvent</a><span class="token operator">&gt;</span></div><p class="paragraph">Retrieve meeting history.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 class="">Functions</h2>
128128
</span></span></div>
129129
<div>
130130
<div class="title">
131-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="get-meeting-history.html"><span class="token function">getMeetingHistory</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../-meeting-history-event/index.html">MeetingHistoryEvent</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Retrieve meeting history.</p></div></div></div>
131+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="get-meeting-history.html"><span class="token function">getMeetingHistory</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../-meeting-history-event/index.html">MeetingHistoryEvent</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Retrieve meeting history.</p></div></div></div>
132132
</div>
133133
</div>
134134
</div>
@@ -184,7 +184,7 @@ <h2 class="">Functions</h2>
184184
</div>
185185
</div>
186186
<div class="footer">
187-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
187+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
188188
</div>
189189
</div>
190190
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/publish-event.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>publish</span><wbr><span><span>Event</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="publish-event.html"><span class="token function">publishEvent</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<span class="token operator">: </span><a href="../-event-name/index.html">EventName</a><span class="token punctuation">, </span></span><span class="parameter ">attributes<span class="token operator">: </span><a href="../-event-attributes/index.html">EventAttributes</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Publish an event with updated <a href="../-event-attributes/index.html">EventAttributes</a>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":amazon-chime-sdk:dokkaHtmlPartial/release" data-filterable-set=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>name</span></span></u></div></span></div><div><div class="title"><p class="paragraph">: <a href="../-event-name/index.html">EventName</a> - Name of event to publish</p></div></div></div></div><div class="table-row" data-filterable-current=":amazon-chime-sdk:dokkaHtmlPartial/release" data-filterable-set=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>attributes</span></span></u></div></span></div><div><div class="title"><p class="paragraph">: <a href="../-event-attributes/index.html">EventAttributes</a> - Attributes of event to pass to builders.</p></div></div></div></div></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/push-history.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>push</span><wbr><span><span>History</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="push-history.html"><span class="token function">pushHistory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">historyEventName<span class="token operator">: </span><a href="../-meeting-history-event-name/index.html">MeetingHistoryEventName</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Push <a href="../-meeting-history-event-name/index.html">MeetingHistoryEventName</a> to internal <a href="../-meeting-stats-collector/index.html">MeetingStatsCollector</a>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":amazon-chime-sdk:dokkaHtmlPartial/release" data-filterable-set=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>history</span><wbr><span>Event</span><wbr><span><span>Name</span></span></u></div></span></div><div><div class="title"><p class="paragraph">: MeetingHistoryEventName - History event name to add.</p></div></div></div></div></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/remove-event-analytics-observer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>remove</span><wbr><span>Event</span><wbr><span>Analytics
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="remove-event-analytics-observer.html"><span class="token function">removeEventAnalyticsObserver</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">observer<span class="token operator">: </span><a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Remove specified <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":amazon-chime-sdk:dokkaHtmlPartial/release" data-filterable-set=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>observer</span></span></u></div></span></div><div><div class="title"><p class="paragraph">: <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a> - The observer to unsubscribe from events with.</p></div></div></div></div></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-meeting-stats-collector/-default-meeting-stats-collector.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>Default</span><wbr><span>Meeting</span><wbr><span>Stats<
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":amazon-chime-sdk:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">logger<span class="token operator">: </span><a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html">Logger</a></span></span><span class="token punctuation">)</span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

0 commit comments

Comments
 (0)