Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffdgr8 committed Dec 14, 2024
1 parent 7acfabf commit 4286093
Show file tree
Hide file tree
Showing 192 changed files with 194 additions and 194 deletions.
2 changes: 1 addition & 1 deletion docs/api/couchbase-lite-ee/kotbase/-blob/-blob.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="cover"><span>content</span><wbr><span><span>Stream</span></span></h1>
</div>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":couchbase-lite-ee:dokkaHtmlPartial/commonMain" data-filterable-set=":couchbase-lite-ee:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":couchbase-lite-ee:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":couchbase-lite-ee:dokkaHtmlPartial/jvmCommonMain" data-filterable-set=":couchbase-lite-ee:dokkaHtmlPartial/jvmCommonMain" data-toggle=":couchbase-lite-ee:dokkaHtmlPartial/jvmCommonMain">jvmCommon</button><button class="platform-bookmark" data-filterable-current=":couchbase-lite-ee:dokkaHtmlPartial/linuxMingwMain" data-filterable-set=":couchbase-lite-ee:dokkaHtmlPartial/linuxMingwMain" data-toggle=":couchbase-lite-ee:dokkaHtmlPartial/linuxMingwMain">linuxMingw</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://fzhinkin.github.io/kotlinx-io-dokka-docs-preview/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/commonMain/kotlin/kotbase/Blob.kt#L76">source</a>)</span></span></div><p class="paragraph">Get the contents of this blob as a stream. The caller is responsible for closing the stream returned by this call. Closing or deleting the database before this call completes may cause it to fail. <strong>When called on a blob created from a stream (or a file path), this method will return null!</strong></p></div><div class="content sourceset-dependent-content" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/jvmCommonMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://fzhinkin.github.io/kotlinx-io-dokka-docs-preview/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/jvmCommonMain/kotlin/kotbase/Blob.jvmCommon.kt#L46">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/linuxMingwMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://fzhinkin.github.io/kotlinx-io-dokka-docs-preview/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/linuxMingwMain/kotlin/kotbase/Blob.linuxMingw.kt#L159">source</a>)</span></span></div></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/kotlinx-io/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/commonMain/kotlin/kotbase/Blob.kt#L76">source</a>)</span></span></div><p class="paragraph">Get the contents of this blob as a stream. The caller is responsible for closing the stream returned by this call. Closing or deleting the database before this call completes may cause it to fail. <strong>When called on a blob created from a stream (or a file path), this method will return null!</strong></p></div><div class="content sourceset-dependent-content" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/jvmCommonMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/kotlinx-io/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/jvmCommonMain/kotlin/kotbase/Blob.jvmCommon.kt#L46">source</a>)</span></span></div></div><div class="content sourceset-dependent-content" data-togglable=":couchbase-lite-ee:dokkaHtmlPartial/linuxMingwMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">val </span><a href="content-stream.html">contentStream</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/kotlinx-io/kotlinx-io-core/kotlinx.io/-source/index.html">Source</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/jeffdgr8/kotbase/tree/main/couchbase-lite-ee/src/linuxMingwMain/kotlin/kotbase/Blob.linuxMingw.kt#L159">source</a>)</span></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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Loading

0 comments on commit 4286093

Please sign in to comment.