{{name}}
{{/hide_name}} 31 | {{#declaration}} 32 |
33 |
37 | {{/declaration}}
38 | {{{overview}}}
39 |
34 | {{{declaration}}}
35 |
36 |
4 | 
5 |
6 |
7 | [ObjectBox Swift](https://github.com/objectbox/objectbox-swift) is a superfast, light-weight object persistence framework for iOS and macOS.
8 |
9 | This is the ObjectBox Swift **API reference**.
10 | Check **[the documentation](https://swift.objectbox.io/)** on how to install and use ObjectBox Swift.
11 |
12 | This documents API version: 4.3.0
13 |
14 | ## Most Important Types
15 |
16 | - `Store`: database entry point and source of `Box`es.
17 | - `Box`: main interface to persist objects and create `Query`s.
18 | - `Entity`: protocol to mark your type as persistable by ObjectBox.
19 | - `Id`: identifies object instances in the database.
20 | - `Query`: conditional fetching of objects of a certain type.
21 |
22 | ## Please let us know your feedback
23 |
24 | We want ObjectBox to be not only the fastest, but also the most Swift-friendly persistence solution.
25 |
26 | To do that, we want your feedback: what do you love? What's amiss?
27 | Where do you struggle in everyday app development?
28 |
29 | We're looking forward to receiving your comments and requests:
30 |
31 | - Take this [short questionnaire](https://docs.google.com/forms/d/e/1FAIpQLSd0neiviD0Yal0Tn7921w-XWI2d0ONpLm7TfVKp7OvwW2Tu2A/viewform?usp=sf_link) (takes only 1 or 2 minutes)
32 | - Add [GitHub issues](https://github.com/objectbox/objectbox-swift/issues) and
33 | - Upvote issues you find important by hitting the 👍/+1 reaction button!
34 |
35 | Thank you!
36 |
37 | ## Keep in touch
38 |
39 | For general news on ObjectBox, [check our blog](https://objectbox.io/blog).
40 |
--------------------------------------------------------------------------------
/Source/ios-framework/cocoapod/README.md:
--------------------------------------------------------------------------------
1 | ObjectBox Swift
2 | ===============
3 |
4 | [](https://cocoapods.org/pods/ObjectBox)
5 | [](https://cocoapods.org/pods/ObjectBox)
6 | [](https://cocoapods.org/pods/ObjectBox)
7 |
8 | ObjectBox is a superfast, light-weight object persistence framework.
9 | This Swift API seamlessly persists objects on-device for iOS and macOS.
10 |
11 | Want details? **[Read the guides](https://swift.objectbox.io/)** or
12 | **[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
13 |
14 | For an **example**, check our [GitHub page](https://github.com/ObjectBox/objectbox-swift).
15 |
16 | We want your feedback!
17 | ----------------------
18 |
19 | We want ObjectBox not only to be the fastest, but also to be the most Swift-friendly persistence solution.
20 | Let us know what you would like to see improved, so we can make adjustments based on your input:
21 |
22 | Please take this [short questionaire](https://docs.google.com/forms/d/e/1FAIpQLSd0neiviD0Yal0Tn7921w-XWI2d0ONpLm7TfVKp7OvwW2Tu2A/viewform?usp=sf_link) (takes only 1 or 2 minutes).
23 | Thank you!
24 |
25 | Check our [GitHub page](https://github.com/ObjectBox/objectbox-swift) for details.
--------------------------------------------------------------------------------
/Source/ios-framework/cocoapod/generate_sources.sh:
--------------------------------------------------------------------------------
1 | #!/bin/zsh
2 |
3 | set -e
4 |
5 | # We symlink this script, but we must find the code generator relative to the symlink's target.
6 | # macOS does not have realpath and readlink does not have -f option, so do this instead:
7 | script_path=$( ruby -e "puts File.realpath('$0')" )
8 | script_dir=$( dirname "$script_path" )
9 | sourcery="${script_dir}/Sourcery.app/Contents/MacOS/Sourcery"
10 | if [ ! -f "$sourcery" ]; then
11 | echo "Script: $0"
12 | echo "Script realpath: $script_path"
13 | echo "error: Cannot find Sourcery in the expected location at '$sourcery'"
14 | exit 1
15 | fi
16 |
17 | # if this script had parameters, we would look for them here.
18 |
19 | ## Swallow all arguments until a "--", and forward anything after that to Sourcery:
20 | while [[ $1 != "--" && $1 != "" ]]; do
21 | shift
22 | done
23 | if [[ $1 == "--" ]]; then
24 | shift
25 | fi
26 |
27 | # Give a default module name if the user didn't specify one in the overrides:
28 | if [[ "$@" != *"--xcode module"* ]]; then
29 | echo "note: using module name ${PRODUCT_MODULE_NAME}"
30 | MODULENAME1="--xcode-module"
31 | MODULENAME2="${PRODUCT_MODULE_NAME}"
32 | else
33 | MODULENAME1=""
34 | MODULENAME2=""
35 | fi
36 |
37 | # Actually call Sourcery:
38 | "$sourcery" --xcode-project "${PROJECT_FILE_PATH}" --xcode-target "${TARGETNAME}" $MODULENAME1 $MODULENAME2 $@
39 |
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy.yaml:
--------------------------------------------------------------------------------
1 | theme: "./jazzy_theme"
2 | output: "./swift_output"
3 | author: "ObjectBox"
4 | author_url: "https://objectbox.io"
5 |
6 | module: "ObjectBox"
7 | module_version: 4.3.0
8 |
9 | github_url: "https://github.com/objectbox/objectbox-swift"
10 | root_url: "https://objectbox.io/docfiles/swift/current/"
11 | exclude: [
12 | "../CommonSource/Entities/EntityPropertyTypeImplementations.swift",
13 | "../CommonSource/Entities/EntityPropertyType.swift",
14 | "../CommonSource/Entities/EntityReader+SwiftRefinedAPI.swift",
15 | "../CommonSource/Relation/Box+BacklinkIds.swift",
16 | "../CommonSource/Cursor.swift"
17 | ]
18 |
19 | # Reference custom Markdown files for inclusion, references by filename in `custom_categories`.
20 | documentation: "./docs/texts/*.md"
21 | custom_categories:
22 | - name: Core
23 | children:
24 | - Store
25 | - Box
26 | - Entity
27 | - Id
28 | - Property
29 | - name: Relations
30 | children:
31 | - ToOne
32 | - ToMany
33 | - name: Query
34 | children:
35 | - Query Syntax # custom doc
36 | - Query
37 | - PropertyQuery
38 | - PropertyQueryCondition
39 | - QueryCondition
40 | - PropertyAlias
41 | - ".=(_:_:)"
42 | - name: Sync
43 | children:
44 | - Sync
45 | - SyncClient
46 | - SyncCredentials
47 |
48 |
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/assets/img/carat.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/objectbox/objectbox-swift/e9ef3fb8728306bfb26c28fb738038034d58c20e/Source/ios-framework/docs/jazzy_theme/assets/img/carat.png
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/assets/img/dash.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/objectbox/objectbox-swift/e9ef3fb8728306bfb26c28fb738038034d58c20e/Source/ios-framework/docs/jazzy_theme/assets/img/dash.png
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/assets/img/gh.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/objectbox/objectbox-swift/e9ef3fb8728306bfb26c28fb738038034d58c20e/Source/ios-framework/docs/jazzy_theme/assets/img/gh.png
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/assets/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/objectbox/objectbox-swift/e9ef3fb8728306bfb26c28fb738038034d58c20e/Source/ios-framework/docs/jazzy_theme/assets/img/logo.png
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/assets/js/jazzy.js:
--------------------------------------------------------------------------------
1 | window.jazzy = {'docset': false}
2 | if (typeof window.dash != 'undefined') {
3 | document.documentElement.className += ' dash'
4 | window.jazzy.docset = true
5 | }
6 | if (navigator.userAgent.match(/xcode/i)) {
7 | document.documentElement.className += ' xcode'
8 | window.jazzy.docset = true
9 | }
10 |
11 | // On doc load, toggle the URL hash discussion if present
12 | $(document).ready(function() {
13 | if (!window.jazzy.docset) {
14 | var linkToHash = $('a[href="' + window.location.hash +'"]');
15 | linkToHash.trigger("click");
16 | }
17 | });
18 |
19 | // On token click, toggle its discussion and animate token.marginLeft
20 | $(".token").click(function(event) {
21 | if (window.jazzy.docset) {
22 | return;
23 | }
24 | var link = $(this);
25 | var animationDuration = 300;
26 | var tokenOffset = "15px";
27 | var original = link.css('marginLeft') == tokenOffset;
28 | link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
29 | $content = link.parent().parent().next();
30 | $content.slideToggle(animationDuration);
31 |
32 | // Keeps the document from jumping to the hash.
33 | var href = $(this).attr('href');
34 | if (history.pushState) {
35 | history.pushState({}, '', href);
36 | } else {
37 | location.hash = href;
38 | }
39 | event.preventDefault();
40 | });
41 |
42 | // Dumb down quotes within code blocks that delimit strings instead of quotations
43 | // https://github.com/realm/jazzy/issues/714
44 | $("code q").replaceWith(function () {
45 | return ["\"", $(this).contents(), "\""];
46 | });
47 |
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/templates/doc.mustache:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
19 |
25 |
20 | {{module_name}} Reference
21 | 
22 | {{name}} {{kind}} Reference
23 |
26 | {{> nav}}
27 |
28 |
29 |
30 | {{^hide_name}}
40 | {{> tasks}}
41 |
42 | {{> footer}}
43 |
44 |
45 |
46 |
47 |
48 |
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/templates/footer.mustache:
--------------------------------------------------------------------------------
1 |
5 |
--------------------------------------------------------------------------------
/Source/ios-framework/docs/jazzy_theme/templates/header.mustache:
--------------------------------------------------------------------------------
1 |
3 |
11 | {{module_name}} Docs{{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}}
4 | {{#github_url}} 5 | 6 | {{/github_url}} 7 | {{#dash_url}} 8 | 9 | {{/dash_url}} 10 |
View on GitHub
Install in Dash
4 | {{name}}
5 |
6 |
9 | {{{discussion}}}
10 |
11 |