Skip to content

Commit

Permalink
Updating KDoc for SDK version 34.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanlogan committed Jan 9, 2025
1 parent 05258fe commit d8b7c55
Show file tree
Hide file tree
Showing 2,621 changed files with 6,444 additions and 5,259 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span><span>Builder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span><span>build</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">BrazeConfig</a></div><p class="paragraph">Builds the configuration object.</p><p class="paragraph">Note that unset fields won't have defaults set and will not be present in the built BrazeConfig object. I.e. if you only set the one field in this builder, the built config object will only contain a non-null value for that one field.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">a config object using the fields set in this builder</p></span></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand Down Expand Up @@ -236,7 +236,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-default-notification-accent-color.html"><span class="token function">setDefaultNotificationAccentColor</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultNotificationAccentColor<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><div class="brief "><p class="paragraph">This integer sets the default accent color for push notifications on Android Lollipop and higher. If not specified, the default background color is gray (the same gray Lollipop uses for system notifications). This value can be overridden at runtime by a push notification that sets a custom accent color.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-default-notification-accent-color.html"><span class="token function">setDefaultNotificationAccentColor</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultNotificationAccentColor<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><div class="brief "><p class="paragraph">This integer sets the default accent color for push notifications. If not specified, the default background color is gray (the same gray Android uses for system notifications). This value can be overridden at runtime by a push notification that sets a custom accent color.</p></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -781,6 +781,21 @@ <h2 class="">Functions</h2>
</div>
</div>
</div>
<a data-name="1325075565%2FFunctions%2F-1725759721" anchor-label="setShouldAddStatusBarPaddingToInAppMessages" id="1325075565%2FFunctions%2F-1725759721" data-filterable-set=":android-sdk-ui:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":android-sdk-ui:dokkaHtml/release" data-filterable-set=":android-sdk-ui:dokkaHtml/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="set-should-add-status-bar-padding-to-in-app-messages.html"><span>set</span><wbr></wbr><span>Should</span><wbr></wbr><span>Add</span><wbr></wbr><span>Status</span><wbr></wbr><span>Bar</span><wbr></wbr><span>Padding</span><wbr></wbr><span>To</span><wbr></wbr><span>In</span><wbr></wbr><span>App</span><wbr></wbr><span><span>Messages</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1325075565%2FFunctions%2F-1725759721"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-should-add-status-bar-padding-to-in-app-messages.html"><span class="token function">setShouldAddStatusBarPaddingToInAppMessages</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">enabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><div class="brief "><p class="paragraph">Sets whether In-App Messages should be padded at the top by the height of the status bar. This is used in situations where the Braze SDK is unable to properly determine if the status bar is transparent or not. This situation can occur when using a cross-platform framework.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1301315230%2FFunctions%2F-1725759721" anchor-label="setShouldPreventInAppMessageDisplayForDifferentUsers" id="-1301315230%2FFunctions%2F-1725759721" data-filterable-set=":android-sdk-ui:dokkaHtml/release"></a>
<div class="table-row" data-filterable-current=":android-sdk-ui:dokkaHtml/release" data-filterable-set=":android-sdk-ui:dokkaHtml/release">
<div class="main-subrow keyValue ">
Expand Down Expand Up @@ -862,7 +877,7 @@ <h2 class="">Functions</h2>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span>set</span><wbr></wbr><span>Adm</span><wbr></wbr><span>Me
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-adm-messaging-registration-enabled.html"><span class="token function">setAdmMessagingRegistrationEnabled</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">admMessagingRegistrationEnabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><p class="paragraph">Enables automatic registration for Amazon Device Messaging. When manually passing ADM push tokens to Braze, this setting should be disabled.</p><p class="paragraph">Defaults to false.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":android-sdk-ui:dokkaHtml/release" data-filterable-set=":android-sdk-ui:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>adm</span><wbr></wbr><span>Messaging</span><wbr></wbr><span>Registration</span><wbr></wbr><span><span>Enabled</span></span></u></div></span></div><div><div class="title"><p class="paragraph">when true, enables automatic registration for ADM Push</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span>set</span><wbr></wbr><span>Api</span><wbr></wbr><span><s
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-api-key.html"><span class="token function">setApiKey</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">apiKey<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><p class="paragraph">Sets the API key. An empty API key will have no effect and will not be present in the built config object.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":android-sdk-ui:dokkaHtml/release" data-filterable-set=":android-sdk-ui:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>api</span><wbr></wbr><span><span>Key</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the API key</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span>set</span><wbr></wbr><span>Automatic</span><wbr></wbr><s
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-automatic-geofence-requests-enabled.html"><span class="token function">setAutomaticGeofenceRequestsEnabled</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">enabled<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><p class="paragraph">Sets whether Braze Geofences are automatically requested by the Braze SDK. This defaults to true.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
33.1.0 </div>
34.0.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":android-sdk-ui:dokkaHtml/release">androidJvm</button>
Expand All @@ -69,7 +69,7 @@ <h1 class="cover"><span>set</span><wbr></wbr><span>Bad</span><wbr></wbr><span>Ne
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":android-sdk-ui:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">fun </span><a href="set-bad-network-data-flush-interval.html"><span class="token function">setBadNetworkDataFlushInterval</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">badNetworkIntervalSeconds<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">BrazeConfig.Builder</a></div><p class="paragraph">Sets the data flush interval on poor connections. On <a href="https://developer.android.com/reference/kotlin/android/os/Build.VERSION_CODES.html#n">android.os.Build.VERSION_CODES.N</a> and below, this for example is GPRS and/or EDGE. Otherwise, this is defined as roaming data connections or connections where the max network link upstream/downstream bandwidth is below 4 Mbps.</p><p class="paragraph">Defaults to 60 seconds.</p><p class="paragraph">To disable automatic flushing in this network condition, simply set the value to -1. To turn off all automatic data flushing, set all three network intervals to -1. When automatic flushing is disabled, you can use IBraze.requestImmediateDataFlush to manually flush analytics data to the server. Note, however, that any refreshes of the news feed, or in-app message will automatically flush your analytics data as well.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":android-sdk-ui:dokkaHtml/release" data-filterable-set=":android-sdk-ui:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>bad</span><wbr></wbr><span>Network</span><wbr></wbr><span>Interval</span><wbr></wbr><span><span>Seconds</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the data flush interval in seconds</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
<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>
</div>
Expand Down
Loading

0 comments on commit d8b7c55

Please sign in to comment.