diff --git a/source/sdk/java/adapters.txt b/source/sdk/java/adapters.txt deleted file mode 100644 index a36b3e6145..0000000000 --- a/source/sdk/java/adapters.txt +++ /dev/null @@ -1,178 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-adapters: - -============================== -Display Collections - Java SDK -============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Android apps often populate the UI using -:android:`RecyclerView ` -or :android:`ListView ` components. -Realm offers **adapters** to display realm object -:ref:`collections `. These collections implement -the ``OrderedRealmCollections`` interface. :ref:`RealmResults ` -and :ref:`RealmList ` are examples of these adaptors. -With these adapters, UI components update when your app changes -Realm objects. - -Install Adapters ----------------- - -Add these dependencies to your application level ``build.gradle`` file: - -.. code-block:: gradle - :copyable: false - - dependencies { - implementation 'io.realm:android-adapters:4.0.0' - implementation 'androidx.recyclerview:recyclerview:1.1.0' - } - -Realm hosts these adapters on the -`JCenter `_ -artifact repository. To use ``jcenter`` in your Android app, add it to your -project-level ``build.gradle`` file: - -.. code-block:: gradle - :emphasize-lines: 3, 9 - :copyable: false - - buildscript { - repositories { - jcenter() - } - } - - allprojects { - repositories { - jcenter() - } - } - -.. seealso:: - - Source code: :github:`realm/realm-android-adapters` on GitHub. - -.. _java-adapters-model-item: - -Example Models --------------- - -The examples on this page use a Realm object named ``Item``. -This class contains a string named "name" and an identifier number named -"id": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/JavaItem.snippet.complete.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/Item.snippet.complete.kt - :language: kotlin - :copyable: false - -.. _java-adapters-listview: - -Display Collections in a ListView ---------------------------------- - -Display Realm objects in a -:android:`ListView ` by extending -:github:`RealmBaseAdapter -`. -The adapter uses the ``ListAdapter`` interface. Implementation works -like any ``ListAdapter``. This provides support for automatically-updating -Realm objects. - -Subclass ``RealmBaseAdapter`` to display -:ref:`Item ` objects in a ``ListView``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/ExampleListAdapter.snippet.complete.java - :language: java - :copyable: false - - To display list data in an activity, instantiate a ``ListView``. Then, - attach an ``ExampleListAdapter``: - - .. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.list-adapter.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/ExampleListAdapter.snippet.complete.kt - :language: kotlin - - To display list data in an activity, instantiate a ``ListView``. Then, - attach an ``ExampleListAdapter``: - - .. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.list-adapter.kt - :language: kotlin - :copyable: false - -.. _java-adapters-recyclerview: - -Display Collections in a RecyclerView -------------------------------------- - -Display Realm objects in a -:android:`RecyclerView ` -by extending :github:`RealmRecyclerViewAdapter -`. -The adapter extends ``RecyclerView.Adapter``. Implementation works like any -``RecyclerView`` adapter. This provides support -for automatically-updating Realm objects. - -Subclass ``RealmRecyclerViewAdapter`` to display -:ref:`Item ` objects in a ``RecyclerView``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/ExampleRecyclerViewAdapter.snippet.complete.java - :language: java - :copyable: false - - To display list data in an activity, instantiate a ``RecyclerView``. Then, - attach an ``ExampleRecyclerViewAdapter``: - - .. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.recycler-view-adapter.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/ExampleRecyclerViewAdapter.snippet.complete.kt - :language: kotlin - :copyable: false - - To display list data in an activity, instantiate a ``RecyclerView``. Then, - attach an ``ExampleRecyclerViewAdapter``: - - .. literalinclude:: /examples/generated/java/local/AdapterTest.snippet.recycler-view-adapter.kt - :language: kotlin - :copyable: false diff --git a/source/sdk/java/api.txt b/source/sdk/java/api.txt deleted file mode 100644 index a94fb6d0e2..0000000000 --- a/source/sdk/java/api.txt +++ /dev/null @@ -1,42 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -============= -API Reference -============= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. toctree:: - :titlesonly: - :hidden: - - io.realm - io.realm.annotations - io.realm.coroutines - io.realm.exceptions - io.realm.log - io.realm.mongodb - io.realm.mongodb.auth - io.realm.mongodb.functions - io.realm.mongodb.log.obfuscator - io.realm.mongodb.mongo - io.realm.mongodb.mongo.events - io.realm.mongodb.mongo.iterable - io.realm.mongodb.mongo.options - io.realm.mongodb.mongo.result - io.realm.mongodb.push - io.realm.mongodb.sync - io.realm.rx - - -The Java API reference docs are now integrated into the main -documentation site. Use the side bar to browse packages. Miss the old -reference docs? You can still see the `Javadoc version -`__ and the `Kotlin -Extensions Reference Manual -`__. diff --git a/source/sdk/java/api/index.txt b/source/sdk/java/api/index.txt deleted file mode 100644 index 26bb4f8656..0000000000 --- a/source/sdk/java/api/index.txt +++ /dev/null @@ -1,40 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:orphan: - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -API Reference -^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - io.realm - io.realm.annotations - io.realm.coroutines - io.realm.exceptions - io.realm.gradle - io.realm.log - io.realm.mongodb - io.realm.mongodb.auth - io.realm.mongodb.functions - io.realm.mongodb.log.obfuscator - io.realm.mongodb.mongo - io.realm.mongodb.mongo.events - io.realm.mongodb.mongo.iterable - io.realm.mongodb.mongo.options - io.realm.mongodb.mongo.result - io.realm.mongodb.push - io.realm.mongodb.sync - io.realm.rx - - diff --git a/source/sdk/java/api/io.txt b/source/sdk/java/api/io.txt deleted file mode 100644 index 8994ca9dee..0000000000 --- a/source/sdk/java/api/io.txt +++ /dev/null @@ -1,37 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:orphan: - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Realm Java API -^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - io.realm - io.realm.annotations - io.realm.coroutines - io.realm.exceptions - io.realm.log - io.realm.mongodb - io.realm.mongodb.functions - io.realm.mongodb.log.obfuscator - io.realm.mongodb.mongo - io.realm.mongodb.mongo.events - io.realm.mongodb.mongo.iterable - io.realm.mongodb.mongo.options - io.realm.mongodb.mongo.result - io.realm.mongodb.push - io.realm.mongodb.sync - io.realm.rx diff --git a/source/sdk/java/api/io/realm.txt b/source/sdk/java/api/io/realm.txt deleted file mode 100644 index a251299866..0000000000 --- a/source/sdk/java/api/io/realm.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm -^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - Case - CollectionUtils - CompactOnLaunchCallback - DefaultCompactOnLaunchCallback - DynamicRealm - DynamicRealm.Callback - DynamicRealm.Transaction - DynamicRealm.Transaction.Callback - DynamicRealm.Transaction.OnError - DynamicRealm.Transaction.OnSuccess - DynamicRealmObject - FieldAttribute - FrozenPendingRow - ImportFlag - MapChangeListener - MapChangeSet - MutableRealmInteger - ObjectChangeSet - OrderedCollectionChangeSet - OrderedCollectionChangeSet.Range - OrderedCollectionChangeSet.State - OrderedRealmCollection - OrderedRealmCollectionChangeListener - OrderedRealmCollectionSnapshot - ProxyState - Realm - Realm.Callback - Realm.Transaction - Realm.Transaction.Callback - Realm.Transaction.OnError - Realm.Transaction.OnSuccess - RealmAny - RealmAny.Type - RealmAnyNativeFunctionsImpl - RealmAnyOperator - RealmAsyncTask - RealmChangeListener - RealmCollection - RealmConfiguration - RealmConfiguration.Builder - RealmDictionary - RealmFieldType - RealmList - RealmMap - RealmMigration - RealmModel - RealmObject - RealmObjectChangeListener - RealmObjectSchema - RealmObjectSchema.Function - RealmQuery - RealmResults - RealmSchema - RealmSet - SetChangeListener - SetChangeSet - Sort diff --git a/source/sdk/java/api/io/realm/Case.txt b/source/sdk/java/api/io/realm/Case.txt deleted file mode 100644 index f372cdd797..0000000000 --- a/source/sdk/java/api/io/realm/Case.txt +++ /dev/null @@ -1,319 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum Case -^^^^^^^^^ - -.. _io_realm_Case: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.Case - - -This class describes the Case settings used in Realm queries. - - -.. seealso:: - - - - - :ref:`io.realm.RealmQuery.equalTo(String, String, Case) ` - - - - - :ref:`io.realm.RealmQuery.contains(String, String, Case) ` - - - - - :ref:`io.realm.RealmQuery.beginsWith(String, String, Case) ` - - - - - :ref:`io.realm.RealmQuery.endsWith(String, String, Case) ` - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`INSENSITIVE ` - - - - - - - * - :ref:`SENSITIVE ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`getValue ` () - | - - - Returns the value for this setting that is used by the underlying query engine. - - - - - * - public static :ref:`Case ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`Case ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_Case_INSENSITIVE: - -.. _Case_INSENSITIVE: - - - -``INSENSITIVE`` ----------------- - -public static final :ref:`Case ` - - - - - -.. _io_realm_Case_SENSITIVE: - -.. _Case_SENSITIVE: - - - -``SENSITIVE`` --------------- - -public static final :ref:`Case ` - - - - - - -Method Detail -============= - -.. _getValue: - -.. _getValue__: - -.. _Case_getValue: - -.. _Case_getValue__: - -.. _io_realm_Case_getValue: - -.. _io_realm_Case_getValue__: - - - -getValue --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`getValue ` () - | - - - - - * - Returns the value for this setting that is used by the underlying query engine. - - - - - - - **Returns** - - The value used by the underlying query engine to indicate this value. - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _Case_valueOf: - -.. _Case_valueOf__: - -.. _io_realm_Case_valueOf: - -.. _io_realm_Case_valueOf__: - - - -valueOf -------- - -.. _io_realm_Case_valueOf_java_lang_String_: - -.. _io_realm_Case_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _Case_valueOf_java_lang_String_: - -.. _Case_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Case ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Case_values: - -.. _Case_values__: - -.. _io_realm_Case_values: - -.. _io_realm_Case_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Case ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/CollectionUtils.txt b/source/sdk/java/api/io/realm/CollectionUtils.txt deleted file mode 100644 index 1a41b4351b..0000000000 --- a/source/sdk/java/api/io/realm/CollectionUtils.txt +++ /dev/null @@ -1,428 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class CollectionUtils -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_CollectionUtils: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.CollectionUtils - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`CollectionUtils ` () - | - - - - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`DICTIONARY_TYPE ` - - - - - * - public static final `String `__ - - - - :ref:`LIST_TYPE ` - - - - - * - public static final `String `__ - - - - :ref:`SET_TYPE ` - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static **void** - - | :ref:`checkForAddRemoveListener ` ( - | **BaseRealm** baseRealm, - | `Object `__ listener, - | **boolean** checkListener - | ) - - - Checks whether it is possible to add or remove a provided listener. - - - - - * - public static **E** - - | :ref:`copyToRealm ` <**E** >( - | **BaseRealm** baseRealm, - | **E** object - | ) - - - Called by both list and dictionary operators to copy a RealmModel to Realm in case it has been deemed necessary. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_CollectionUtils_DICTIONARY_TYPE: - - - -``DICTIONARY_TYPE`` --------------------- - - - - -.. _io_realm_CollectionUtils_LIST_TYPE: - - - -``LIST_TYPE`` --------------- - - - - -.. _io_realm_CollectionUtils_SET_TYPE: - - - -``SET_TYPE`` -------------- - - - - - - -Constructor Detail -================== - -.. _CollectionUtils: - -.. _CollectionUtils__: - -.. _io_realm_CollectionUtils: - -.. _io_realm_CollectionUtils__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`CollectionUtils ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _checkForAddRemoveListener: - -.. _checkForAddRemoveListener__: - -.. _CollectionUtils_checkForAddRemoveListener: - -.. _CollectionUtils_checkForAddRemoveListener__: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener__: - - - -checkForAddRemoveListener -------------------------- - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm_Object_boolean_: - -.. _io_realm_CollectionUtils_checkForAddRemoveListener_BaseRealm__Object__boolean_: - -.. _checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: - -.. _checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: - -.. _checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: - -.. _checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: - -.. _checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: - -.. _checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: - -.. _checkForAddRemoveListener_BaseRealm_Object_boolean_: - -.. _checkForAddRemoveListener_BaseRealm__Object__boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_java_lang_Object_boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__java_lang_Object__boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm_Object_boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_io_realm_BaseRealm__Object__boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_BaseRealm_java_lang_Object_boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_BaseRealm__java_lang_Object__boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_BaseRealm_Object_boolean_: - -.. _CollectionUtils_checkForAddRemoveListener_BaseRealm__Object__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`checkForAddRemoveListener ` ( - | **BaseRealm** baseRealm, - | `Object `__ listener, - | **boolean** checkListener - | ) - - - - - * - Checks whether it is possible to add or remove a provided listener. - - - - - **Parameters** - - - ``listener`` - The listener to be checked. - - - - - ``checkListener`` - whether the check should be performed. - - - - - - - - - - - - - - - - -.. _copyToRealm: - -.. _copyToRealm__: - -.. _CollectionUtils_copyToRealm: - -.. _CollectionUtils_copyToRealm__: - -.. _io_realm_CollectionUtils_copyToRealm: - -.. _io_realm_CollectionUtils_copyToRealm__: - - - -copyToRealm ------------ - -.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm_E_: - -.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm__E_: - -.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm_RealmModel_: - -.. _io_realm_CollectionUtils_copyToRealm_io_realm_BaseRealm__RealmModel_: - -.. _io_realm_CollectionUtils_copyToRealm_BaseRealm_E_: - -.. _io_realm_CollectionUtils_copyToRealm_BaseRealm__E_: - -.. _io_realm_CollectionUtils_copyToRealm_BaseRealm_RealmModel_: - -.. _io_realm_CollectionUtils_copyToRealm_BaseRealm__RealmModel_: - -.. _copyToRealm_io_realm_BaseRealm_E_: - -.. _copyToRealm_io_realm_BaseRealm__E_: - -.. _copyToRealm_io_realm_BaseRealm_RealmModel_: - -.. _copyToRealm_io_realm_BaseRealm__RealmModel_: - -.. _copyToRealm_BaseRealm_E_: - -.. _copyToRealm_BaseRealm__E_: - -.. _copyToRealm_BaseRealm_RealmModel_: - -.. _copyToRealm_BaseRealm__RealmModel_: - -.. _CollectionUtils_copyToRealm_io_realm_BaseRealm_E_: - -.. _CollectionUtils_copyToRealm_io_realm_BaseRealm__E_: - -.. _CollectionUtils_copyToRealm_io_realm_BaseRealm_RealmModel_: - -.. _CollectionUtils_copyToRealm_io_realm_BaseRealm__RealmModel_: - -.. _CollectionUtils_copyToRealm_BaseRealm_E_: - -.. _CollectionUtils_copyToRealm_BaseRealm__E_: - -.. _CollectionUtils_copyToRealm_BaseRealm_RealmModel_: - -.. _CollectionUtils_copyToRealm_BaseRealm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **E** :ref:`copyToRealm ` <**E** >( - | **BaseRealm** baseRealm, - | **E** object - | ) - - - - - * - Called by both list and dictionary operators to copy a RealmModel to Realm in case it has been deemed necessary. - - - **Type Parameters** - - - ``E`` - The RealmModel type. - - - - - - - - **Parameters** - - - ``baseRealm`` - The Realm instance to copy the object to. - - - - - ``object`` - The object to copy. - - - - - - - - **Returns** - - the copied object - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/CompactOnLaunchCallback.txt b/source/sdk/java/api/io/realm/CompactOnLaunchCallback.txt deleted file mode 100644 index f2083c621a..0000000000 --- a/source/sdk/java/api/io/realm/CompactOnLaunchCallback.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface CompactOnLaunchCallback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_CompactOnLaunchCallback: - - - -io.realm -======== - -This interface is used to determine if a Realm file should be compacted the first time the file is opened and before the instance is returned.Note that compacting a file can take a while, so compacting should generally only be done on a background thread or when used in combination with :ref:`Realm.getInstanceAsync(RealmConfiguration, io.realm.Realm.Callback) ` . - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`shouldCompact ` ( - | **long** totalBytes, - | **long** usedBytes - | ) - - - This method determines if the Realm file should be compacted before opened and returned to the user. - - - - - - - -Method Detail -============= - -.. _shouldCompact: - -.. _shouldCompact__: - -.. _CompactOnLaunchCallback_shouldCompact: - -.. _CompactOnLaunchCallback_shouldCompact__: - -.. _io_realm_CompactOnLaunchCallback_shouldCompact: - -.. _io_realm_CompactOnLaunchCallback_shouldCompact__: - - - -shouldCompact -------------- - -.. _io_realm_CompactOnLaunchCallback_shouldCompact_long_long_: - -.. _io_realm_CompactOnLaunchCallback_shouldCompact_long__long_: - -.. _shouldCompact_long_long_: - -.. _shouldCompact_long__long_: - -.. _CompactOnLaunchCallback_shouldCompact_long_long_: - -.. _CompactOnLaunchCallback_shouldCompact_long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`shouldCompact ` ( - | **long** totalBytes, - | **long** usedBytes - | ) - - - - - * - This method determines if the Realm file should be compacted before opened and returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - **Parameters** - - - ``totalBytes`` - the total file size (data + free space). - - - - - ``usedBytes`` - the total bytes used by data in the file. - - - - - - - - **Returns** - - {code true} to indicate an attempt to compact the file should be made. Otherwise, the compaction will be skipped. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt b/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt deleted file mode 100644 index 8788c75082..0000000000 --- a/source/sdk/java/api/io/realm/DefaultCompactOnLaunchCallback.txt +++ /dev/null @@ -1,190 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DefaultCompactOnLaunchCallback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DefaultCompactOnLaunchCallback: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.DefaultCompactOnLaunchCallback - - -**Implemented interfaces:** - - - -- :ref:`io.realm.CompactOnLaunchCallback ` - - -The default implementation for determining if a file should be compacted or not. This implementation will only trigger if the file is above 50 MB and more than 50% can be reclaimed. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`DefaultCompactOnLaunchCallback ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`shouldCompact ` ( - | **long** totalBytes, - | **long** usedBytes - | ) - - - This method determines if the Realm file should be compacted before opened and returned to the user. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _DefaultCompactOnLaunchCallback: - -.. _DefaultCompactOnLaunchCallback__: - -.. _io_realm_DefaultCompactOnLaunchCallback: - -.. _io_realm_DefaultCompactOnLaunchCallback__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DefaultCompactOnLaunchCallback ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _shouldCompact: - -.. _shouldCompact__: - -.. _DefaultCompactOnLaunchCallback_shouldCompact: - -.. _DefaultCompactOnLaunchCallback_shouldCompact__: - -.. _io_realm_DefaultCompactOnLaunchCallback_shouldCompact: - -.. _io_realm_DefaultCompactOnLaunchCallback_shouldCompact__: - - - -shouldCompact -------------- - -.. _io_realm_DefaultCompactOnLaunchCallback_shouldCompact_long_long_: - -.. _io_realm_DefaultCompactOnLaunchCallback_shouldCompact_long__long_: - -.. _shouldCompact_long_long_: - -.. _shouldCompact_long__long_: - -.. _DefaultCompactOnLaunchCallback_shouldCompact_long_long_: - -.. _DefaultCompactOnLaunchCallback_shouldCompact_long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`shouldCompact ` ( - | **long** totalBytes, - | **long** usedBytes - | ) - - - - - * - This method determines if the Realm file should be compacted before opened and returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - - - **Returns** - - {code true} to indicate an attempt to compact the file should be made. Otherwise, the compaction will be skipped. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm.txt b/source/sdk/java/api/io/realm/DynamicRealm.txt deleted file mode 100644 index 3cf327a712..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm.txt +++ /dev/null @@ -1,2544 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DynamicRealm -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm: - - - -io.realm -======== - - - | `java.lang.Object `__ - | **io.realm.BaseRealm** - | io.realm.DynamicRealm - - -DynamicRealm is a dynamic variant of :ref:`io.realm.Realm ` . This means that all access to data and/or queries are done using string based class names instead of class type references. - -This is useful during migrations or when working with string-based data like CSV or XML files. - -The same :ref:`io.realm.RealmConfiguration ` can be used to open a Realm file in both dynamic and typed mode, but modifying the schema while having both a typed and dynamic version open is highly discouraged and will most likely crash the typed Realm. During migrations only a DynamicRealm will be open. - - - -Dynamic Realms do not enforce schemas or schema versions and :ref:`RealmMigration ` code is not used even if it has been defined in the :ref:`RealmConfiguration ` . - - - -This means that the schema is not created or validated until a Realm has been opened in typed mode. If a Realm file is opened in dynamic mode first it will not contain any information about classes and fields, and any queries for classes defined by the schema will fail. - - - - -.. seealso:: - - - - - :ref:`Realm ` - - - - - :ref:`RealmSchema ` - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static interface`` - - :ref:`DynamicRealm.Transaction ` - - - * - ``public abstract static`` - - :ref:`DynamicRealm.Callback ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Adds a change listener to the Realm. - - - - - * - public **** - - | :ref:`asFlowable ` () - | - - - Returns an RxJava Flowable that monitors changes to this Realm. - - - - - * - public :ref:`DynamicRealmObject ` - - | :ref:`createEmbeddedObject ` ( - | `String `__ className, - | :ref:`DynamicRealmObject ` parentObject, - | `String `__ parentProperty - | ) - - - Instantiates and adds a new embedded object to the Realm. - - - - - * - public :ref:`DynamicRealmObject ` - - | :ref:`createObject ` ( - | `String `__ className, - | `Object `__ primaryKeyValue - | ) - - - Creates an object with a given primary key. - - - - - * - public :ref:`DynamicRealmObject ` - - | :ref:`createObject ` ( - | `String `__ className - | ) - - - Instantiates and adds a new object to the Realm. - - - - - * - public **void** - - | :ref:`delete ` ( - | `String `__ className - | ) - - - Deletes all objects of the specified class from the Realm. - - - - - * - public **void** - - | :ref:`executeTransaction ` ( - | :ref:`DynamicRealm.Transaction ` transaction - | ) - - - Executes a given transaction on the DynamicRealm. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnSuccess ` onSuccess, - | :ref:`DynamicRealm.Transaction.OnError ` onError - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess and OnError callbacks. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnError ` onError - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnError callback. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnSuccess ` onSuccess - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess callback. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction - | ) - - - Similar to :ref:`executeTransaction(Transaction) ` but runs asynchronously on a worker thread. - - - - - - - * - public :ref:`DynamicRealm ` - - | :ref:`freeze ` () - | - - - Returns a frozen snapshot of the current Realm. - - - - - * - public static :ref:`DynamicRealm ` - - | :ref:`getInstance ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Realm static constructor that returns a dynamic variant of the Realm instance defined by provided :ref:`io.realm.RealmConfiguration ` . - - - - - - - * - public static :ref:`RealmAsyncTask ` - - | :ref:`getInstanceAsync ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`DynamicRealm.Callback ` callback - | ) - - - The creation of the first Realm instance per :ref:`RealmConfiguration ` in a process can take some time as all initialization code need to run at that point (Setting up the Realm, validating schemas and creating initial data). - - - - - - - * - public :ref:`RealmSchema ` - - | :ref:`getSchema ` () - | - - - Returns the mutable schema for this Realm. - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - Checks if this :ref:`io.realm.Realm ` contains any objects. - - - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Removes the specified change listener. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` ( - | `String `__ className - | ) - - - Returns a RealmQuery, which can be used to query the provided class. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``getSubscriptions`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _DynamicRealm_addChangeListener: - -.. _DynamicRealm_addChangeListener__: - -.. _io_realm_DynamicRealm_addChangeListener: - -.. _io_realm_DynamicRealm_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_DynamicRealm_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_DynamicRealm_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _DynamicRealm_addChangeListener_io_realm_RealmChangeListener_: - -.. _DynamicRealm_addChangeListener_RealmChangeListener_: - -.. _io_realm_DynamicRealm_addChangeListener_RealmChangeListener_DynamicRealm__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to the Realm.The listeners will be executed when changes are committed by this or another thread. - - Realm instances are cached per thread. For that reason it is important to remember to remove listeners again either using :ref:`removeChangeListener(RealmChangeListener) ` or :ref:`removeAllChangeListeners() ` . Not doing so can cause memory leaks. - - - - - - - - - **Parameters** - - - ``listener`` - the change listener. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - :ref:`removeChangeListener(RealmChangeListener) ` - - - - - :ref:`removeAllChangeListeners() ` - - - - - **refresh()** - - - - - - - - - - - - -.. _asFlowable: - -.. _asFlowable__: - -.. _DynamicRealm_asFlowable: - -.. _DynamicRealm_asFlowable__: - -.. _io_realm_DynamicRealm_asFlowable: - -.. _io_realm_DynamicRealm_asFlowable__: - - - -asFlowable ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asFlowable ` () - | - - - - - * - Returns an RxJava Flowable that monitors changes to this Realm. It will emit the current state when subscribed to. Items will continually be emitted as the Realm is updated - ``onComplete`` will never be called. - - Items emitted from Realm Flowables are frozen (See **freeze()**. This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - realm.asFlowable() - .observeOn(Schedulers.computation()) - .map(rxRealm -> doExpensiveWork(rxRealm)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items, you can instruct RxJava to only emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - realm.asFlowable().first().subscribe( ... ); // You only get the results once - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - - - **Overrides** - - ``asFlowable`` in class **BaseRealm** - - - - - - -.. _createEmbeddedObject: - -.. _createEmbeddedObject__: - -.. _DynamicRealm_createEmbeddedObject: - -.. _DynamicRealm_createEmbeddedObject__: - -.. _io_realm_DynamicRealm_createEmbeddedObject: - -.. _io_realm_DynamicRealm_createEmbeddedObject__: - - - -createEmbeddedObject --------------------- - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String_DynamicRealmObject_java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String__DynamicRealmObject__java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String_DynamicRealmObject_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_java_lang_String__DynamicRealmObject__String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String_io_realm_DynamicRealmObject_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String__io_realm_DynamicRealmObject__String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String_DynamicRealmObject_java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String__DynamicRealmObject__java_lang_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String_DynamicRealmObject_String_: - -.. _io_realm_DynamicRealm_createEmbeddedObject_String__DynamicRealmObject__String_: - -.. _createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_String_: - -.. _createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__String_: - -.. _createEmbeddedObject_java_lang_String_DynamicRealmObject_java_lang_String_: - -.. _createEmbeddedObject_java_lang_String__DynamicRealmObject__java_lang_String_: - -.. _createEmbeddedObject_java_lang_String_DynamicRealmObject_String_: - -.. _createEmbeddedObject_java_lang_String__DynamicRealmObject__String_: - -.. _createEmbeddedObject_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _createEmbeddedObject_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _createEmbeddedObject_String_io_realm_DynamicRealmObject_String_: - -.. _createEmbeddedObject_String__io_realm_DynamicRealmObject__String_: - -.. _createEmbeddedObject_String_DynamicRealmObject_java_lang_String_: - -.. _createEmbeddedObject_String__DynamicRealmObject__java_lang_String_: - -.. _createEmbeddedObject_String_DynamicRealmObject_String_: - -.. _createEmbeddedObject_String__DynamicRealmObject__String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String_io_realm_DynamicRealmObject_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String__io_realm_DynamicRealmObject__String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String_DynamicRealmObject_java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String__DynamicRealmObject__java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String_DynamicRealmObject_String_: - -.. _DynamicRealm_createEmbeddedObject_java_lang_String__DynamicRealmObject__String_: - -.. _DynamicRealm_createEmbeddedObject_String_io_realm_DynamicRealmObject_java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_String__io_realm_DynamicRealmObject__java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_String_io_realm_DynamicRealmObject_String_: - -.. _DynamicRealm_createEmbeddedObject_String__io_realm_DynamicRealmObject__String_: - -.. _DynamicRealm_createEmbeddedObject_String_DynamicRealmObject_java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_String__DynamicRealmObject__java_lang_String_: - -.. _DynamicRealm_createEmbeddedObject_String_DynamicRealmObject_String_: - -.. _DynamicRealm_createEmbeddedObject_String__DynamicRealmObject__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealmObject ` :ref:`createEmbeddedObject ` ( - | `String `__ className, - | :ref:`DynamicRealmObject ` parentObject, - | `String `__ parentProperty - | ) - - - - - * - Instantiates and adds a new embedded object to the Realm.This method should only be used to create objects of types marked as embedded. - - - - - - - **Parameters** - - - ``className`` - the class name of the object to create. - - - - - ``parentObject`` - The parent object which should hold a reference to the embedded object. If the parent property is a list the embedded object will be added to the end of that list. - - - - - ``parentProperty`` - the property in the parent class which holds the reference. - - - - - - - - **Returns** - - the newly created embedded object. - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmClass.embedded() ` - - - - - - - - - - - - -.. _createObject: - -.. _createObject__: - -.. _DynamicRealm_createObject: - -.. _DynamicRealm_createObject__: - -.. _io_realm_DynamicRealm_createObject: - -.. _io_realm_DynamicRealm_createObject__: - - - -createObject ------------- - -.. _io_realm_DynamicRealm_createObject_java_lang_String_java_lang_Object_: - -.. _io_realm_DynamicRealm_createObject_java_lang_String__java_lang_Object_: - -.. _io_realm_DynamicRealm_createObject_java_lang_String_Object_: - -.. _io_realm_DynamicRealm_createObject_java_lang_String__Object_: - -.. _io_realm_DynamicRealm_createObject_String_java_lang_Object_: - -.. _io_realm_DynamicRealm_createObject_String__java_lang_Object_: - -.. _io_realm_DynamicRealm_createObject_String_Object_: - -.. _io_realm_DynamicRealm_createObject_String__Object_: - -.. _createObject_java_lang_String_java_lang_Object_: - -.. _createObject_java_lang_String__java_lang_Object_: - -.. _createObject_java_lang_String_Object_: - -.. _createObject_java_lang_String__Object_: - -.. _createObject_String_java_lang_Object_: - -.. _createObject_String__java_lang_Object_: - -.. _createObject_String_Object_: - -.. _createObject_String__Object_: - -.. _DynamicRealm_createObject_java_lang_String_java_lang_Object_: - -.. _DynamicRealm_createObject_java_lang_String__java_lang_Object_: - -.. _DynamicRealm_createObject_java_lang_String_Object_: - -.. _DynamicRealm_createObject_java_lang_String__Object_: - -.. _DynamicRealm_createObject_String_java_lang_Object_: - -.. _DynamicRealm_createObject_String__java_lang_Object_: - -.. _DynamicRealm_createObject_String_Object_: - -.. _DynamicRealm_createObject_String__Object_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealmObject ` :ref:`createObject ` ( - | `String `__ className, - | `Object `__ primaryKeyValue - | ) - - - - - * - Creates an object with a given primary key. Classes without a primary key defined must use :ref:`createObject(String) ` } instead. - - - - - - - - - **Returns** - - the new object. All fields will have default values for their type, except for the primary key field which will have the provided value. - - - - - **Throws** - - - :ref:`RealmException ` - if object could not be created due to the primary key being invalid. - - - - - `IllegalStateException `__ - if the model clazz does not have a primary key defined. - - - - - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. - - - - - - - - - - - - -.. _io_realm_DynamicRealm_createObject_java_lang_String_: - -.. _io_realm_DynamicRealm_createObject_String_: - -.. _createObject_java_lang_String_: - -.. _createObject_String_: - -.. _DynamicRealm_createObject_java_lang_String_: - -.. _DynamicRealm_createObject_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealmObject ` :ref:`createObject ` ( - | `String `__ className - | ) - - - - - * - Instantiates and adds a new object to the Realm. - - - - - **Parameters** - - - ``className`` - the class name of the object to create. - - - - - - - - **Returns** - - the new object. - - - - - **Throws** - - - :ref:`RealmException ` - if the object could not be created. - - - - - - - - - - - - -.. _delete: - -.. _delete__: - -.. _DynamicRealm_delete: - -.. _DynamicRealm_delete__: - -.. _io_realm_DynamicRealm_delete: - -.. _io_realm_DynamicRealm_delete__: - - - -delete ------- - -.. _io_realm_DynamicRealm_delete_java_lang_String_: - -.. _io_realm_DynamicRealm_delete_String_: - -.. _delete_java_lang_String_: - -.. _delete_String_: - -.. _DynamicRealm_delete_java_lang_String_: - -.. _DynamicRealm_delete_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`delete ` ( - | `String `__ className - | ) - - - - - * - Deletes all objects of the specified class from the Realm. - - - - - **Parameters** - - - ``className`` - the class for which all objects should be removed. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. - - - - - - - - - - - - -.. _executeTransaction: - -.. _executeTransaction__: - -.. _DynamicRealm_executeTransaction: - -.. _DynamicRealm_executeTransaction__: - -.. _io_realm_DynamicRealm_executeTransaction: - -.. _io_realm_DynamicRealm_executeTransaction__: - - - -executeTransaction ------------------- - -.. _io_realm_DynamicRealm_executeTransaction_io_realm_DynamicRealm_Transaction_: - -.. _io_realm_DynamicRealm_executeTransaction_Transaction_: - -.. _io_realm_DynamicRealm_executeTransaction_DynamicRealm_Transaction_: - -.. _executeTransaction_io_realm_DynamicRealm_Transaction_: - -.. _executeTransaction_Transaction_: - -.. _executeTransaction_DynamicRealm_Transaction_: - -.. _DynamicRealm_executeTransaction_io_realm_DynamicRealm_Transaction_: - -.. _DynamicRealm_executeTransaction_Transaction_: - -.. _DynamicRealm_executeTransaction_DynamicRealm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`executeTransaction ` ( - | :ref:`DynamicRealm.Transaction ` transaction - | ) - - - - - * - Executes a given transaction on the DynamicRealm. **beginTransaction()** and **commitTransaction()** will be called automatically. If any exception is thrown during the transaction **cancelTransaction()** will be called instead of **commitTransaction()**. - - Calling this method from the UI thread will throw a :ref:`RealmException ` . Doing so may result in a drop of frames or even ANRs. We recommend calling this method from a non-UI thread or using :ref:`executeTransactionAsync(Transaction) ` instead. - - - - - - - - - **Parameters** - - - ``transaction`` - :ref:`Transaction ` to execute. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . - - - - - - - :ref:`RealmException ` - if called from the UI thread, unless an explicit opt-in has been declared in :ref:`RealmConfiguration.Builder.allowWritesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _executeTransactionAsync: - -.. _executeTransactionAsync__: - -.. _DynamicRealm_executeTransactionAsync: - -.. _DynamicRealm_executeTransactionAsync__: - -.. _io_realm_DynamicRealm_executeTransactionAsync: - -.. _io_realm_DynamicRealm_executeTransactionAsync__: - - - -executeTransactionAsync ------------------------ - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess__DynamicRealm_Transaction_OnError_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnSuccess ` onSuccess, - | :ref:`DynamicRealm.Transaction.OnError ` onError - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess and OnError callbacks. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`Transaction ` to execute. - - - - - - - ``onSuccess`` - callback invoked when the transaction succeeds. - - - - - ``onError`` - callback invoked when the transaction fails. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnError_: - -.. _executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnError_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnError_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnError ` onError - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnError callback. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`Transaction ` to execute. - - - - - - - ``onError`` - callback invoked when the transaction fails. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__OnSuccess_: - -.. _executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__io_realm_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_DynamicRealm_Transaction_OnSuccess_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction__DynamicRealm_Transaction_OnSuccess_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction, - | :ref:`DynamicRealm.Transaction.OnSuccess ` onSuccess - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess callback. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`Transaction ` to execute. - - - - - - - ``onSuccess`` - callback invoked when the transaction succeeds. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_Transaction_: - -.. _io_realm_DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_: - -.. _executeTransactionAsync_io_realm_DynamicRealm_Transaction_: - -.. _executeTransactionAsync_Transaction_: - -.. _executeTransactionAsync_DynamicRealm_Transaction_: - -.. _DynamicRealm_executeTransactionAsync_io_realm_DynamicRealm_Transaction_: - -.. _DynamicRealm_executeTransactionAsync_Transaction_: - -.. _DynamicRealm_executeTransactionAsync_DynamicRealm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`DynamicRealm.Transaction ` transaction - | ) - - - - - * - Similar to :ref:`executeTransaction(Transaction) ` but runs asynchronously on a worker thread. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`Transaction ` to execute. - - - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. - - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _DynamicRealm_freeze: - -.. _DynamicRealm_freeze__: - -.. _io_realm_DynamicRealm_freeze: - -.. _io_realm_DynamicRealm_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealm ` :ref:`freeze ` () - | - - - - - * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. - - Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of Realms with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - - - - - - - **Returns** - - a frozen copy of this Realm. - - - - - - - **Overrides** - - ``freeze`` in class **BaseRealm** - - - - - - -.. _getInstance: - -.. _getInstance__: - -.. _DynamicRealm_getInstance: - -.. _DynamicRealm_getInstance__: - -.. _io_realm_DynamicRealm_getInstance: - -.. _io_realm_DynamicRealm_getInstance__: - - - -getInstance ------------ - -.. _io_realm_DynamicRealm_getInstance_io_realm_RealmConfiguration_: - -.. _io_realm_DynamicRealm_getInstance_RealmConfiguration_: - -.. _getInstance_io_realm_RealmConfiguration_: - -.. _getInstance_RealmConfiguration_: - -.. _DynamicRealm_getInstance_io_realm_RealmConfiguration_: - -.. _DynamicRealm_getInstance_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`DynamicRealm ` :ref:`getInstance ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Realm static constructor that returns a dynamic variant of the Realm instance defined by provided :ref:`io.realm.RealmConfiguration ` . Dynamic Realms do not care about schemaVersion and schemas, so opening a DynamicRealm will never trigger a migration. - - - - - - - - - **Returns** - - the DynamicRealm defined by the configuration. - - - - - **Throws** - - - :ref:`RealmFileException ` - if an error happened when accessing the underlying Realm file. - - - - - `IllegalArgumentException `__ - if ``configuration`` argument is ``null`` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmConfiguration for details on how to configure a Realm. ` - - - - - - - - - - - - -.. _getInstanceAsync: - -.. _getInstanceAsync__: - -.. _DynamicRealm_getInstanceAsync: - -.. _DynamicRealm_getInstanceAsync__: - -.. _io_realm_DynamicRealm_getInstanceAsync: - -.. _io_realm_DynamicRealm_getInstanceAsync__: - - - -getInstanceAsync ----------------- - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration__Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration_DynamicRealm_Callback_: - -.. _io_realm_DynamicRealm_getInstanceAsync_RealmConfiguration__DynamicRealm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_DynamicRealm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__DynamicRealm_Callback_: - -.. _getInstanceAsync_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _getInstanceAsync_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _getInstanceAsync_RealmConfiguration_Callback_: - -.. _getInstanceAsync_RealmConfiguration__Callback_: - -.. _getInstanceAsync_RealmConfiguration_DynamicRealm_Callback_: - -.. _getInstanceAsync_RealmConfiguration__DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_io_realm_RealmConfiguration__DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration_io_realm_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration__io_realm_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration_Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration__Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration_DynamicRealm_Callback_: - -.. _DynamicRealm_getInstanceAsync_RealmConfiguration__DynamicRealm_Callback_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAsyncTask ` :ref:`getInstanceAsync ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`DynamicRealm.Callback ` callback - | ) - - - - - * - The creation of the first Realm instance per :ref:`RealmConfiguration ` in a process can take some time as all initialization code need to run at that point (Setting up the Realm, validating schemas and creating initial data). This method places the initialization work in a background thread and deliver the Realm instance to the caller thread asynchronously after the initialization is finished. - - - - - - - **Parameters** - - - ``configuration`` - :ref:`RealmConfiguration ` used to open the Realm. - - - - - - - ``callback`` - invoked to return the results. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. - - - - - - - `IllegalStateException `__ - if it is called from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Callback for more details. ` - - - - - - - - - - - - -.. _getSchema: - -.. _getSchema__: - -.. _DynamicRealm_getSchema: - -.. _DynamicRealm_getSchema__: - -.. _io_realm_DynamicRealm_getSchema: - -.. _io_realm_DynamicRealm_getSchema__: - - - -getSchema ---------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSchema ` :ref:`getSchema ` () - | - - - - - * - Returns the mutable schema for this Realm. - - - - - - - **Returns** - - The :ref:`RealmSchema ` for this Realm. - - - - - - - - - **Overrides** - - ``getSchema`` in class **BaseRealm** - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _DynamicRealm_isEmpty: - -.. _DynamicRealm_isEmpty__: - -.. _io_realm_DynamicRealm_isEmpty: - -.. _io_realm_DynamicRealm_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - Checks if this :ref:`io.realm.Realm ` contains any objects. - - - - - - - - - **Returns** - - ``true`` if empty, \@{code false} otherwise. - - - - - - - - - **Overrides** - - ``isEmpty`` in class **BaseRealm** - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _DynamicRealm_removeAllChangeListeners: - -.. _DynamicRealm_removeAllChangeListeners__: - -.. _io_realm_DynamicRealm_removeAllChangeListeners: - -.. _io_realm_DynamicRealm_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _DynamicRealm_removeChangeListener: - -.. _DynamicRealm_removeChangeListener__: - -.. _io_realm_DynamicRealm_removeChangeListener: - -.. _io_realm_DynamicRealm_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_DynamicRealm_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_DynamicRealm_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _DynamicRealm_removeChangeListener_io_realm_RealmChangeListener_: - -.. _DynamicRealm_removeChangeListener_RealmChangeListener_: - -.. _io_realm_DynamicRealm_removeChangeListener_RealmChangeListener_DynamicRealm__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _where: - -.. _where__: - -.. _DynamicRealm_where: - -.. _DynamicRealm_where__: - -.. _io_realm_DynamicRealm_where: - -.. _io_realm_DynamicRealm_where__: - - - -where ------ - -.. _io_realm_DynamicRealm_where_java_lang_String_: - -.. _io_realm_DynamicRealm_where_String_: - -.. _where_java_lang_String_: - -.. _where_String_: - -.. _DynamicRealm_where_java_lang_String_: - -.. _DynamicRealm_where_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` ( - | `String `__ className - | ) - - - - - * - Returns a RealmQuery, which can be used to query the provided class. - - - - - **Parameters** - - - ``className`` - the class of the object which is to be queried. - - - - - - - - **Returns** - - a RealmQuery, which can be used to query for specific objects of provided type. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the class doesn't exist. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmQuery ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt b/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt deleted file mode 100644 index 6751733623..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm/Callback.txt +++ /dev/null @@ -1,274 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DynamicRealm.Callback -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm_Callback: - - - -io.realm -======== - - - | `java.lang.Object `__ - | **io.realm.BaseRealm.InstanceCallback** - | io.realm.DynamicRealm.Callback - - - - -**Enclosing class:** - -:ref:`DynamicRealm ` - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Callback ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - Deliver an error happens when creating the Realm instance to the caller thread. - - - - - * - public abstract **void** - - | :ref:`onSuccess ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm.InstanceCallback**: ``onSuccess`` , ``onError`` - - - - -Constructor Detail -================== - -.. _Callback: - -.. _Callback__: - -.. _io_realm_DynamicRealm_Callback: - -.. _io_realm_DynamicRealm_Callback__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Callback ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _Callback_onError: - -.. _Callback_onError__: - -.. _DynamicRealm_Callback_onError: - -.. _DynamicRealm_Callback_onError__: - -.. _io_realm_DynamicRealm_Callback_onError: - -.. _io_realm_DynamicRealm_Callback_onError__: - - - -onError -------- - -.. _io_realm_DynamicRealm_Callback_onError_java_lang_Throwable_: - -.. _io_realm_DynamicRealm_Callback_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _DynamicRealm_Callback_onError_java_lang_Throwable_: - -.. _DynamicRealm_Callback_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - - - * - Deliver an error happens when creating the Realm instance to the caller thread. The default implementation will throw an exception on the caller thread. - - - - - - - - - - - **Overrides** - - ``onError`` in class **InstanceCallback** - - - - - - -.. _onSuccess: - -.. _onSuccess__: - -.. _Callback_onSuccess: - -.. _Callback_onSuccess__: - -.. _DynamicRealm_Callback_onSuccess: - -.. _DynamicRealm_Callback_onSuccess__: - -.. _io_realm_DynamicRealm_Callback_onSuccess: - -.. _io_realm_DynamicRealm_Callback_onSuccess__: - - - -onSuccess ---------- - -.. _io_realm_DynamicRealm_Callback_onSuccess_io_realm_DynamicRealm_: - -.. _io_realm_DynamicRealm_Callback_onSuccess_DynamicRealm_: - -.. _onSuccess_io_realm_DynamicRealm_: - -.. _onSuccess_DynamicRealm_: - -.. _DynamicRealm_Callback_onSuccess_io_realm_DynamicRealm_: - -.. _DynamicRealm_Callback_onSuccess_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`onSuccess ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - * - - - - - - - - - - - - - - **Overrides** - - ``onSuccess`` in class **InstanceCallback** - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt deleted file mode 100644 index 5f5a4d17bf..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction.txt +++ /dev/null @@ -1,147 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface DynamicRealm.Transaction -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm_Transaction: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`DynamicRealm ` - - - -Encapsulates a Realm transaction.Using this class will automatically handle **io.realm.DynamicRealm.beginTransaction()** and **io.realm.DynamicRealm.commitTransaction()** If any exception is thrown during the transaction **io.realm.DynamicRealm.cancelTransaction()** will be called instead of **io.realm.DynamicRealm.commitTransaction()**. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`DynamicRealm.Transaction.Callback ` - - - * - ``public static interface`` - - :ref:`DynamicRealm.Transaction.OnSuccess ` - - - * - ``public static interface`` - - :ref:`DynamicRealm.Transaction.OnError ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`execute ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - - - - - - -Method Detail -============= - -.. _execute: - -.. _execute__: - -.. _Transaction_execute: - -.. _Transaction_execute__: - -.. _DynamicRealm_Transaction_execute: - -.. _DynamicRealm_Transaction_execute__: - -.. _io_realm_DynamicRealm_Transaction_execute: - -.. _io_realm_DynamicRealm_Transaction_execute__: - - - -execute -------- - -.. _io_realm_DynamicRealm_Transaction_execute_io_realm_DynamicRealm_: - -.. _io_realm_DynamicRealm_Transaction_execute_DynamicRealm_: - -.. _execute_io_realm_DynamicRealm_: - -.. _execute_DynamicRealm_: - -.. _DynamicRealm_Transaction_execute_io_realm_DynamicRealm_: - -.. _DynamicRealm_Transaction_execute_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`execute ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt deleted file mode 100644 index 8f6291ab5e..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/Callback.txt +++ /dev/null @@ -1,244 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DynamicRealm.Transaction.Callback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm_Transaction_Callback: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.DynamicRealm.Transaction.Callback - - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Callback ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Exception `__ ignore - | ) - - - - - - - - * - public **void** - - | :ref:`onSuccess ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Callback: - -.. _Callback__: - -.. _io_realm_DynamicRealm_Transaction_Callback: - -.. _io_realm_DynamicRealm_Transaction_Callback__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Callback ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _Callback_onError: - -.. _Callback_onError__: - -.. _DynamicRealm_Transaction_Callback_onError: - -.. _DynamicRealm_Transaction_Callback_onError__: - -.. _io_realm_DynamicRealm_Transaction_Callback_onError: - -.. _io_realm_DynamicRealm_Transaction_Callback_onError__: - - - -onError -------- - -.. _io_realm_DynamicRealm_Transaction_Callback_onError_java_lang_Exception_: - -.. _io_realm_DynamicRealm_Transaction_Callback_onError_Exception_: - -.. _onError_java_lang_Exception_: - -.. _onError_Exception_: - -.. _DynamicRealm_Transaction_Callback_onError_java_lang_Exception_: - -.. _DynamicRealm_Transaction_Callback_onError_Exception_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Exception `__ ignore - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _onSuccess: - -.. _onSuccess__: - -.. _Callback_onSuccess: - -.. _Callback_onSuccess__: - -.. _DynamicRealm_Transaction_Callback_onSuccess: - -.. _DynamicRealm_Transaction_Callback_onSuccess__: - -.. _io_realm_DynamicRealm_Transaction_Callback_onSuccess: - -.. _io_realm_DynamicRealm_Transaction_Callback_onSuccess__: - - - -onSuccess ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onSuccess ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt deleted file mode 100644 index 0908b819bd..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnError.txt +++ /dev/null @@ -1,121 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface DynamicRealm.Transaction.OnError -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm_Transaction_OnError: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread about error during the transaction. The transaction will be rolled back and the background Realm will be closed before invoking :ref:`onError(Throwable) ` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ error - | ) - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _OnError_onError: - -.. _OnError_onError__: - -.. _DynamicRealm_Transaction_OnError_onError: - -.. _DynamicRealm_Transaction_OnError_onError__: - -.. _io_realm_DynamicRealm_Transaction_OnError_onError: - -.. _io_realm_DynamicRealm_Transaction_OnError_onError__: - - - -onError -------- - -.. _io_realm_DynamicRealm_Transaction_OnError_onError_java_lang_Throwable_: - -.. _io_realm_DynamicRealm_Transaction_OnError_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _DynamicRealm_Transaction_OnError_onError_java_lang_Throwable_: - -.. _DynamicRealm_Transaction_OnError_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ error - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnSuccess.txt b/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnSuccess.txt deleted file mode 100644 index 508094a9bc..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealm/Transaction/OnSuccess.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface DynamicRealm.Transaction.OnSuccess -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealm_Transaction_OnSuccess: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread about the success of the transaction. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onSuccess ` () - | - - - - - - - - - - -Method Detail -============= - -.. _onSuccess: - -.. _onSuccess__: - -.. _OnSuccess_onSuccess: - -.. _OnSuccess_onSuccess__: - -.. _DynamicRealm_Transaction_OnSuccess_onSuccess: - -.. _DynamicRealm_Transaction_OnSuccess_onSuccess__: - -.. _io_realm_DynamicRealm_Transaction_OnSuccess_onSuccess: - -.. _io_realm_DynamicRealm_Transaction_OnSuccess_onSuccess__: - - - -onSuccess ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onSuccess ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/DynamicRealmObject.txt b/source/sdk/java/api/io/realm/DynamicRealmObject.txt deleted file mode 100644 index a342ba9e29..0000000000 --- a/source/sdk/java/api/io/realm/DynamicRealmObject.txt +++ /dev/null @@ -1,5555 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DynamicRealmObject -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_DynamicRealmObject: - - - -io.realm -======== - - - | `java.lang.Object `__ - | :ref:`io.realm.RealmObject ` - | io.realm.DynamicRealmObject - - -Class that wraps a normal RealmObject in order to allow dynamic access instead of a typed interface. Using a DynamicRealmObject is slower than using the regular RealmObject class. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`DynamicRealmObject ` ( - | :ref:`RealmModel ` obj - | ) - - - Creates a dynamic Realm object based on an existing object. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public **E** - - | :ref:`get ` <**E** >( - | `String `__ fieldName - | ) - - - Returns the value for the given field. - - - - - * - public **byte** - - | :ref:`getBlob ` ( - | `String `__ fieldName - | ) - - - Returns the ``byte[]`` value for a given field. - - - - - - - * - public **boolean** - - | :ref:`getBoolean ` ( - | `String `__ fieldName - | ) - - - Returns the ``boolean`` value for a given field. - - - - - - - * - public **byte** - - | :ref:`getByte ` ( - | `String `__ fieldName - | ) - - - Returns the ``byte`` value for a given field. - - - - - - - * - public `Date `__ - - | :ref:`getDate ` ( - | `String `__ fieldName - | ) - - - Returns the ``Date`` value for a given field. - - - - - - - * - public **Decimal128** - - | :ref:`getDecimal128 ` ( - | `String `__ fieldName - | ) - - - Returns the ``Decimal128`` value for a given field. - - - - - - - * - public :ref:`RealmDictionary ` - - | :ref:`getDictionary ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Returns the :ref:`RealmDictionary ` containing only primitive values. - - - - - - - * - public :ref:`RealmDictionary ` - - | :ref:`getDictionary ` ( - | `String `__ fieldName - | ) - - - Returns the :ref:`RealmDictionary ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - - - - - - * - public **double** - - | :ref:`getDouble ` ( - | `String `__ fieldName - | ) - - - Returns the ``double`` value for a given field. - - - - - - - * - public :ref:`DynamicRealm ` - - | :ref:`getDynamicRealm ` () - | - - - Returns :ref:`DynamicRealm ` instance where this :ref:`DynamicRealmObject ` belongs. - - - - - - - * - public `String `__ - - | :ref:`getFieldNames ` () - | - - - Returns the list of field names on this object. - - - - - * - public :ref:`RealmFieldType ` - - | :ref:`getFieldType ` ( - | `String `__ fieldName - | ) - - - Returns the type used by the underlying storage engine to represent this field. - - - - - * - public **float** - - | :ref:`getFloat ` ( - | `String `__ fieldName - | ) - - - Returns the ``float`` value for a given field. - - - - - - - * - public **int** - - | :ref:`getInt ` ( - | `String `__ fieldName - | ) - - - Returns the ``int`` value for a given field. - - - - - - - * - public :ref:`RealmList ` - - | :ref:`getList ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Returns the :ref:`RealmList ` containing only primitive values. - - - - - - - * - public :ref:`RealmList ` - - | :ref:`getList ` ( - | `String `__ fieldName - | ) - - - Returns the :ref:`RealmList ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - - - - - - * - public **long** - - | :ref:`getLong ` ( - | `String `__ fieldName - | ) - - - Returns the ``long`` value for a given field. - - - - - - - * - public :ref:`DynamicRealmObject ` - - | :ref:`getObject ` ( - | `String `__ fieldName - | ) - - - Returns the object being linked to from this field. - - - - - * - public **ObjectId** - - | :ref:`getObjectId ` ( - | `String `__ fieldName - | ) - - - Returns the ``ObjectId`` value for a given field. - - - - - - - * - public :ref:`RealmAny ` - - | :ref:`getRealmAny ` ( - | `String `__ fieldName - | ) - - - Returns the ``RealmAny`` value for a given field. - - - - - - - * - public :ref:`RealmSet ` - - | :ref:`getRealmSet ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Returns the :ref:`RealmSet ` containing only primitive values. - - - - - - - * - public :ref:`RealmSet ` - - | :ref:`getRealmSet ` ( - | `String `__ fieldName - | ) - - - Returns the :ref:`RealmSet ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - - - - - - * - public **short** - - | :ref:`getShort ` ( - | `String `__ fieldName - | ) - - - Returns the ``short`` value for a given field. - - - - - - - * - public `String `__ - - | :ref:`getString ` ( - | `String `__ fieldName - | ) - - - Returns the ``String`` value for a given field. - - - - - - - * - public `String `__ - - | :ref:`getType ` () - | - - - Returns the type of object. - - - - - * - public `UUID `__ - - | :ref:`getUUID ` ( - | `String `__ fieldName - | ) - - - Returns the ``UUID`` value for a given field. - - - - - - - * - public **boolean** - - | :ref:`hasField ` ( - | `String `__ fieldName - | ) - - - Checks whether an object has the given field or not. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - Returns a hash code value for the :ref:`DynamicRealmObject ` object. - - - - - - - * - public **boolean** - - | :ref:`isNull ` ( - | `String `__ fieldName - | ) - - - Checks if the value of a given field is ``null`` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`linkingObjects ` ( - | `String `__ srcClassName, - | `String `__ srcFieldName - | ) - - - Returns :ref:`RealmResults ` containing all ``srcClassName`` class objects that have a relationship to this object from ``srcFieldName`` field. - - - - - - - * - public **void** - - | :ref:`realm$injectObjectContext ` () - | - - - - - - - - * - public :ref:`ProxyState ` - - | :ref:`realmGet$proxyState ` () - | - - - - - - - - * - public **void** - - | :ref:`set ` ( - | `String `__ fieldName, - | `Object `__ value - | ) - - - Sets the value for the given field. - - - - - * - public **void** - - | :ref:`setBlob ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - Sets the binary value of the given field. - - - - - * - public **void** - - | :ref:`setBoolean ` ( - | `String `__ fieldName, - | **boolean** value - | ) - - - Sets the ``boolean`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setByte ` ( - | `String `__ fieldName, - | **byte** value - | ) - - - Sets the ``byte`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - Sets the ``Date`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setDecimal128 ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Sets the ``Decimal128`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setDictionary ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmDictionary\ ` dictionary - | ) - - - Sets the reference to a :ref:`RealmDictionary ` on the given field. - - - - - - - * - public **void** - - | :ref:`setDouble ` ( - | `String `__ fieldName, - | **double** value - | ) - - - Sets the ``double`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setFloat ` ( - | `String `__ fieldName, - | **float** value - | ) - - - Sets the ``float`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setInt ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Sets the ``int`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setList ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Sets the reference to a :ref:`RealmList ` on the given field. - - - - - - - * - public **void** - - | :ref:`setLong ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Sets the ``long`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setNull ` ( - | `String `__ fieldName - | ) - - - Sets the value to ``null`` for the given field. - - - - - - - * - public **void** - - | :ref:`setObject ` ( - | `String `__ fieldName, - | :ref:`DynamicRealmObject ` value - | ) - - - Sets a reference to another object on the given field. - - - - - * - public **void** - - | :ref:`setObjectId ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Sets the ``ObjectId`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setRealmAny ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Sets the ``RealmAny`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setRealmSet ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmSet\ ` set - | ) - - - Sets the reference to a :ref:`RealmSet ` on the given field. - - - - - - - * - public **void** - - | :ref:`setShort ` ( - | `String `__ fieldName, - | **short** value - | ) - - - Sets the ``short`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Sets the ``String`` value of the given field. - - - - - - - * - public **void** - - | :ref:`setUUID ` ( - | `String `__ fieldName, - | `UUID `__ value - | ) - - - Sets the ``UUID`` value of the given field. - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.RealmObject ` : ``deleteFromRealm`` , ``deleteFromRealm`` , ``isValid`` , ``isValid`` , ``isFrozen`` , ``freeze`` , ``isFrozen`` , ``freeze`` , ``isLoaded`` , ``isLoaded`` , ``isManaged`` , ``isManaged`` , ``getRealm`` , ``getRealm`` , ``load`` , ``load`` , ``addChangeListener`` , ``addChangeListener`` , ``addChangeListener`` , ``addChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeAllChangeListeners`` , ``removeAllChangeListeners`` , ``asFlowable`` , ``asChangesetObservable`` , ``asFlowable`` , ``asChangesetObservable`` - - - - -Constructor Detail -================== - -.. _DynamicRealmObject: - -.. _DynamicRealmObject__: - -.. _io_realm_DynamicRealmObject: - -.. _io_realm_DynamicRealmObject__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealmObject ` ( - | :ref:`RealmModel ` obj - | ) - - - - - * - Creates a dynamic Realm object based on an existing object. - - - - - **Parameters** - - - ``obj`` - the Realm object to convert to a dynamic object. Only objects managed by :ref:`Realm ` can be used. - - - - - - - - - - - - - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _DynamicRealmObject_equals: - -.. _DynamicRealmObject_equals__: - -.. _io_realm_DynamicRealmObject_equals: - -.. _io_realm_DynamicRealmObject_equals__: - - - -equals ------- - -.. _io_realm_DynamicRealmObject_equals_java_lang_Object_: - -.. _io_realm_DynamicRealmObject_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _DynamicRealmObject_equals_java_lang_Object_: - -.. _DynamicRealmObject_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _get: - -.. _get__: - -.. _DynamicRealmObject_get: - -.. _DynamicRealmObject_get__: - -.. _io_realm_DynamicRealmObject_get: - -.. _io_realm_DynamicRealmObject_get__: - - - -get ----- - -.. _io_realm_DynamicRealmObject_get_java_lang_String_: - -.. _io_realm_DynamicRealmObject_get_String_: - -.. _get_java_lang_String_: - -.. _get_String_: - -.. _DynamicRealmObject_get_java_lang_String_: - -.. _DynamicRealmObject_get_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`get ` <**E** >( - | `String `__ fieldName - | ) - - - - - * - Returns the value for the given field. - - - - - **Parameters** - - - ``fieldName`` - name of the field. - - - - - - - - **Returns** - - the field value. - - - - - **Throws** - - - `ClassCastException `__ - if the field doesn't contain a field of the defined return type. - - - - - - - - - - - - -.. _getBlob: - -.. _getBlob__: - -.. _DynamicRealmObject_getBlob: - -.. _DynamicRealmObject_getBlob__: - -.. _io_realm_DynamicRealmObject_getBlob: - -.. _io_realm_DynamicRealmObject_getBlob__: - - - -getBlob -------- - -.. _io_realm_DynamicRealmObject_getBlob_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getBlob_String_: - -.. _getBlob_java_lang_String_: - -.. _getBlob_String_: - -.. _DynamicRealmObject_getBlob_java_lang_String_: - -.. _DynamicRealmObject_getBlob_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`getBlob ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``byte[]`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the byte[] value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain binary data. - - - - - - - - - - - - -.. _getBoolean: - -.. _getBoolean__: - -.. _DynamicRealmObject_getBoolean: - -.. _DynamicRealmObject_getBoolean__: - -.. _io_realm_DynamicRealmObject_getBoolean: - -.. _io_realm_DynamicRealmObject_getBoolean__: - - - -getBoolean ----------- - -.. _io_realm_DynamicRealmObject_getBoolean_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getBoolean_String_: - -.. _getBoolean_java_lang_String_: - -.. _getBoolean_String_: - -.. _DynamicRealmObject_getBoolean_java_lang_String_: - -.. _DynamicRealmObject_getBoolean_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`getBoolean ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``boolean`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the boolean value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain booleans. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getByte: - -.. _getByte__: - -.. _DynamicRealmObject_getByte: - -.. _DynamicRealmObject_getByte__: - -.. _io_realm_DynamicRealmObject_getByte: - -.. _io_realm_DynamicRealmObject_getByte__: - - - -getByte -------- - -.. _io_realm_DynamicRealmObject_getByte_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getByte_String_: - -.. _getByte_java_lang_String_: - -.. _getByte_String_: - -.. _DynamicRealmObject_getByte_java_lang_String_: - -.. _DynamicRealmObject_getByte_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`getByte ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``byte`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the byte value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getDate: - -.. _getDate__: - -.. _DynamicRealmObject_getDate: - -.. _DynamicRealmObject_getDate__: - -.. _io_realm_DynamicRealmObject_getDate: - -.. _io_realm_DynamicRealmObject_getDate__: - - - -getDate -------- - -.. _io_realm_DynamicRealmObject_getDate_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getDate_String_: - -.. _getDate_java_lang_String_: - -.. _getDate_String_: - -.. _DynamicRealmObject_getDate_java_lang_String_: - -.. _DynamicRealmObject_getDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`getDate ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``Date`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the Date value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Dates. - - - - - - - - - - - - -.. _getDecimal128: - -.. _getDecimal128__: - -.. _DynamicRealmObject_getDecimal128: - -.. _DynamicRealmObject_getDecimal128__: - -.. _io_realm_DynamicRealmObject_getDecimal128: - -.. _io_realm_DynamicRealmObject_getDecimal128__: - - - -getDecimal128 -------------- - -.. _io_realm_DynamicRealmObject_getDecimal128_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getDecimal128_String_: - -.. _getDecimal128_java_lang_String_: - -.. _getDecimal128_String_: - -.. _DynamicRealmObject_getDecimal128_java_lang_String_: - -.. _DynamicRealmObject_getDecimal128_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **Decimal128** :ref:`getDecimal128 ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``Decimal128`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the Decimal128 value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Decimal128. - - - - - - - - - - - - -.. _getDictionary: - -.. _getDictionary__: - -.. _DynamicRealmObject_getDictionary: - -.. _DynamicRealmObject_getDictionary__: - -.. _io_realm_DynamicRealmObject_getDictionary: - -.. _io_realm_DynamicRealmObject_getDictionary__: - - - -getDictionary -------------- - -.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String__Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_String_Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_String__Class_: - -.. _getDictionary_java_lang_String_java_lang_Class_: - -.. _getDictionary_java_lang_String__java_lang_Class_: - -.. _getDictionary_java_lang_String_Class_: - -.. _getDictionary_java_lang_String__Class_: - -.. _getDictionary_String_java_lang_Class_: - -.. _getDictionary_String__java_lang_Class_: - -.. _getDictionary_String_Class_: - -.. _getDictionary_String__Class_: - -.. _DynamicRealmObject_getDictionary_java_lang_String_java_lang_Class_: - -.. _DynamicRealmObject_getDictionary_java_lang_String__java_lang_Class_: - -.. _DynamicRealmObject_getDictionary_java_lang_String_Class_: - -.. _DynamicRealmObject_getDictionary_java_lang_String__Class_: - -.. _DynamicRealmObject_getDictionary_String_java_lang_Class_: - -.. _DynamicRealmObject_getDictionary_String__java_lang_Class_: - -.. _DynamicRealmObject_getDictionary_String_Class_: - -.. _DynamicRealmObject_getDictionary_String__Class_: - -.. _io_realm_DynamicRealmObject_getDictionary_String__Class_E__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmDictionary ` :ref:`getDictionary ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Returns the :ref:`RealmDictionary ` containing only primitive values. - - If the dictionary contains references to other Realm objects, use :ref:`getDictionary(String) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - ``primitiveType`` - the type of elements in the dictionary. Only primitive types are supported. - - - - - - - - **Returns** - - the :ref:`RealmDictionary ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a dictionary of primitive objects. - - - - - - - - - - -.. _io_realm_DynamicRealmObject_getDictionary_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getDictionary_String_: - -.. _getDictionary_java_lang_String_: - -.. _getDictionary_String_: - -.. _DynamicRealmObject_getDictionary_java_lang_String_: - -.. _DynamicRealmObject_getDictionary_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmDictionary ` :ref:`getDictionary ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the :ref:`RealmDictionary ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - If the dictionary contains primitive types, use :ref:`getDictionary(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the :ref:`RealmDictionary ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a dictionary of objects. - - - - - - - - - - - - -.. _getDouble: - -.. _getDouble__: - -.. _DynamicRealmObject_getDouble: - -.. _DynamicRealmObject_getDouble__: - -.. _io_realm_DynamicRealmObject_getDouble: - -.. _io_realm_DynamicRealmObject_getDouble__: - - - -getDouble ---------- - -.. _io_realm_DynamicRealmObject_getDouble_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getDouble_String_: - -.. _getDouble_java_lang_String_: - -.. _getDouble_String_: - -.. _DynamicRealmObject_getDouble_java_lang_String_: - -.. _DynamicRealmObject_getDouble_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`getDouble ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``double`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the double value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain doubles. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getDynamicRealm: - -.. _getDynamicRealm__: - -.. _DynamicRealmObject_getDynamicRealm: - -.. _DynamicRealmObject_getDynamicRealm__: - -.. _io_realm_DynamicRealmObject_getDynamicRealm: - -.. _io_realm_DynamicRealmObject_getDynamicRealm__: - - - -getDynamicRealm ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealm ` :ref:`getDynamicRealm ` () - | - - - - - * - Returns :ref:`DynamicRealm ` instance where this :ref:`DynamicRealmObject ` belongs. - - You **must not** call **DynamicRealm.close()** against returned instance. - - - - - - - - - - - **Returns** - - :ref:`DynamicRealm ` instance where this object belongs. - - - - - - - **Throws** - - - `IllegalStateException `__ - if this object was deleted or the corresponding :ref:`DynamicRealm ` was already closed. - - - - - - - - - - - - - - -.. _getFieldNames: - -.. _getFieldNames__: - -.. _DynamicRealmObject_getFieldNames: - -.. _DynamicRealmObject_getFieldNames__: - -.. _io_realm_DynamicRealmObject_getFieldNames: - -.. _io_realm_DynamicRealmObject_getFieldNames__: - - - -getFieldNames -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getFieldNames ` () - | - - - - - * - Returns the list of field names on this object. - - - - - - - **Returns** - - list of field names on this objects or the empty list if the object doesn't have any fields. - - - - - - - - - - - -.. _getFieldType: - -.. _getFieldType__: - -.. _DynamicRealmObject_getFieldType: - -.. _DynamicRealmObject_getFieldType__: - -.. _io_realm_DynamicRealmObject_getFieldType: - -.. _io_realm_DynamicRealmObject_getFieldType__: - - - -getFieldType ------------- - -.. _io_realm_DynamicRealmObject_getFieldType_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getFieldType_String_: - -.. _getFieldType_java_lang_String_: - -.. _getFieldType_String_: - -.. _DynamicRealmObject_getFieldType_java_lang_String_: - -.. _DynamicRealmObject_getFieldType_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFieldType ` :ref:`getFieldType ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the type used by the underlying storage engine to represent this field. - - - - - - - **Returns** - - the underlying type used by Realm to represent this field. - - - - - - - - - - - -.. _getFloat: - -.. _getFloat__: - -.. _DynamicRealmObject_getFloat: - -.. _DynamicRealmObject_getFloat__: - -.. _io_realm_DynamicRealmObject_getFloat: - -.. _io_realm_DynamicRealmObject_getFloat__: - - - -getFloat --------- - -.. _io_realm_DynamicRealmObject_getFloat_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getFloat_String_: - -.. _getFloat_java_lang_String_: - -.. _getFloat_String_: - -.. _DynamicRealmObject_getFloat_java_lang_String_: - -.. _DynamicRealmObject_getFloat_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **float** :ref:`getFloat ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``float`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the float value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain floats. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getInt: - -.. _getInt__: - -.. _DynamicRealmObject_getInt: - -.. _DynamicRealmObject_getInt__: - -.. _io_realm_DynamicRealmObject_getInt: - -.. _io_realm_DynamicRealmObject_getInt__: - - - -getInt ------- - -.. _io_realm_DynamicRealmObject_getInt_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getInt_String_: - -.. _getInt_java_lang_String_: - -.. _getInt_String_: - -.. _DynamicRealmObject_getInt_java_lang_String_: - -.. _DynamicRealmObject_getInt_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getInt ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``int`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the int value. Integer values exceeding ``Integer.MAX_VALUE`` will wrap. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getList: - -.. _getList__: - -.. _DynamicRealmObject_getList: - -.. _DynamicRealmObject_getList__: - -.. _io_realm_DynamicRealmObject_getList: - -.. _io_realm_DynamicRealmObject_getList__: - - - -getList -------- - -.. _io_realm_DynamicRealmObject_getList_java_lang_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getList_java_lang_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getList_java_lang_String_Class_: - -.. _io_realm_DynamicRealmObject_getList_java_lang_String__Class_: - -.. _io_realm_DynamicRealmObject_getList_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getList_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getList_String_Class_: - -.. _io_realm_DynamicRealmObject_getList_String__Class_: - -.. _getList_java_lang_String_java_lang_Class_: - -.. _getList_java_lang_String__java_lang_Class_: - -.. _getList_java_lang_String_Class_: - -.. _getList_java_lang_String__Class_: - -.. _getList_String_java_lang_Class_: - -.. _getList_String__java_lang_Class_: - -.. _getList_String_Class_: - -.. _getList_String__Class_: - -.. _DynamicRealmObject_getList_java_lang_String_java_lang_Class_: - -.. _DynamicRealmObject_getList_java_lang_String__java_lang_Class_: - -.. _DynamicRealmObject_getList_java_lang_String_Class_: - -.. _DynamicRealmObject_getList_java_lang_String__Class_: - -.. _DynamicRealmObject_getList_String_java_lang_Class_: - -.. _DynamicRealmObject_getList_String__java_lang_Class_: - -.. _DynamicRealmObject_getList_String_Class_: - -.. _DynamicRealmObject_getList_String__Class_: - -.. _io_realm_DynamicRealmObject_getList_String__Class_E__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmList ` :ref:`getList ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Returns the :ref:`RealmList ` containing only primitive values. - - If the list contains references to other Realm objects, use :ref:`getList(String) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - ``primitiveType`` - the type of elements in the list. Only primitive types are supported. - - - - - - - - **Returns** - - the :ref:`RealmList ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of primitive objects. - - - - - - - - - - -.. _io_realm_DynamicRealmObject_getList_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getList_String_: - -.. _getList_java_lang_String_: - -.. _getList_String_: - -.. _DynamicRealmObject_getList_java_lang_String_: - -.. _DynamicRealmObject_getList_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmList ` :ref:`getList ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the :ref:`RealmList ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - If the list contains primitive types, use :ref:`getList(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the :ref:`RealmList ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a list of objects. - - - - - - - - - - - - -.. _getLong: - -.. _getLong__: - -.. _DynamicRealmObject_getLong: - -.. _DynamicRealmObject_getLong__: - -.. _io_realm_DynamicRealmObject_getLong: - -.. _io_realm_DynamicRealmObject_getLong__: - - - -getLong -------- - -.. _io_realm_DynamicRealmObject_getLong_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getLong_String_: - -.. _getLong_java_lang_String_: - -.. _getLong_String_: - -.. _DynamicRealmObject_getLong_java_lang_String_: - -.. _DynamicRealmObject_getLong_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getLong ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``long`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the long value. Integer values exceeding ``Long.MAX_VALUE`` will wrap. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getObject: - -.. _getObject__: - -.. _DynamicRealmObject_getObject: - -.. _DynamicRealmObject_getObject__: - -.. _io_realm_DynamicRealmObject_getObject: - -.. _io_realm_DynamicRealmObject_getObject__: - - - -getObject ---------- - -.. _io_realm_DynamicRealmObject_getObject_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getObject_String_: - -.. _getObject_java_lang_String_: - -.. _getObject_String_: - -.. _DynamicRealmObject_getObject_java_lang_String_: - -.. _DynamicRealmObject_getObject_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DynamicRealmObject ` :ref:`getObject ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the object being linked to from this field. - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the :ref:`DynamicRealmObject ` representation of the linked object or ``null`` if no object is linked. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain links to other objects. - - - - - - - - - - - - -.. _getObjectId: - -.. _getObjectId__: - -.. _DynamicRealmObject_getObjectId: - -.. _DynamicRealmObject_getObjectId__: - -.. _io_realm_DynamicRealmObject_getObjectId: - -.. _io_realm_DynamicRealmObject_getObjectId__: - - - -getObjectId ------------ - -.. _io_realm_DynamicRealmObject_getObjectId_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getObjectId_String_: - -.. _getObjectId_java_lang_String_: - -.. _getObjectId_String_: - -.. _DynamicRealmObject_getObjectId_java_lang_String_: - -.. _DynamicRealmObject_getObjectId_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **ObjectId** :ref:`getObjectId ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``ObjectId`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the ObjectId value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain ObjectId. - - - - - - - - - - - - -.. _getRealmAny: - -.. _getRealmAny__: - -.. _DynamicRealmObject_getRealmAny: - -.. _DynamicRealmObject_getRealmAny__: - -.. _io_realm_DynamicRealmObject_getRealmAny: - -.. _io_realm_DynamicRealmObject_getRealmAny__: - - - -getRealmAny ------------ - -.. _io_realm_DynamicRealmObject_getRealmAny_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getRealmAny_String_: - -.. _getRealmAny_java_lang_String_: - -.. _getRealmAny_String_: - -.. _DynamicRealmObject_getRealmAny_java_lang_String_: - -.. _DynamicRealmObject_getRealmAny_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAny ` :ref:`getRealmAny ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``RealmAny`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the RealmAny value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain RealmAny. - - - - - - - - - - - - -.. _getRealmSet: - -.. _getRealmSet__: - -.. _DynamicRealmObject_getRealmSet: - -.. _DynamicRealmObject_getRealmSet__: - -.. _io_realm_DynamicRealmObject_getRealmSet: - -.. _io_realm_DynamicRealmObject_getRealmSet__: - - - -getRealmSet ------------ - -.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String__Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String_java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String__java_lang_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String_Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String__Class_: - -.. _getRealmSet_java_lang_String_java_lang_Class_: - -.. _getRealmSet_java_lang_String__java_lang_Class_: - -.. _getRealmSet_java_lang_String_Class_: - -.. _getRealmSet_java_lang_String__Class_: - -.. _getRealmSet_String_java_lang_Class_: - -.. _getRealmSet_String__java_lang_Class_: - -.. _getRealmSet_String_Class_: - -.. _getRealmSet_String__Class_: - -.. _DynamicRealmObject_getRealmSet_java_lang_String_java_lang_Class_: - -.. _DynamicRealmObject_getRealmSet_java_lang_String__java_lang_Class_: - -.. _DynamicRealmObject_getRealmSet_java_lang_String_Class_: - -.. _DynamicRealmObject_getRealmSet_java_lang_String__Class_: - -.. _DynamicRealmObject_getRealmSet_String_java_lang_Class_: - -.. _DynamicRealmObject_getRealmSet_String__java_lang_Class_: - -.. _DynamicRealmObject_getRealmSet_String_Class_: - -.. _DynamicRealmObject_getRealmSet_String__Class_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String__Class_E__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` :ref:`getRealmSet ` <**E** >( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Returns the :ref:`RealmSet ` containing only primitive values. - - If the set contains references to other Realm objects, use :ref:`getRealmSet(String) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - ``primitiveType`` - the type of elements in the set. Only primitive types are supported. - - - - - - - - **Returns** - - the :ref:`RealmSet ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a set of primitive objects. - - - - - - - - - - -.. _io_realm_DynamicRealmObject_getRealmSet_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getRealmSet_String_: - -.. _getRealmSet_java_lang_String_: - -.. _getRealmSet_String_: - -.. _DynamicRealmObject_getRealmSet_java_lang_String_: - -.. _DynamicRealmObject_getRealmSet_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` :ref:`getRealmSet ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the :ref:`RealmSet ` of :ref:`DynamicRealmObject ` s being linked from the given field. - - If the set contains primitive types, use :ref:`getRealmSet(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the :ref:`RealmSet ` data for this field. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain a set of objects. - - - - - - - - - - - - -.. _getShort: - -.. _getShort__: - -.. _DynamicRealmObject_getShort: - -.. _DynamicRealmObject_getShort__: - -.. _io_realm_DynamicRealmObject_getShort: - -.. _io_realm_DynamicRealmObject_getShort__: - - - -getShort --------- - -.. _io_realm_DynamicRealmObject_getShort_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getShort_String_: - -.. _getShort_java_lang_String_: - -.. _getShort_String_: - -.. _DynamicRealmObject_getShort_java_lang_String_: - -.. _DynamicRealmObject_getShort_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **short** :ref:`getShort ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``short`` value for a given field. - - If the field is nullable, use :ref:`isNull(String) ` to check for ``null`` instead of using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the short value. Integer values exceeding ``Short.MAX_VALUE`` will wrap. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain integers. - - - - - :ref:`io.realm.exceptions.RealmException ` - if the return value would be ``null`` . - - - - - - - - - - - - - - -.. _getString: - -.. _getString__: - -.. _DynamicRealmObject_getString: - -.. _DynamicRealmObject_getString__: - -.. _io_realm_DynamicRealmObject_getString: - -.. _io_realm_DynamicRealmObject_getString__: - - - -getString ---------- - -.. _io_realm_DynamicRealmObject_getString_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getString_String_: - -.. _getString_java_lang_String_: - -.. _getString_String_: - -.. _DynamicRealmObject_getString_java_lang_String_: - -.. _DynamicRealmObject_getString_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getString ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``String`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the String value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain Strings. - - - - - - - - - - - - -.. _getType: - -.. _getType__: - -.. _DynamicRealmObject_getType: - -.. _DynamicRealmObject_getType__: - -.. _io_realm_DynamicRealmObject_getType: - -.. _io_realm_DynamicRealmObject_getType__: - - - -getType -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getType ` () - | - - - - - * - Returns the type of object. This will normally correspond to the name of a class that is extending :ref:`RealmObject ` . - - - - - - - - - **Returns** - - this objects type. - - - - - - - - - - - -.. _getUUID: - -.. _getUUID__: - -.. _DynamicRealmObject_getUUID: - -.. _DynamicRealmObject_getUUID__: - -.. _io_realm_DynamicRealmObject_getUUID: - -.. _io_realm_DynamicRealmObject_getUUID__: - - - -getUUID -------- - -.. _io_realm_DynamicRealmObject_getUUID_java_lang_String_: - -.. _io_realm_DynamicRealmObject_getUUID_String_: - -.. _getUUID_java_lang_String_: - -.. _getUUID_String_: - -.. _DynamicRealmObject_getUUID_java_lang_String_: - -.. _DynamicRealmObject_getUUID_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `UUID `__ :ref:`getUUID ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the ``UUID`` value for a given field. - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - the UUID value. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or it doesn't contain UUID. - - - - - - - - - - - - -.. _hasField: - -.. _hasField__: - -.. _DynamicRealmObject_hasField: - -.. _DynamicRealmObject_hasField__: - -.. _io_realm_DynamicRealmObject_hasField: - -.. _io_realm_DynamicRealmObject_hasField__: - - - -hasField --------- - -.. _io_realm_DynamicRealmObject_hasField_java_lang_String_: - -.. _io_realm_DynamicRealmObject_hasField_String_: - -.. _hasField_java_lang_String_: - -.. _hasField_String_: - -.. _DynamicRealmObject_hasField_java_lang_String_: - -.. _DynamicRealmObject_hasField_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasField ` ( - | `String `__ fieldName - | ) - - - - - * - Checks whether an object has the given field or not. - - - - - **Parameters** - - - ``fieldName`` - field name to check. - - - - - - - - **Returns** - - ``true`` if the object has a field with the given name, ``false`` otherwise. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _DynamicRealmObject_hashCode: - -.. _DynamicRealmObject_hashCode__: - -.. _io_realm_DynamicRealmObject_hashCode: - -.. _io_realm_DynamicRealmObject_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - Returns a hash code value for the :ref:`DynamicRealmObject ` object. - - By the general contract of `Object.hashCode() `__ , any two objects for which :ref:`equals ` returns ``true`` must return the same hash code value. - - - - Note that a :ref:`RealmObject ` is a live object, and it might be updated by changes from other threads. This means that a hash code value of the object is not stable, and the value should be neither used as a key in HashMap nor saved in HashSet. - - - - - - - - - - - **Returns** - - a hash code value for the object. - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - .. seealso:: - - - - - :ref:`equals ` - - - - - - - - - - - - -.. _isNull: - -.. _isNull__: - -.. _DynamicRealmObject_isNull: - -.. _DynamicRealmObject_isNull__: - -.. _io_realm_DynamicRealmObject_isNull: - -.. _io_realm_DynamicRealmObject_isNull__: - - - -isNull ------- - -.. _io_realm_DynamicRealmObject_isNull_java_lang_String_: - -.. _io_realm_DynamicRealmObject_isNull_String_: - -.. _isNull_java_lang_String_: - -.. _isNull_String_: - -.. _DynamicRealmObject_isNull_java_lang_String_: - -.. _DynamicRealmObject_isNull_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isNull ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if the value of a given field is ``null`` . - - - - - - - **Parameters** - - - ``fieldName`` - the name of the field. - - - - - - - - **Returns** - - ``true`` if field value is null, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - - - - - - - - -.. _linkingObjects: - -.. _linkingObjects__: - -.. _DynamicRealmObject_linkingObjects: - -.. _DynamicRealmObject_linkingObjects__: - -.. _io_realm_DynamicRealmObject_linkingObjects: - -.. _io_realm_DynamicRealmObject_linkingObjects__: - - - -linkingObjects --------------- - -.. _io_realm_DynamicRealmObject_linkingObjects_java_lang_String_java_lang_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_java_lang_String__java_lang_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_java_lang_String_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_java_lang_String__String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_String_java_lang_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_String__java_lang_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_String_String_: - -.. _io_realm_DynamicRealmObject_linkingObjects_String__String_: - -.. _linkingObjects_java_lang_String_java_lang_String_: - -.. _linkingObjects_java_lang_String__java_lang_String_: - -.. _linkingObjects_java_lang_String_String_: - -.. _linkingObjects_java_lang_String__String_: - -.. _linkingObjects_String_java_lang_String_: - -.. _linkingObjects_String__java_lang_String_: - -.. _linkingObjects_String_String_: - -.. _linkingObjects_String__String_: - -.. _DynamicRealmObject_linkingObjects_java_lang_String_java_lang_String_: - -.. _DynamicRealmObject_linkingObjects_java_lang_String__java_lang_String_: - -.. _DynamicRealmObject_linkingObjects_java_lang_String_String_: - -.. _DynamicRealmObject_linkingObjects_java_lang_String__String_: - -.. _DynamicRealmObject_linkingObjects_String_java_lang_String_: - -.. _DynamicRealmObject_linkingObjects_String__java_lang_String_: - -.. _DynamicRealmObject_linkingObjects_String_String_: - -.. _DynamicRealmObject_linkingObjects_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`linkingObjects ` ( - | `String `__ srcClassName, - | `String `__ srcFieldName - | ) - - - - - * - Returns :ref:`RealmResults ` containing all ``srcClassName`` class objects that have a relationship to this object from ``srcFieldName`` field. - - An entry is added for each reference, e.g. if the same reference is in a list multiple times, the src object will show up here multiple times. - - - - - - - **Parameters** - - - ``srcClassName`` - name of the class returned objects belong to. - - - - - ``srcFieldName`` - name of the field in the source class that holds a reference to this object. Field type must be either ``io.realm.RealmFieldType.OBJECT`` or ``io.realm.RealmFieldType.LIST`` . - - - - - - - - - - **Returns** - - the result. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``srcClassName`` is ``null`` or does not exist, the ``srcFieldName`` is ``null`` or does not exist, type of the source field is not supported. - - - - - - - - - - - - - - -.. _realm_injectObjectContext: - -.. _realm_injectObjectContext__: - -.. _DynamicRealmObject_realm_injectObjectContext: - -.. _DynamicRealmObject_realm_injectObjectContext__: - -.. _io_realm_DynamicRealmObject_realm_injectObjectContext: - -.. _io_realm_DynamicRealmObject_realm_injectObjectContext__: - - - -realm$injectObjectContext -------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`realm$injectObjectContext ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _realmGet_proxyState: - -.. _realmGet_proxyState__: - -.. _DynamicRealmObject_realmGet_proxyState: - -.. _DynamicRealmObject_realmGet_proxyState__: - -.. _io_realm_DynamicRealmObject_realmGet_proxyState: - -.. _io_realm_DynamicRealmObject_realmGet_proxyState__: - - - -realmGet$proxyState -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ProxyState ` :ref:`realmGet$proxyState ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _set: - -.. _set__: - -.. _DynamicRealmObject_set: - -.. _DynamicRealmObject_set__: - -.. _io_realm_DynamicRealmObject_set: - -.. _io_realm_DynamicRealmObject_set__: - - - -set ----- - -.. _io_realm_DynamicRealmObject_set_java_lang_String_java_lang_Object_: - -.. _io_realm_DynamicRealmObject_set_java_lang_String__java_lang_Object_: - -.. _io_realm_DynamicRealmObject_set_java_lang_String_Object_: - -.. _io_realm_DynamicRealmObject_set_java_lang_String__Object_: - -.. _io_realm_DynamicRealmObject_set_String_java_lang_Object_: - -.. _io_realm_DynamicRealmObject_set_String__java_lang_Object_: - -.. _io_realm_DynamicRealmObject_set_String_Object_: - -.. _io_realm_DynamicRealmObject_set_String__Object_: - -.. _set_java_lang_String_java_lang_Object_: - -.. _set_java_lang_String__java_lang_Object_: - -.. _set_java_lang_String_Object_: - -.. _set_java_lang_String__Object_: - -.. _set_String_java_lang_Object_: - -.. _set_String__java_lang_Object_: - -.. _set_String_Object_: - -.. _set_String__Object_: - -.. _DynamicRealmObject_set_java_lang_String_java_lang_Object_: - -.. _DynamicRealmObject_set_java_lang_String__java_lang_Object_: - -.. _DynamicRealmObject_set_java_lang_String_Object_: - -.. _DynamicRealmObject_set_java_lang_String__Object_: - -.. _DynamicRealmObject_set_String_java_lang_Object_: - -.. _DynamicRealmObject_set_String__java_lang_Object_: - -.. _DynamicRealmObject_set_String_Object_: - -.. _DynamicRealmObject_set_String__Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`set ` ( - | `String `__ fieldName, - | `Object `__ value - | ) - - - - - * - Sets the value for the given field. This method will automatically try to convert numbers and booleans that are given as ``String`` to their appropriate type. For example ``"10"`` will be converted to ``10`` if the field type is ``int`` . - - Using the typed setters will be faster than using this method. - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or if the input value cannot be converted to the appropriate input type. - - - - - `NumberFormatException `__ - if a String based number cannot be converted properly. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setBlob: - -.. _setBlob__: - -.. _DynamicRealmObject_setBlob: - -.. _DynamicRealmObject_setBlob__: - -.. _io_realm_DynamicRealmObject_setBlob: - -.. _io_realm_DynamicRealmObject_setBlob__: - - - -setBlob -------- - -.. _io_realm_DynamicRealmObject_setBlob_java_lang_String_byte_: - -.. _io_realm_DynamicRealmObject_setBlob_java_lang_String__byte_: - -.. _io_realm_DynamicRealmObject_setBlob_java_lang_String_byte____: - -.. _io_realm_DynamicRealmObject_setBlob_java_lang_String__byte____: - -.. _io_realm_DynamicRealmObject_setBlob_String_byte_: - -.. _io_realm_DynamicRealmObject_setBlob_String__byte_: - -.. _io_realm_DynamicRealmObject_setBlob_String_byte____: - -.. _io_realm_DynamicRealmObject_setBlob_String__byte____: - -.. _setBlob_java_lang_String_byte_: - -.. _setBlob_java_lang_String__byte_: - -.. _setBlob_java_lang_String_byte____: - -.. _setBlob_java_lang_String__byte____: - -.. _setBlob_String_byte_: - -.. _setBlob_String__byte_: - -.. _setBlob_String_byte____: - -.. _setBlob_String__byte____: - -.. _DynamicRealmObject_setBlob_java_lang_String_byte_: - -.. _DynamicRealmObject_setBlob_java_lang_String__byte_: - -.. _DynamicRealmObject_setBlob_java_lang_String_byte____: - -.. _DynamicRealmObject_setBlob_java_lang_String__byte____: - -.. _DynamicRealmObject_setBlob_String_byte_: - -.. _DynamicRealmObject_setBlob_String__byte_: - -.. _DynamicRealmObject_setBlob_String_byte____: - -.. _DynamicRealmObject_setBlob_String__byte____: - -.. _io_realm_DynamicRealmObject_setBlob_String__byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBlob ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - - - * - Sets the binary value of the given field. - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a binary field. - - - - - - - - - - - - -.. _setBoolean: - -.. _setBoolean__: - -.. _DynamicRealmObject_setBoolean: - -.. _DynamicRealmObject_setBoolean__: - -.. _io_realm_DynamicRealmObject_setBoolean: - -.. _io_realm_DynamicRealmObject_setBoolean__: - - - -setBoolean ----------- - -.. _io_realm_DynamicRealmObject_setBoolean_java_lang_String_boolean_: - -.. _io_realm_DynamicRealmObject_setBoolean_java_lang_String__boolean_: - -.. _io_realm_DynamicRealmObject_setBoolean_String_boolean_: - -.. _io_realm_DynamicRealmObject_setBoolean_String__boolean_: - -.. _setBoolean_java_lang_String_boolean_: - -.. _setBoolean_java_lang_String__boolean_: - -.. _setBoolean_String_boolean_: - -.. _setBoolean_String__boolean_: - -.. _DynamicRealmObject_setBoolean_java_lang_String_boolean_: - -.. _DynamicRealmObject_setBoolean_java_lang_String__boolean_: - -.. _DynamicRealmObject_setBoolean_String_boolean_: - -.. _DynamicRealmObject_setBoolean_String__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBoolean ` ( - | `String `__ fieldName, - | **boolean** value - | ) - - - - - * - Sets the ``boolean`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name to update. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a boolean field. - - - - - - - - - - - - -.. _setByte: - -.. _setByte__: - -.. _DynamicRealmObject_setByte: - -.. _DynamicRealmObject_setByte__: - -.. _io_realm_DynamicRealmObject_setByte: - -.. _io_realm_DynamicRealmObject_setByte__: - - - -setByte -------- - -.. _io_realm_DynamicRealmObject_setByte_java_lang_String_byte_: - -.. _io_realm_DynamicRealmObject_setByte_java_lang_String__byte_: - -.. _io_realm_DynamicRealmObject_setByte_String_byte_: - -.. _io_realm_DynamicRealmObject_setByte_String__byte_: - -.. _setByte_java_lang_String_byte_: - -.. _setByte_java_lang_String__byte_: - -.. _setByte_String_byte_: - -.. _setByte_String__byte_: - -.. _DynamicRealmObject_setByte_java_lang_String_byte_: - -.. _DynamicRealmObject_setByte_java_lang_String__byte_: - -.. _DynamicRealmObject_setByte_String_byte_: - -.. _DynamicRealmObject_setByte_String__byte_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setByte ` ( - | `String `__ fieldName, - | **byte** value - | ) - - - - - * - Sets the ``byte`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setDate: - -.. _setDate__: - -.. _DynamicRealmObject_setDate: - -.. _DynamicRealmObject_setDate__: - -.. _io_realm_DynamicRealmObject_setDate: - -.. _io_realm_DynamicRealmObject_setDate__: - - - -setDate -------- - -.. _io_realm_DynamicRealmObject_setDate_java_lang_String_java_util_Date_: - -.. _io_realm_DynamicRealmObject_setDate_java_lang_String__java_util_Date_: - -.. _io_realm_DynamicRealmObject_setDate_java_lang_String_Date_: - -.. _io_realm_DynamicRealmObject_setDate_java_lang_String__Date_: - -.. _io_realm_DynamicRealmObject_setDate_String_java_util_Date_: - -.. _io_realm_DynamicRealmObject_setDate_String__java_util_Date_: - -.. _io_realm_DynamicRealmObject_setDate_String_Date_: - -.. _io_realm_DynamicRealmObject_setDate_String__Date_: - -.. _setDate_java_lang_String_java_util_Date_: - -.. _setDate_java_lang_String__java_util_Date_: - -.. _setDate_java_lang_String_Date_: - -.. _setDate_java_lang_String__Date_: - -.. _setDate_String_java_util_Date_: - -.. _setDate_String__java_util_Date_: - -.. _setDate_String_Date_: - -.. _setDate_String__Date_: - -.. _DynamicRealmObject_setDate_java_lang_String_java_util_Date_: - -.. _DynamicRealmObject_setDate_java_lang_String__java_util_Date_: - -.. _DynamicRealmObject_setDate_java_lang_String_Date_: - -.. _DynamicRealmObject_setDate_java_lang_String__Date_: - -.. _DynamicRealmObject_setDate_String_java_util_Date_: - -.. _DynamicRealmObject_setDate_String__java_util_Date_: - -.. _DynamicRealmObject_setDate_String_Date_: - -.. _DynamicRealmObject_setDate_String__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - - - * - Sets the ``Date`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Date field. - - - - - - - - - - - - -.. _setDecimal128: - -.. _setDecimal128__: - -.. _DynamicRealmObject_setDecimal128: - -.. _DynamicRealmObject_setDecimal128__: - -.. _io_realm_DynamicRealmObject_setDecimal128: - -.. _io_realm_DynamicRealmObject_setDecimal128__: - - - -setDecimal128 -------------- - -.. _io_realm_DynamicRealmObject_setDecimal128_java_lang_String_Decimal128_: - -.. _io_realm_DynamicRealmObject_setDecimal128_java_lang_String__Decimal128_: - -.. _io_realm_DynamicRealmObject_setDecimal128_String_Decimal128_: - -.. _io_realm_DynamicRealmObject_setDecimal128_String__Decimal128_: - -.. _setDecimal128_java_lang_String_Decimal128_: - -.. _setDecimal128_java_lang_String__Decimal128_: - -.. _setDecimal128_String_Decimal128_: - -.. _setDecimal128_String__Decimal128_: - -.. _DynamicRealmObject_setDecimal128_java_lang_String_Decimal128_: - -.. _DynamicRealmObject_setDecimal128_java_lang_String__Decimal128_: - -.. _DynamicRealmObject_setDecimal128_String_Decimal128_: - -.. _DynamicRealmObject_setDecimal128_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDecimal128 ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Sets the ``Decimal128`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a Decimal128 field. - - - - - - - - - - - - -.. _setDictionary: - -.. _setDictionary__: - -.. _DynamicRealmObject_setDictionary: - -.. _DynamicRealmObject_setDictionary__: - -.. _io_realm_DynamicRealmObject_setDictionary: - -.. _io_realm_DynamicRealmObject_setDictionary__: - - - -setDictionary -------------- - -.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String_io_realm_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String__io_realm_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_java_lang_String__RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_String_io_realm_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_String__io_realm_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_String_RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_String__RealmDictionary_: - -.. _setDictionary_java_lang_String_io_realm_RealmDictionary_: - -.. _setDictionary_java_lang_String__io_realm_RealmDictionary_: - -.. _setDictionary_java_lang_String_RealmDictionary_: - -.. _setDictionary_java_lang_String__RealmDictionary_: - -.. _setDictionary_String_io_realm_RealmDictionary_: - -.. _setDictionary_String__io_realm_RealmDictionary_: - -.. _setDictionary_String_RealmDictionary_: - -.. _setDictionary_String__RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_java_lang_String_io_realm_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_java_lang_String__io_realm_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_java_lang_String_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_java_lang_String__RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_String_io_realm_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_String__io_realm_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_String_RealmDictionary_: - -.. _DynamicRealmObject_setDictionary_String__RealmDictionary_: - -.. _io_realm_DynamicRealmObject_setDictionary_String__RealmDictionary_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDictionary ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmDictionary\ ` dictionary - | ) - - - - - * - Sets the reference to a :ref:`RealmDictionary ` on the given field. - - This will copy all the elements in the dictionary into Realm, but any further changes to the dictionary will not be reflected in the Realm. Use :ref:`getDictionary(String) ` in order to get a reference to the managed dictionary. - - - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``dictionary`` - dictionary of objects. Must either be primitive types or :ref:`DynamicRealmObject ` s. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, it is not a dictionary field, the objects in the dictionary doesn't match the expected type or any Realm object in the dictionary belongs to a different Realm. - - - - - - - - - - - - -.. _setDouble: - -.. _setDouble__: - -.. _DynamicRealmObject_setDouble: - -.. _DynamicRealmObject_setDouble__: - -.. _io_realm_DynamicRealmObject_setDouble: - -.. _io_realm_DynamicRealmObject_setDouble__: - - - -setDouble ---------- - -.. _io_realm_DynamicRealmObject_setDouble_java_lang_String_double_: - -.. _io_realm_DynamicRealmObject_setDouble_java_lang_String__double_: - -.. _io_realm_DynamicRealmObject_setDouble_String_double_: - -.. _io_realm_DynamicRealmObject_setDouble_String__double_: - -.. _setDouble_java_lang_String_double_: - -.. _setDouble_java_lang_String__double_: - -.. _setDouble_String_double_: - -.. _setDouble_String__double_: - -.. _DynamicRealmObject_setDouble_java_lang_String_double_: - -.. _DynamicRealmObject_setDouble_java_lang_String__double_: - -.. _DynamicRealmObject_setDouble_String_double_: - -.. _DynamicRealmObject_setDouble_String__double_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDouble ` ( - | `String `__ fieldName, - | **double** value - | ) - - - - - * - Sets the ``double`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a double field. - - - - - - - - - - - - -.. _setFloat: - -.. _setFloat__: - -.. _DynamicRealmObject_setFloat: - -.. _DynamicRealmObject_setFloat__: - -.. _io_realm_DynamicRealmObject_setFloat: - -.. _io_realm_DynamicRealmObject_setFloat__: - - - -setFloat --------- - -.. _io_realm_DynamicRealmObject_setFloat_java_lang_String_float_: - -.. _io_realm_DynamicRealmObject_setFloat_java_lang_String__float_: - -.. _io_realm_DynamicRealmObject_setFloat_String_float_: - -.. _io_realm_DynamicRealmObject_setFloat_String__float_: - -.. _setFloat_java_lang_String_float_: - -.. _setFloat_java_lang_String__float_: - -.. _setFloat_String_float_: - -.. _setFloat_String__float_: - -.. _DynamicRealmObject_setFloat_java_lang_String_float_: - -.. _DynamicRealmObject_setFloat_java_lang_String__float_: - -.. _DynamicRealmObject_setFloat_String_float_: - -.. _DynamicRealmObject_setFloat_String__float_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setFloat ` ( - | `String `__ fieldName, - | **float** value - | ) - - - - - * - Sets the ``float`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a float field. - - - - - - - - - - - - -.. _setInt: - -.. _setInt__: - -.. _DynamicRealmObject_setInt: - -.. _DynamicRealmObject_setInt__: - -.. _io_realm_DynamicRealmObject_setInt: - -.. _io_realm_DynamicRealmObject_setInt__: - - - -setInt ------- - -.. _io_realm_DynamicRealmObject_setInt_java_lang_String_int_: - -.. _io_realm_DynamicRealmObject_setInt_java_lang_String__int_: - -.. _io_realm_DynamicRealmObject_setInt_String_int_: - -.. _io_realm_DynamicRealmObject_setInt_String__int_: - -.. _setInt_java_lang_String_int_: - -.. _setInt_java_lang_String__int_: - -.. _setInt_String_int_: - -.. _setInt_String__int_: - -.. _DynamicRealmObject_setInt_java_lang_String_int_: - -.. _DynamicRealmObject_setInt_java_lang_String__int_: - -.. _DynamicRealmObject_setInt_String_int_: - -.. _DynamicRealmObject_setInt_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setInt ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Sets the ``int`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name to update. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setList: - -.. _setList__: - -.. _DynamicRealmObject_setList: - -.. _DynamicRealmObject_setList__: - -.. _io_realm_DynamicRealmObject_setList: - -.. _io_realm_DynamicRealmObject_setList__: - - - -setList -------- - -.. _io_realm_DynamicRealmObject_setList_java_lang_String_io_realm_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_java_lang_String__io_realm_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_java_lang_String_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_java_lang_String__RealmList_: - -.. _io_realm_DynamicRealmObject_setList_String_io_realm_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_String__io_realm_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_String_RealmList_: - -.. _io_realm_DynamicRealmObject_setList_String__RealmList_: - -.. _setList_java_lang_String_io_realm_RealmList_: - -.. _setList_java_lang_String__io_realm_RealmList_: - -.. _setList_java_lang_String_RealmList_: - -.. _setList_java_lang_String__RealmList_: - -.. _setList_String_io_realm_RealmList_: - -.. _setList_String__io_realm_RealmList_: - -.. _setList_String_RealmList_: - -.. _setList_String__RealmList_: - -.. _DynamicRealmObject_setList_java_lang_String_io_realm_RealmList_: - -.. _DynamicRealmObject_setList_java_lang_String__io_realm_RealmList_: - -.. _DynamicRealmObject_setList_java_lang_String_RealmList_: - -.. _DynamicRealmObject_setList_java_lang_String__RealmList_: - -.. _DynamicRealmObject_setList_String_io_realm_RealmList_: - -.. _DynamicRealmObject_setList_String__io_realm_RealmList_: - -.. _DynamicRealmObject_setList_String_RealmList_: - -.. _DynamicRealmObject_setList_String__RealmList_: - -.. _io_realm_DynamicRealmObject_setList_String__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setList ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Sets the reference to a :ref:`RealmList ` on the given field. - - This will copy all the elements in the list into Realm, but any further changes to the list will not be reflected in the Realm. Use :ref:`getList(String) ` in order to get a reference to the managed list. - - - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``list`` - list of objects. Must either be primitive types or :ref:`DynamicRealmObject ` s. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, it is not a list field, the objects in the list doesn't match the expected type or any Realm object in the list belongs to a different Realm. - - - - - - - - - - - - -.. _setLong: - -.. _setLong__: - -.. _DynamicRealmObject_setLong: - -.. _DynamicRealmObject_setLong__: - -.. _io_realm_DynamicRealmObject_setLong: - -.. _io_realm_DynamicRealmObject_setLong__: - - - -setLong -------- - -.. _io_realm_DynamicRealmObject_setLong_java_lang_String_long_: - -.. _io_realm_DynamicRealmObject_setLong_java_lang_String__long_: - -.. _io_realm_DynamicRealmObject_setLong_String_long_: - -.. _io_realm_DynamicRealmObject_setLong_String__long_: - -.. _setLong_java_lang_String_long_: - -.. _setLong_java_lang_String__long_: - -.. _setLong_String_long_: - -.. _setLong_String__long_: - -.. _DynamicRealmObject_setLong_java_lang_String_long_: - -.. _DynamicRealmObject_setLong_java_lang_String__long_: - -.. _DynamicRealmObject_setLong_String_long_: - -.. _DynamicRealmObject_setLong_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setLong ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Sets the ``long`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setNull: - -.. _setNull__: - -.. _DynamicRealmObject_setNull: - -.. _DynamicRealmObject_setNull__: - -.. _io_realm_DynamicRealmObject_setNull: - -.. _io_realm_DynamicRealmObject_setNull__: - - - -setNull -------- - -.. _io_realm_DynamicRealmObject_setNull_java_lang_String_: - -.. _io_realm_DynamicRealmObject_setNull_String_: - -.. _setNull_java_lang_String_: - -.. _setNull_String_: - -.. _DynamicRealmObject_setNull_java_lang_String_: - -.. _DynamicRealmObject_setNull_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setNull ` ( - | `String `__ fieldName - | ) - - - - - * - Sets the value to ``null`` for the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, or the field isn't nullable. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setObject: - -.. _setObject__: - -.. _DynamicRealmObject_setObject: - -.. _DynamicRealmObject_setObject__: - -.. _io_realm_DynamicRealmObject_setObject: - -.. _io_realm_DynamicRealmObject_setObject__: - - - -setObject ---------- - -.. _io_realm_DynamicRealmObject_setObject_java_lang_String_io_realm_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_java_lang_String__io_realm_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_java_lang_String_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_java_lang_String__DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_String_io_realm_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_String__io_realm_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_String_DynamicRealmObject_: - -.. _io_realm_DynamicRealmObject_setObject_String__DynamicRealmObject_: - -.. _setObject_java_lang_String_io_realm_DynamicRealmObject_: - -.. _setObject_java_lang_String__io_realm_DynamicRealmObject_: - -.. _setObject_java_lang_String_DynamicRealmObject_: - -.. _setObject_java_lang_String__DynamicRealmObject_: - -.. _setObject_String_io_realm_DynamicRealmObject_: - -.. _setObject_String__io_realm_DynamicRealmObject_: - -.. _setObject_String_DynamicRealmObject_: - -.. _setObject_String__DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_java_lang_String_io_realm_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_java_lang_String__io_realm_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_java_lang_String_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_java_lang_String__DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_String_io_realm_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_String__io_realm_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_String_DynamicRealmObject_: - -.. _DynamicRealmObject_setObject_String__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setObject ` ( - | `String `__ fieldName, - | :ref:`DynamicRealmObject ` value - | ) - - - - - * - Sets a reference to another object on the given field. - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - object to link to. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, it doesn't link to other Realm objects, the type of DynamicRealmObject doesn't match or it belongs to a different Realm. - - - - - - - - - - - - -.. _setObjectId: - -.. _setObjectId__: - -.. _DynamicRealmObject_setObjectId: - -.. _DynamicRealmObject_setObjectId__: - -.. _io_realm_DynamicRealmObject_setObjectId: - -.. _io_realm_DynamicRealmObject_setObjectId__: - - - -setObjectId ------------ - -.. _io_realm_DynamicRealmObject_setObjectId_java_lang_String_ObjectId_: - -.. _io_realm_DynamicRealmObject_setObjectId_java_lang_String__ObjectId_: - -.. _io_realm_DynamicRealmObject_setObjectId_String_ObjectId_: - -.. _io_realm_DynamicRealmObject_setObjectId_String__ObjectId_: - -.. _setObjectId_java_lang_String_ObjectId_: - -.. _setObjectId_java_lang_String__ObjectId_: - -.. _setObjectId_String_ObjectId_: - -.. _setObjectId_String__ObjectId_: - -.. _DynamicRealmObject_setObjectId_java_lang_String_ObjectId_: - -.. _DynamicRealmObject_setObjectId_java_lang_String__ObjectId_: - -.. _DynamicRealmObject_setObjectId_String_ObjectId_: - -.. _DynamicRealmObject_setObjectId_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setObjectId ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Sets the ``ObjectId`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a ObjectId field. - - - - - - - - - - - - -.. _setRealmAny: - -.. _setRealmAny__: - -.. _DynamicRealmObject_setRealmAny: - -.. _DynamicRealmObject_setRealmAny__: - -.. _io_realm_DynamicRealmObject_setRealmAny: - -.. _io_realm_DynamicRealmObject_setRealmAny__: - - - -setRealmAny ------------ - -.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_java_lang_String__RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_String_io_realm_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_String__io_realm_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_String_RealmAny_: - -.. _io_realm_DynamicRealmObject_setRealmAny_String__RealmAny_: - -.. _setRealmAny_java_lang_String_io_realm_RealmAny_: - -.. _setRealmAny_java_lang_String__io_realm_RealmAny_: - -.. _setRealmAny_java_lang_String_RealmAny_: - -.. _setRealmAny_java_lang_String__RealmAny_: - -.. _setRealmAny_String_io_realm_RealmAny_: - -.. _setRealmAny_String__io_realm_RealmAny_: - -.. _setRealmAny_String_RealmAny_: - -.. _setRealmAny_String__RealmAny_: - -.. _DynamicRealmObject_setRealmAny_java_lang_String_io_realm_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_java_lang_String__io_realm_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_java_lang_String_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_java_lang_String__RealmAny_: - -.. _DynamicRealmObject_setRealmAny_String_io_realm_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_String__io_realm_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_String_RealmAny_: - -.. _DynamicRealmObject_setRealmAny_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setRealmAny ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Sets the ``RealmAny`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a RealmAny field. - - - - - - - - - - - - -.. _setRealmSet: - -.. _setRealmSet__: - -.. _DynamicRealmObject_setRealmSet: - -.. _DynamicRealmObject_setRealmSet__: - -.. _io_realm_DynamicRealmObject_setRealmSet: - -.. _io_realm_DynamicRealmObject_setRealmSet__: - - - -setRealmSet ------------ - -.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String_io_realm_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String__io_realm_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_java_lang_String__RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_String_io_realm_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_String__io_realm_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_String_RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_String__RealmSet_: - -.. _setRealmSet_java_lang_String_io_realm_RealmSet_: - -.. _setRealmSet_java_lang_String__io_realm_RealmSet_: - -.. _setRealmSet_java_lang_String_RealmSet_: - -.. _setRealmSet_java_lang_String__RealmSet_: - -.. _setRealmSet_String_io_realm_RealmSet_: - -.. _setRealmSet_String__io_realm_RealmSet_: - -.. _setRealmSet_String_RealmSet_: - -.. _setRealmSet_String__RealmSet_: - -.. _DynamicRealmObject_setRealmSet_java_lang_String_io_realm_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_java_lang_String__io_realm_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_java_lang_String_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_java_lang_String__RealmSet_: - -.. _DynamicRealmObject_setRealmSet_String_io_realm_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_String__io_realm_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_String_RealmSet_: - -.. _DynamicRealmObject_setRealmSet_String__RealmSet_: - -.. _io_realm_DynamicRealmObject_setRealmSet_String__RealmSet_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setRealmSet ` <**E** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmSet\ ` set - | ) - - - - - * - Sets the reference to a :ref:`RealmSet ` on the given field. - - This will copy all the elements in the set into Realm, but any further changes to the set will not be reflected in the Realm. Use :ref:`getRealmSet(String) ` in order to get a reference to the managed set. - - - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``set`` - set of objects. Must either be primitive types or :ref:`DynamicRealmObject ` s. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, it is not a set field, the objects in the set doesn't match the expected type or any Realm object in the set belongs to a different Realm. - - - - - - - - - - - - -.. _setShort: - -.. _setShort__: - -.. _DynamicRealmObject_setShort: - -.. _DynamicRealmObject_setShort__: - -.. _io_realm_DynamicRealmObject_setShort: - -.. _io_realm_DynamicRealmObject_setShort__: - - - -setShort --------- - -.. _io_realm_DynamicRealmObject_setShort_java_lang_String_short_: - -.. _io_realm_DynamicRealmObject_setShort_java_lang_String__short_: - -.. _io_realm_DynamicRealmObject_setShort_String_short_: - -.. _io_realm_DynamicRealmObject_setShort_String__short_: - -.. _setShort_java_lang_String_short_: - -.. _setShort_java_lang_String__short_: - -.. _setShort_String_short_: - -.. _setShort_String__short_: - -.. _DynamicRealmObject_setShort_java_lang_String_short_: - -.. _DynamicRealmObject_setShort_java_lang_String__short_: - -.. _DynamicRealmObject_setShort_String_short_: - -.. _DynamicRealmObject_setShort_String__short_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setShort ` ( - | `String `__ fieldName, - | **short** value - | ) - - - - - * - Sets the ``short`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't an integer field. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setString: - -.. _setString__: - -.. _DynamicRealmObject_setString: - -.. _DynamicRealmObject_setString__: - -.. _io_realm_DynamicRealmObject_setString: - -.. _io_realm_DynamicRealmObject_setString__: - - - -setString ---------- - -.. _io_realm_DynamicRealmObject_setString_java_lang_String_java_lang_String_: - -.. _io_realm_DynamicRealmObject_setString_java_lang_String__java_lang_String_: - -.. _io_realm_DynamicRealmObject_setString_java_lang_String_String_: - -.. _io_realm_DynamicRealmObject_setString_java_lang_String__String_: - -.. _io_realm_DynamicRealmObject_setString_String_java_lang_String_: - -.. _io_realm_DynamicRealmObject_setString_String__java_lang_String_: - -.. _io_realm_DynamicRealmObject_setString_String_String_: - -.. _io_realm_DynamicRealmObject_setString_String__String_: - -.. _setString_java_lang_String_java_lang_String_: - -.. _setString_java_lang_String__java_lang_String_: - -.. _setString_java_lang_String_String_: - -.. _setString_java_lang_String__String_: - -.. _setString_String_java_lang_String_: - -.. _setString_String__java_lang_String_: - -.. _setString_String_String_: - -.. _setString_String__String_: - -.. _DynamicRealmObject_setString_java_lang_String_java_lang_String_: - -.. _DynamicRealmObject_setString_java_lang_String__java_lang_String_: - -.. _DynamicRealmObject_setString_java_lang_String_String_: - -.. _DynamicRealmObject_setString_java_lang_String__String_: - -.. _DynamicRealmObject_setString_String_java_lang_String_: - -.. _DynamicRealmObject_setString_String__java_lang_String_: - -.. _DynamicRealmObject_setString_String_String_: - -.. _DynamicRealmObject_setString_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Sets the ``String`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a String field. - - - - - :ref:`RealmException ` - if the field is a :ref:`io.realm.annotations.PrimaryKey ` field. - - - - - - - - - - - - - - -.. _setUUID: - -.. _setUUID__: - -.. _DynamicRealmObject_setUUID: - -.. _DynamicRealmObject_setUUID__: - -.. _io_realm_DynamicRealmObject_setUUID: - -.. _io_realm_DynamicRealmObject_setUUID__: - - - -setUUID -------- - -.. _io_realm_DynamicRealmObject_setUUID_java_lang_String_java_util_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_java_lang_String__java_util_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_java_lang_String_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_java_lang_String__UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_String_java_util_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_String__java_util_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_String_UUID_: - -.. _io_realm_DynamicRealmObject_setUUID_String__UUID_: - -.. _setUUID_java_lang_String_java_util_UUID_: - -.. _setUUID_java_lang_String__java_util_UUID_: - -.. _setUUID_java_lang_String_UUID_: - -.. _setUUID_java_lang_String__UUID_: - -.. _setUUID_String_java_util_UUID_: - -.. _setUUID_String__java_util_UUID_: - -.. _setUUID_String_UUID_: - -.. _setUUID_String__UUID_: - -.. _DynamicRealmObject_setUUID_java_lang_String_java_util_UUID_: - -.. _DynamicRealmObject_setUUID_java_lang_String__java_util_UUID_: - -.. _DynamicRealmObject_setUUID_java_lang_String_UUID_: - -.. _DynamicRealmObject_setUUID_java_lang_String__UUID_: - -.. _DynamicRealmObject_setUUID_String_java_util_UUID_: - -.. _DynamicRealmObject_setUUID_String__java_util_UUID_: - -.. _DynamicRealmObject_setUUID_String_UUID_: - -.. _DynamicRealmObject_setUUID_String__UUID_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setUUID ` ( - | `String `__ fieldName, - | `UUID `__ value - | ) - - - - - * - Sets the ``UUID`` value of the given field. - - - - - - - **Parameters** - - - ``fieldName`` - field name. - - - - - ``value`` - value to insert. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or field isn't a UUID field. - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _DynamicRealmObject_toString: - -.. _DynamicRealmObject_toString__: - -.. _io_realm_DynamicRealmObject_toString: - -.. _io_realm_DynamicRealmObject_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/FieldAttribute.txt b/source/sdk/java/api/io/realm/FieldAttribute.txt deleted file mode 100644 index cef961192c..0000000000 --- a/source/sdk/java/api/io/realm/FieldAttribute.txt +++ /dev/null @@ -1,264 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum FieldAttribute -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_FieldAttribute: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.FieldAttribute - - -This class contains all Realm attributes for a Realm field. These will usually match the annotations found in the ``io.realm.annotation`` package. See the relevant annotation for further information on each modifier. - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`INDEXED ` - - Marks a field as indexed. - - - - - * - :ref:`PRIMARY_KEY ` - - Marks a field as a primary key. - - - - - * - :ref:`REQUIRED ` - - Marks a field as explicitly not allowing null values. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`FieldAttribute ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`FieldAttribute ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_FieldAttribute_INDEXED: - -.. _FieldAttribute_INDEXED: - - - -``INDEXED`` ------------- - -public static final :ref:`FieldAttribute ` - -Marks a field as indexed. - - - -.. _io_realm_FieldAttribute_PRIMARY_KEY: - -.. _FieldAttribute_PRIMARY_KEY: - - - -``PRIMARY_KEY`` ----------------- - -public static final :ref:`FieldAttribute ` - -Marks a field as a primary key. This also implicitly mark it as :ref:`INDEXED ` . - - - - - -.. _io_realm_FieldAttribute_REQUIRED: - -.. _FieldAttribute_REQUIRED: - - - -``REQUIRED`` -------------- - -public static final :ref:`FieldAttribute ` - -Marks a field as explicitly not allowing null values. The default behavior for allowing ``null`` depends on the type of the field. - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _FieldAttribute_valueOf: - -.. _FieldAttribute_valueOf__: - -.. _io_realm_FieldAttribute_valueOf: - -.. _io_realm_FieldAttribute_valueOf__: - - - -valueOf -------- - -.. _io_realm_FieldAttribute_valueOf_java_lang_String_: - -.. _io_realm_FieldAttribute_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _FieldAttribute_valueOf_java_lang_String_: - -.. _FieldAttribute_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`FieldAttribute ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _FieldAttribute_values: - -.. _FieldAttribute_values__: - -.. _io_realm_FieldAttribute_values: - -.. _io_realm_FieldAttribute_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`FieldAttribute ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/FrozenPendingRow.txt b/source/sdk/java/api/io/realm/FrozenPendingRow.txt deleted file mode 100644 index cd76276785..0000000000 --- a/source/sdk/java/api/io/realm/FrozenPendingRow.txt +++ /dev/null @@ -1,3278 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum FrozenPendingRow -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_FrozenPendingRow: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.FrozenPendingRow - - -A PendingRow that has been frozen. This behaves in many ways similar to a deleted Row, but will report :ref:`isLoaded() ` as ``as false`` . - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`INSTANCE ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`checkIfAttached ` () - | - - - - - - - - * - public **long** - - | :ref:`createEmbeddedObject ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` parentPropertyType - | ) - - - - - - - - * - public **Row** - - | :ref:`freeze ` ( - | **OsSharedRealm** frozenRealm - | ) - - - - - - - - * - public **byte** - - | :ref:`getBinaryByteArray ` ( - | **long** columnKey - | ) - - - - - - - - * - public **boolean** - - | :ref:`getBoolean ` ( - | **long** columnKey - | ) - - - - - - - - * - public **long** - - | :ref:`getColumnCount ` () - | - - - - - - - - * - public **long** - - | :ref:`getColumnKey ` ( - | `String `__ columnName - | ) - - - - - - - - * - public `String `__ - - | :ref:`getColumnNames ` () - | - - - - - - - - * - public :ref:`RealmFieldType ` - - | :ref:`getColumnType ` ( - | **long** columnKey - | ) - - - - - - - - * - public `Date `__ - - | :ref:`getDate ` ( - | **long** columnKey - | ) - - - - - - - - * - public **Decimal128** - - | :ref:`getDecimal128 ` ( - | **long** columnKey - | ) - - - - - - - - * - public **double** - - | :ref:`getDouble ` ( - | **long** columnKey - | ) - - - - - - - - * - public **float** - - | :ref:`getFloat ` ( - | **long** columnKey - | ) - - - - - - - - * - public **long** - - | :ref:`getLink ` ( - | **long** columnKey - | ) - - - - - - - - * - public **long** - - | :ref:`getLong ` ( - | **long** columnKey - | ) - - - - - - - - * - public **OsList** - - | :ref:`getModelList ` ( - | **long** columnKey - | ) - - - - - - - - * - public **OsMap** - - | :ref:`getModelMap ` ( - | **long** columnKey - | ) - - - - - - - - * - public **OsSet** - - | :ref:`getModelSet ` ( - | **long** columnKey - | ) - - - - - - - - * - public **NativeRealmAny** - - | :ref:`getNativeRealmAny ` ( - | **long** columnKey - | ) - - - - - - - - * - public **ObjectId** - - | :ref:`getObjectId ` ( - | **long** columnKey - | ) - - - - - - - - * - public **long** - - | :ref:`getObjectKey ` () - | - - - - - - - - * - public **OsMap** - - | :ref:`getRealmAnyMap ` ( - | **long** columnKey - | ) - - - - - - - - * - public **OsSet** - - | :ref:`getRealmAnySet ` ( - | **long** columnKey - | ) - - - - - - - - * - public `String `__ - - | :ref:`getString ` ( - | **long** columnKey - | ) - - - - - - - - * - public **Table** - - | :ref:`getTable ` () - | - - - - - - - - * - public `UUID `__ - - | :ref:`getUUID ` ( - | **long** columnKey - | ) - - - - - - - - * - public **OsList** - - | :ref:`getValueList ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - - - - * - public **OsMap** - - | :ref:`getValueMap ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - - - - * - public **OsSet** - - | :ref:`getValueSet ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - - - - * - public **boolean** - - | :ref:`hasColumn ` ( - | `String `__ fieldName - | ) - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isNull ` ( - | **long** columnKey - | ) - - - - - - - - * - public **boolean** - - | :ref:`isNullLink ` ( - | **long** columnKey - | ) - - - - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - - - - - - * - public **void** - - | :ref:`nullifyLink ` ( - | **long** columnKey - | ) - - - - - - - - * - public **void** - - | :ref:`setBinaryByteArray ` ( - | **long** columnKey, - | **byte[]** data - | ) - - - - - - - - * - public **void** - - | :ref:`setBoolean ` ( - | **long** columnKey, - | **boolean** value - | ) - - - - - - - - * - public **void** - - | :ref:`setDate ` ( - | **long** columnKey, - | `Date `__ date - | ) - - - - - - - - * - public **void** - - | :ref:`setDecimal128 ` ( - | **long** columnKey, - | **Decimal128** value - | ) - - - - - - - - * - public **void** - - | :ref:`setDouble ` ( - | **long** columnKey, - | **double** value - | ) - - - - - - - - * - public **void** - - | :ref:`setFloat ` ( - | **long** columnKey, - | **float** value - | ) - - - - - - - - * - public **void** - - | :ref:`setLink ` ( - | **long** columnKey, - | **long** value - | ) - - - - - - - - * - public **void** - - | :ref:`setLong ` ( - | **long** columnKey, - | **long** value - | ) - - - - - - - - * - public **void** - - | :ref:`setNull ` ( - | **long** columnKey - | ) - - - - - - - - * - public **void** - - | :ref:`setObjectId ` ( - | **long** columnKey, - | **ObjectId** value - | ) - - - - - - - - * - public **void** - - | :ref:`setRealmAny ` ( - | **long** columnKey, - | **long** value - | ) - - - - - - - - * - public **void** - - | :ref:`setString ` ( - | **long** columnKey, - | `String `__ value - | ) - - - - - - - - * - public **void** - - | :ref:`setUUID ` ( - | **long** columnKey, - | `UUID `__ value - | ) - - - - - - - - * - public static :ref:`FrozenPendingRow ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`FrozenPendingRow ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_FrozenPendingRow_INSTANCE: - -.. _FrozenPendingRow_INSTANCE: - - - -``INSTANCE`` -------------- - -public static final :ref:`FrozenPendingRow ` - - - - - - -Method Detail -============= - -.. _checkIfAttached: - -.. _checkIfAttached__: - -.. _FrozenPendingRow_checkIfAttached: - -.. _FrozenPendingRow_checkIfAttached__: - -.. _io_realm_FrozenPendingRow_checkIfAttached: - -.. _io_realm_FrozenPendingRow_checkIfAttached__: - - - -checkIfAttached ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`checkIfAttached ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _createEmbeddedObject: - -.. _createEmbeddedObject__: - -.. _FrozenPendingRow_createEmbeddedObject: - -.. _FrozenPendingRow_createEmbeddedObject__: - -.. _io_realm_FrozenPendingRow_createEmbeddedObject: - -.. _io_realm_FrozenPendingRow_createEmbeddedObject__: - - - -createEmbeddedObject --------------------- - -.. _io_realm_FrozenPendingRow_createEmbeddedObject_long_io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_createEmbeddedObject_long__io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_createEmbeddedObject_long_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_createEmbeddedObject_long__RealmFieldType_: - -.. _createEmbeddedObject_long_io_realm_RealmFieldType_: - -.. _createEmbeddedObject_long__io_realm_RealmFieldType_: - -.. _createEmbeddedObject_long_RealmFieldType_: - -.. _createEmbeddedObject_long__RealmFieldType_: - -.. _FrozenPendingRow_createEmbeddedObject_long_io_realm_RealmFieldType_: - -.. _FrozenPendingRow_createEmbeddedObject_long__io_realm_RealmFieldType_: - -.. _FrozenPendingRow_createEmbeddedObject_long_RealmFieldType_: - -.. _FrozenPendingRow_createEmbeddedObject_long__RealmFieldType_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`createEmbeddedObject ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` parentPropertyType - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _FrozenPendingRow_freeze: - -.. _FrozenPendingRow_freeze__: - -.. _io_realm_FrozenPendingRow_freeze: - -.. _io_realm_FrozenPendingRow_freeze__: - - - -freeze ------- - -.. _io_realm_FrozenPendingRow_freeze_OsSharedRealm_: - -.. _freeze_OsSharedRealm_: - -.. _FrozenPendingRow_freeze_OsSharedRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **Row** :ref:`freeze ` ( - | **OsSharedRealm** frozenRealm - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getBinaryByteArray: - -.. _getBinaryByteArray__: - -.. _FrozenPendingRow_getBinaryByteArray: - -.. _FrozenPendingRow_getBinaryByteArray__: - -.. _io_realm_FrozenPendingRow_getBinaryByteArray: - -.. _io_realm_FrozenPendingRow_getBinaryByteArray__: - - - -getBinaryByteArray ------------------- - -.. _io_realm_FrozenPendingRow_getBinaryByteArray_long_: - -.. _getBinaryByteArray_long_: - -.. _FrozenPendingRow_getBinaryByteArray_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`getBinaryByteArray ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getBoolean: - -.. _getBoolean__: - -.. _FrozenPendingRow_getBoolean: - -.. _FrozenPendingRow_getBoolean__: - -.. _io_realm_FrozenPendingRow_getBoolean: - -.. _io_realm_FrozenPendingRow_getBoolean__: - - - -getBoolean ----------- - -.. _io_realm_FrozenPendingRow_getBoolean_long_: - -.. _getBoolean_long_: - -.. _FrozenPendingRow_getBoolean_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`getBoolean ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getColumnCount: - -.. _getColumnCount__: - -.. _FrozenPendingRow_getColumnCount: - -.. _FrozenPendingRow_getColumnCount__: - -.. _io_realm_FrozenPendingRow_getColumnCount: - -.. _io_realm_FrozenPendingRow_getColumnCount__: - - - -getColumnCount --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getColumnCount ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getColumnKey: - -.. _getColumnKey__: - -.. _FrozenPendingRow_getColumnKey: - -.. _FrozenPendingRow_getColumnKey__: - -.. _io_realm_FrozenPendingRow_getColumnKey: - -.. _io_realm_FrozenPendingRow_getColumnKey__: - - - -getColumnKey ------------- - -.. _io_realm_FrozenPendingRow_getColumnKey_java_lang_String_: - -.. _io_realm_FrozenPendingRow_getColumnKey_String_: - -.. _getColumnKey_java_lang_String_: - -.. _getColumnKey_String_: - -.. _FrozenPendingRow_getColumnKey_java_lang_String_: - -.. _FrozenPendingRow_getColumnKey_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getColumnKey ` ( - | `String `__ columnName - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getColumnNames: - -.. _getColumnNames__: - -.. _FrozenPendingRow_getColumnNames: - -.. _FrozenPendingRow_getColumnNames__: - -.. _io_realm_FrozenPendingRow_getColumnNames: - -.. _io_realm_FrozenPendingRow_getColumnNames__: - - - -getColumnNames --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getColumnNames ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getColumnType: - -.. _getColumnType__: - -.. _FrozenPendingRow_getColumnType: - -.. _FrozenPendingRow_getColumnType__: - -.. _io_realm_FrozenPendingRow_getColumnType: - -.. _io_realm_FrozenPendingRow_getColumnType__: - - - -getColumnType -------------- - -.. _io_realm_FrozenPendingRow_getColumnType_long_: - -.. _getColumnType_long_: - -.. _FrozenPendingRow_getColumnType_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFieldType ` :ref:`getColumnType ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getDate: - -.. _getDate__: - -.. _FrozenPendingRow_getDate: - -.. _FrozenPendingRow_getDate__: - -.. _io_realm_FrozenPendingRow_getDate: - -.. _io_realm_FrozenPendingRow_getDate__: - - - -getDate -------- - -.. _io_realm_FrozenPendingRow_getDate_long_: - -.. _getDate_long_: - -.. _FrozenPendingRow_getDate_long_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`getDate ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getDecimal128: - -.. _getDecimal128__: - -.. _FrozenPendingRow_getDecimal128: - -.. _FrozenPendingRow_getDecimal128__: - -.. _io_realm_FrozenPendingRow_getDecimal128: - -.. _io_realm_FrozenPendingRow_getDecimal128__: - - - -getDecimal128 -------------- - -.. _io_realm_FrozenPendingRow_getDecimal128_long_: - -.. _getDecimal128_long_: - -.. _FrozenPendingRow_getDecimal128_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **Decimal128** :ref:`getDecimal128 ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getDouble: - -.. _getDouble__: - -.. _FrozenPendingRow_getDouble: - -.. _FrozenPendingRow_getDouble__: - -.. _io_realm_FrozenPendingRow_getDouble: - -.. _io_realm_FrozenPendingRow_getDouble__: - - - -getDouble ---------- - -.. _io_realm_FrozenPendingRow_getDouble_long_: - -.. _getDouble_long_: - -.. _FrozenPendingRow_getDouble_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`getDouble ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getFloat: - -.. _getFloat__: - -.. _FrozenPendingRow_getFloat: - -.. _FrozenPendingRow_getFloat__: - -.. _io_realm_FrozenPendingRow_getFloat: - -.. _io_realm_FrozenPendingRow_getFloat__: - - - -getFloat --------- - -.. _io_realm_FrozenPendingRow_getFloat_long_: - -.. _getFloat_long_: - -.. _FrozenPendingRow_getFloat_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **float** :ref:`getFloat ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getLink: - -.. _getLink__: - -.. _FrozenPendingRow_getLink: - -.. _FrozenPendingRow_getLink__: - -.. _io_realm_FrozenPendingRow_getLink: - -.. _io_realm_FrozenPendingRow_getLink__: - - - -getLink -------- - -.. _io_realm_FrozenPendingRow_getLink_long_: - -.. _getLink_long_: - -.. _FrozenPendingRow_getLink_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getLink ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getLong: - -.. _getLong__: - -.. _FrozenPendingRow_getLong: - -.. _FrozenPendingRow_getLong__: - -.. _io_realm_FrozenPendingRow_getLong: - -.. _io_realm_FrozenPendingRow_getLong__: - - - -getLong -------- - -.. _io_realm_FrozenPendingRow_getLong_long_: - -.. _getLong_long_: - -.. _FrozenPendingRow_getLong_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getLong ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getModelList: - -.. _getModelList__: - -.. _FrozenPendingRow_getModelList: - -.. _FrozenPendingRow_getModelList__: - -.. _io_realm_FrozenPendingRow_getModelList: - -.. _io_realm_FrozenPendingRow_getModelList__: - - - -getModelList ------------- - -.. _io_realm_FrozenPendingRow_getModelList_long_: - -.. _getModelList_long_: - -.. _FrozenPendingRow_getModelList_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsList** :ref:`getModelList ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getModelMap: - -.. _getModelMap__: - -.. _FrozenPendingRow_getModelMap: - -.. _FrozenPendingRow_getModelMap__: - -.. _io_realm_FrozenPendingRow_getModelMap: - -.. _io_realm_FrozenPendingRow_getModelMap__: - - - -getModelMap ------------ - -.. _io_realm_FrozenPendingRow_getModelMap_long_: - -.. _getModelMap_long_: - -.. _FrozenPendingRow_getModelMap_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsMap** :ref:`getModelMap ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getModelSet: - -.. _getModelSet__: - -.. _FrozenPendingRow_getModelSet: - -.. _FrozenPendingRow_getModelSet__: - -.. _io_realm_FrozenPendingRow_getModelSet: - -.. _io_realm_FrozenPendingRow_getModelSet__: - - - -getModelSet ------------ - -.. _io_realm_FrozenPendingRow_getModelSet_long_: - -.. _getModelSet_long_: - -.. _FrozenPendingRow_getModelSet_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsSet** :ref:`getModelSet ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getNativeRealmAny: - -.. _getNativeRealmAny__: - -.. _FrozenPendingRow_getNativeRealmAny: - -.. _FrozenPendingRow_getNativeRealmAny__: - -.. _io_realm_FrozenPendingRow_getNativeRealmAny: - -.. _io_realm_FrozenPendingRow_getNativeRealmAny__: - - - -getNativeRealmAny ------------------ - -.. _io_realm_FrozenPendingRow_getNativeRealmAny_long_: - -.. _getNativeRealmAny_long_: - -.. _FrozenPendingRow_getNativeRealmAny_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **NativeRealmAny** :ref:`getNativeRealmAny ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getObjectId: - -.. _getObjectId__: - -.. _FrozenPendingRow_getObjectId: - -.. _FrozenPendingRow_getObjectId__: - -.. _io_realm_FrozenPendingRow_getObjectId: - -.. _io_realm_FrozenPendingRow_getObjectId__: - - - -getObjectId ------------ - -.. _io_realm_FrozenPendingRow_getObjectId_long_: - -.. _getObjectId_long_: - -.. _FrozenPendingRow_getObjectId_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **ObjectId** :ref:`getObjectId ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getObjectKey: - -.. _getObjectKey__: - -.. _FrozenPendingRow_getObjectKey: - -.. _FrozenPendingRow_getObjectKey__: - -.. _io_realm_FrozenPendingRow_getObjectKey: - -.. _io_realm_FrozenPendingRow_getObjectKey__: - - - -getObjectKey ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getObjectKey ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getRealmAnyMap: - -.. _getRealmAnyMap__: - -.. _FrozenPendingRow_getRealmAnyMap: - -.. _FrozenPendingRow_getRealmAnyMap__: - -.. _io_realm_FrozenPendingRow_getRealmAnyMap: - -.. _io_realm_FrozenPendingRow_getRealmAnyMap__: - - - -getRealmAnyMap --------------- - -.. _io_realm_FrozenPendingRow_getRealmAnyMap_long_: - -.. _getRealmAnyMap_long_: - -.. _FrozenPendingRow_getRealmAnyMap_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsMap** :ref:`getRealmAnyMap ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getRealmAnySet: - -.. _getRealmAnySet__: - -.. _FrozenPendingRow_getRealmAnySet: - -.. _FrozenPendingRow_getRealmAnySet__: - -.. _io_realm_FrozenPendingRow_getRealmAnySet: - -.. _io_realm_FrozenPendingRow_getRealmAnySet__: - - - -getRealmAnySet --------------- - -.. _io_realm_FrozenPendingRow_getRealmAnySet_long_: - -.. _getRealmAnySet_long_: - -.. _FrozenPendingRow_getRealmAnySet_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsSet** :ref:`getRealmAnySet ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getString: - -.. _getString__: - -.. _FrozenPendingRow_getString: - -.. _FrozenPendingRow_getString__: - -.. _io_realm_FrozenPendingRow_getString: - -.. _io_realm_FrozenPendingRow_getString__: - - - -getString ---------- - -.. _io_realm_FrozenPendingRow_getString_long_: - -.. _getString_long_: - -.. _FrozenPendingRow_getString_long_: - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getString ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getTable: - -.. _getTable__: - -.. _FrozenPendingRow_getTable: - -.. _FrozenPendingRow_getTable__: - -.. _io_realm_FrozenPendingRow_getTable: - -.. _io_realm_FrozenPendingRow_getTable__: - - - -getTable --------- - -.. list-table:: - :header-rows: 1 - - * - | public **Table** :ref:`getTable ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getUUID: - -.. _getUUID__: - -.. _FrozenPendingRow_getUUID: - -.. _FrozenPendingRow_getUUID__: - -.. _io_realm_FrozenPendingRow_getUUID: - -.. _io_realm_FrozenPendingRow_getUUID__: - - - -getUUID -------- - -.. _io_realm_FrozenPendingRow_getUUID_long_: - -.. _getUUID_long_: - -.. _FrozenPendingRow_getUUID_long_: - -.. list-table:: - :header-rows: 1 - - * - | public `UUID `__ :ref:`getUUID ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getValueList: - -.. _getValueList__: - -.. _FrozenPendingRow_getValueList: - -.. _FrozenPendingRow_getValueList__: - -.. _io_realm_FrozenPendingRow_getValueList: - -.. _io_realm_FrozenPendingRow_getValueList__: - - - -getValueList ------------- - -.. _io_realm_FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueList_long_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueList_long__RealmFieldType_: - -.. _getValueList_long_io_realm_RealmFieldType_: - -.. _getValueList_long__io_realm_RealmFieldType_: - -.. _getValueList_long_RealmFieldType_: - -.. _getValueList_long__RealmFieldType_: - -.. _FrozenPendingRow_getValueList_long_io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueList_long__io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueList_long_RealmFieldType_: - -.. _FrozenPendingRow_getValueList_long__RealmFieldType_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsList** :ref:`getValueList ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getValueMap: - -.. _getValueMap__: - -.. _FrozenPendingRow_getValueMap: - -.. _FrozenPendingRow_getValueMap__: - -.. _io_realm_FrozenPendingRow_getValueMap: - -.. _io_realm_FrozenPendingRow_getValueMap__: - - - -getValueMap ------------ - -.. _io_realm_FrozenPendingRow_getValueMap_long_io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueMap_long__io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueMap_long_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueMap_long__RealmFieldType_: - -.. _getValueMap_long_io_realm_RealmFieldType_: - -.. _getValueMap_long__io_realm_RealmFieldType_: - -.. _getValueMap_long_RealmFieldType_: - -.. _getValueMap_long__RealmFieldType_: - -.. _FrozenPendingRow_getValueMap_long_io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueMap_long__io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueMap_long_RealmFieldType_: - -.. _FrozenPendingRow_getValueMap_long__RealmFieldType_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsMap** :ref:`getValueMap ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getValueSet: - -.. _getValueSet__: - -.. _FrozenPendingRow_getValueSet: - -.. _FrozenPendingRow_getValueSet__: - -.. _io_realm_FrozenPendingRow_getValueSet: - -.. _io_realm_FrozenPendingRow_getValueSet__: - - - -getValueSet ------------ - -.. _io_realm_FrozenPendingRow_getValueSet_long_io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueSet_long__io_realm_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueSet_long_RealmFieldType_: - -.. _io_realm_FrozenPendingRow_getValueSet_long__RealmFieldType_: - -.. _getValueSet_long_io_realm_RealmFieldType_: - -.. _getValueSet_long__io_realm_RealmFieldType_: - -.. _getValueSet_long_RealmFieldType_: - -.. _getValueSet_long__RealmFieldType_: - -.. _FrozenPendingRow_getValueSet_long_io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueSet_long__io_realm_RealmFieldType_: - -.. _FrozenPendingRow_getValueSet_long_RealmFieldType_: - -.. _FrozenPendingRow_getValueSet_long__RealmFieldType_: - -.. list-table:: - :header-rows: 1 - - * - | public **OsSet** :ref:`getValueSet ` ( - | **long** columnKey, - | :ref:`RealmFieldType ` fieldType - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _hasColumn: - -.. _hasColumn__: - -.. _FrozenPendingRow_hasColumn: - -.. _FrozenPendingRow_hasColumn__: - -.. _io_realm_FrozenPendingRow_hasColumn: - -.. _io_realm_FrozenPendingRow_hasColumn__: - - - -hasColumn ---------- - -.. _io_realm_FrozenPendingRow_hasColumn_java_lang_String_: - -.. _io_realm_FrozenPendingRow_hasColumn_String_: - -.. _hasColumn_java_lang_String_: - -.. _hasColumn_String_: - -.. _FrozenPendingRow_hasColumn_java_lang_String_: - -.. _FrozenPendingRow_hasColumn_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasColumn ` ( - | `String `__ fieldName - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _FrozenPendingRow_isLoaded: - -.. _FrozenPendingRow_isLoaded__: - -.. _io_realm_FrozenPendingRow_isLoaded: - -.. _io_realm_FrozenPendingRow_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isNull: - -.. _isNull__: - -.. _FrozenPendingRow_isNull: - -.. _FrozenPendingRow_isNull__: - -.. _io_realm_FrozenPendingRow_isNull: - -.. _io_realm_FrozenPendingRow_isNull__: - - - -isNull ------- - -.. _io_realm_FrozenPendingRow_isNull_long_: - -.. _isNull_long_: - -.. _FrozenPendingRow_isNull_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isNull ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _isNullLink: - -.. _isNullLink__: - -.. _FrozenPendingRow_isNullLink: - -.. _FrozenPendingRow_isNullLink__: - -.. _io_realm_FrozenPendingRow_isNullLink: - -.. _io_realm_FrozenPendingRow_isNullLink__: - - - -isNullLink ----------- - -.. _io_realm_FrozenPendingRow_isNullLink_long_: - -.. _isNullLink_long_: - -.. _FrozenPendingRow_isNullLink_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isNullLink ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _FrozenPendingRow_isValid: - -.. _FrozenPendingRow_isValid__: - -.. _io_realm_FrozenPendingRow_isValid: - -.. _io_realm_FrozenPendingRow_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _nullifyLink: - -.. _nullifyLink__: - -.. _FrozenPendingRow_nullifyLink: - -.. _FrozenPendingRow_nullifyLink__: - -.. _io_realm_FrozenPendingRow_nullifyLink: - -.. _io_realm_FrozenPendingRow_nullifyLink__: - - - -nullifyLink ------------ - -.. _io_realm_FrozenPendingRow_nullifyLink_long_: - -.. _nullifyLink_long_: - -.. _FrozenPendingRow_nullifyLink_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`nullifyLink ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setBinaryByteArray: - -.. _setBinaryByteArray__: - -.. _FrozenPendingRow_setBinaryByteArray: - -.. _FrozenPendingRow_setBinaryByteArray__: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray__: - - - -setBinaryByteArray ------------------- - -.. _io_realm_FrozenPendingRow_setBinaryByteArray_long_byte_: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray_long__byte_: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray_long_byte____: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray_long__byte____: - -.. _setBinaryByteArray_long_byte_: - -.. _setBinaryByteArray_long__byte_: - -.. _setBinaryByteArray_long_byte____: - -.. _setBinaryByteArray_long__byte____: - -.. _FrozenPendingRow_setBinaryByteArray_long_byte_: - -.. _FrozenPendingRow_setBinaryByteArray_long__byte_: - -.. _FrozenPendingRow_setBinaryByteArray_long_byte____: - -.. _FrozenPendingRow_setBinaryByteArray_long__byte____: - -.. _io_realm_FrozenPendingRow_setBinaryByteArray_long__byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBinaryByteArray ` ( - | **long** columnKey, - | **byte[]** data - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setBoolean: - -.. _setBoolean__: - -.. _FrozenPendingRow_setBoolean: - -.. _FrozenPendingRow_setBoolean__: - -.. _io_realm_FrozenPendingRow_setBoolean: - -.. _io_realm_FrozenPendingRow_setBoolean__: - - - -setBoolean ----------- - -.. _io_realm_FrozenPendingRow_setBoolean_long_boolean_: - -.. _io_realm_FrozenPendingRow_setBoolean_long__boolean_: - -.. _setBoolean_long_boolean_: - -.. _setBoolean_long__boolean_: - -.. _FrozenPendingRow_setBoolean_long_boolean_: - -.. _FrozenPendingRow_setBoolean_long__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBoolean ` ( - | **long** columnKey, - | **boolean** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setDate: - -.. _setDate__: - -.. _FrozenPendingRow_setDate: - -.. _FrozenPendingRow_setDate__: - -.. _io_realm_FrozenPendingRow_setDate: - -.. _io_realm_FrozenPendingRow_setDate__: - - - -setDate -------- - -.. _io_realm_FrozenPendingRow_setDate_long_java_util_Date_: - -.. _io_realm_FrozenPendingRow_setDate_long__java_util_Date_: - -.. _io_realm_FrozenPendingRow_setDate_long_Date_: - -.. _io_realm_FrozenPendingRow_setDate_long__Date_: - -.. _setDate_long_java_util_Date_: - -.. _setDate_long__java_util_Date_: - -.. _setDate_long_Date_: - -.. _setDate_long__Date_: - -.. _FrozenPendingRow_setDate_long_java_util_Date_: - -.. _FrozenPendingRow_setDate_long__java_util_Date_: - -.. _FrozenPendingRow_setDate_long_Date_: - -.. _FrozenPendingRow_setDate_long__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDate ` ( - | **long** columnKey, - | `Date `__ date - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setDecimal128: - -.. _setDecimal128__: - -.. _FrozenPendingRow_setDecimal128: - -.. _FrozenPendingRow_setDecimal128__: - -.. _io_realm_FrozenPendingRow_setDecimal128: - -.. _io_realm_FrozenPendingRow_setDecimal128__: - - - -setDecimal128 -------------- - -.. _io_realm_FrozenPendingRow_setDecimal128_long_Decimal128_: - -.. _io_realm_FrozenPendingRow_setDecimal128_long__Decimal128_: - -.. _setDecimal128_long_Decimal128_: - -.. _setDecimal128_long__Decimal128_: - -.. _FrozenPendingRow_setDecimal128_long_Decimal128_: - -.. _FrozenPendingRow_setDecimal128_long__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDecimal128 ` ( - | **long** columnKey, - | **Decimal128** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setDouble: - -.. _setDouble__: - -.. _FrozenPendingRow_setDouble: - -.. _FrozenPendingRow_setDouble__: - -.. _io_realm_FrozenPendingRow_setDouble: - -.. _io_realm_FrozenPendingRow_setDouble__: - - - -setDouble ---------- - -.. _io_realm_FrozenPendingRow_setDouble_long_double_: - -.. _io_realm_FrozenPendingRow_setDouble_long__double_: - -.. _setDouble_long_double_: - -.. _setDouble_long__double_: - -.. _FrozenPendingRow_setDouble_long_double_: - -.. _FrozenPendingRow_setDouble_long__double_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDouble ` ( - | **long** columnKey, - | **double** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setFloat: - -.. _setFloat__: - -.. _FrozenPendingRow_setFloat: - -.. _FrozenPendingRow_setFloat__: - -.. _io_realm_FrozenPendingRow_setFloat: - -.. _io_realm_FrozenPendingRow_setFloat__: - - - -setFloat --------- - -.. _io_realm_FrozenPendingRow_setFloat_long_float_: - -.. _io_realm_FrozenPendingRow_setFloat_long__float_: - -.. _setFloat_long_float_: - -.. _setFloat_long__float_: - -.. _FrozenPendingRow_setFloat_long_float_: - -.. _FrozenPendingRow_setFloat_long__float_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setFloat ` ( - | **long** columnKey, - | **float** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setLink: - -.. _setLink__: - -.. _FrozenPendingRow_setLink: - -.. _FrozenPendingRow_setLink__: - -.. _io_realm_FrozenPendingRow_setLink: - -.. _io_realm_FrozenPendingRow_setLink__: - - - -setLink -------- - -.. _io_realm_FrozenPendingRow_setLink_long_long_: - -.. _io_realm_FrozenPendingRow_setLink_long__long_: - -.. _setLink_long_long_: - -.. _setLink_long__long_: - -.. _FrozenPendingRow_setLink_long_long_: - -.. _FrozenPendingRow_setLink_long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setLink ` ( - | **long** columnKey, - | **long** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setLong: - -.. _setLong__: - -.. _FrozenPendingRow_setLong: - -.. _FrozenPendingRow_setLong__: - -.. _io_realm_FrozenPendingRow_setLong: - -.. _io_realm_FrozenPendingRow_setLong__: - - - -setLong -------- - -.. _io_realm_FrozenPendingRow_setLong_long_long_: - -.. _io_realm_FrozenPendingRow_setLong_long__long_: - -.. _setLong_long_long_: - -.. _setLong_long__long_: - -.. _FrozenPendingRow_setLong_long_long_: - -.. _FrozenPendingRow_setLong_long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setLong ` ( - | **long** columnKey, - | **long** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setNull: - -.. _setNull__: - -.. _FrozenPendingRow_setNull: - -.. _FrozenPendingRow_setNull__: - -.. _io_realm_FrozenPendingRow_setNull: - -.. _io_realm_FrozenPendingRow_setNull__: - - - -setNull -------- - -.. _io_realm_FrozenPendingRow_setNull_long_: - -.. _setNull_long_: - -.. _FrozenPendingRow_setNull_long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setNull ` ( - | **long** columnKey - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setObjectId: - -.. _setObjectId__: - -.. _FrozenPendingRow_setObjectId: - -.. _FrozenPendingRow_setObjectId__: - -.. _io_realm_FrozenPendingRow_setObjectId: - -.. _io_realm_FrozenPendingRow_setObjectId__: - - - -setObjectId ------------ - -.. _io_realm_FrozenPendingRow_setObjectId_long_ObjectId_: - -.. _io_realm_FrozenPendingRow_setObjectId_long__ObjectId_: - -.. _setObjectId_long_ObjectId_: - -.. _setObjectId_long__ObjectId_: - -.. _FrozenPendingRow_setObjectId_long_ObjectId_: - -.. _FrozenPendingRow_setObjectId_long__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setObjectId ` ( - | **long** columnKey, - | **ObjectId** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setRealmAny: - -.. _setRealmAny__: - -.. _FrozenPendingRow_setRealmAny: - -.. _FrozenPendingRow_setRealmAny__: - -.. _io_realm_FrozenPendingRow_setRealmAny: - -.. _io_realm_FrozenPendingRow_setRealmAny__: - - - -setRealmAny ------------ - -.. _io_realm_FrozenPendingRow_setRealmAny_long_long_: - -.. _io_realm_FrozenPendingRow_setRealmAny_long__long_: - -.. _setRealmAny_long_long_: - -.. _setRealmAny_long__long_: - -.. _FrozenPendingRow_setRealmAny_long_long_: - -.. _FrozenPendingRow_setRealmAny_long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setRealmAny ` ( - | **long** columnKey, - | **long** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setString: - -.. _setString__: - -.. _FrozenPendingRow_setString: - -.. _FrozenPendingRow_setString__: - -.. _io_realm_FrozenPendingRow_setString: - -.. _io_realm_FrozenPendingRow_setString__: - - - -setString ---------- - -.. _io_realm_FrozenPendingRow_setString_long_java_lang_String_: - -.. _io_realm_FrozenPendingRow_setString_long__java_lang_String_: - -.. _io_realm_FrozenPendingRow_setString_long_String_: - -.. _io_realm_FrozenPendingRow_setString_long__String_: - -.. _setString_long_java_lang_String_: - -.. _setString_long__java_lang_String_: - -.. _setString_long_String_: - -.. _setString_long__String_: - -.. _FrozenPendingRow_setString_long_java_lang_String_: - -.. _FrozenPendingRow_setString_long__java_lang_String_: - -.. _FrozenPendingRow_setString_long_String_: - -.. _FrozenPendingRow_setString_long__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setString ` ( - | **long** columnKey, - | `String `__ value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setUUID: - -.. _setUUID__: - -.. _FrozenPendingRow_setUUID: - -.. _FrozenPendingRow_setUUID__: - -.. _io_realm_FrozenPendingRow_setUUID: - -.. _io_realm_FrozenPendingRow_setUUID__: - - - -setUUID -------- - -.. _io_realm_FrozenPendingRow_setUUID_long_java_util_UUID_: - -.. _io_realm_FrozenPendingRow_setUUID_long__java_util_UUID_: - -.. _io_realm_FrozenPendingRow_setUUID_long_UUID_: - -.. _io_realm_FrozenPendingRow_setUUID_long__UUID_: - -.. _setUUID_long_java_util_UUID_: - -.. _setUUID_long__java_util_UUID_: - -.. _setUUID_long_UUID_: - -.. _setUUID_long__UUID_: - -.. _FrozenPendingRow_setUUID_long_java_util_UUID_: - -.. _FrozenPendingRow_setUUID_long__java_util_UUID_: - -.. _FrozenPendingRow_setUUID_long_UUID_: - -.. _FrozenPendingRow_setUUID_long__UUID_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setUUID ` ( - | **long** columnKey, - | `UUID `__ value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _FrozenPendingRow_valueOf: - -.. _FrozenPendingRow_valueOf__: - -.. _io_realm_FrozenPendingRow_valueOf: - -.. _io_realm_FrozenPendingRow_valueOf__: - - - -valueOf -------- - -.. _io_realm_FrozenPendingRow_valueOf_java_lang_String_: - -.. _io_realm_FrozenPendingRow_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _FrozenPendingRow_valueOf_java_lang_String_: - -.. _FrozenPendingRow_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`FrozenPendingRow ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _FrozenPendingRow_values: - -.. _FrozenPendingRow_values__: - -.. _io_realm_FrozenPendingRow_values: - -.. _io_realm_FrozenPendingRow_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`FrozenPendingRow ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/ImportFlag.txt b/source/sdk/java/api/io/realm/ImportFlag.txt deleted file mode 100644 index 31b73bd925..0000000000 --- a/source/sdk/java/api/io/realm/ImportFlag.txt +++ /dev/null @@ -1,252 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum ImportFlag -^^^^^^^^^^^^^^^ - -.. _io_realm_ImportFlag: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.ImportFlag - - -This class describe how data is saved to Realm when saving whole objects. - - -.. seealso:: - - - - - :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`CHECK_SAME_VALUES_BEFORE_SET ` - - With this flag enabled, fields will not be written to the Realm file if they contain the same value as the value already present in the Realm. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`ImportFlag ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`ImportFlag ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_ImportFlag_CHECK_SAME_VALUES_BEFORE_SET: - -.. _ImportFlag_CHECK_SAME_VALUES_BEFORE_SET: - - - -``CHECK_SAME_VALUES_BEFORE_SET`` ---------------------------------- - -public static final :ref:`ImportFlag ` - -With this flag enabled, fields will not be written to the Realm file if they contain the same value as the value already present in the Realm.For local Realms this only has an impact on change listeners which will not report changes to those fields that were not written. - -For synchronized Realms this also impacts the server, which will see improved performance as there are fewer changes to upload and merge into the server Realm. - -It also impacts how the server merges changes from different devices. Realm uses a last-write-wins approach when merging individual fields in an object, so if a field is not written it will be considered "older" than other fields modified. - -E.g: - - - -1. Server starts out with (Field A = 1, Field B = 1) - - -#. Device 1 writes (Field A = 2, Field B = 2). - - -#. Device 2 writes (Field A = 3, Field B = 1) but ignores (Field B = 1), because that is the value in the Realm file at this point. - - -#. Device 1 uploads its changes to the server making the server (Field A = 2, Field B = 2). Then Device 2 uploads its changes. Due to last-write-wins, the server version now becomes (Field A = 3, Field B = 2). - - - - -This is normally the desired behavior as the final object is the merged result of the latest changes from both devices, however if all the fields in an object are considered an atomic unit, then this flag should not be set as it will ensure that all fields are set and thus have the same "age" when data are sent to the server. - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _ImportFlag_valueOf: - -.. _ImportFlag_valueOf__: - -.. _io_realm_ImportFlag_valueOf: - -.. _io_realm_ImportFlag_valueOf__: - - - -valueOf -------- - -.. _io_realm_ImportFlag_valueOf_java_lang_String_: - -.. _io_realm_ImportFlag_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _ImportFlag_valueOf_java_lang_String_: - -.. _ImportFlag_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ImportFlag ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _ImportFlag_values: - -.. _ImportFlag_values__: - -.. _io_realm_ImportFlag_values: - -.. _io_realm_ImportFlag_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ImportFlag ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/MapChangeListener.txt b/source/sdk/java/api/io/realm/MapChangeListener.txt deleted file mode 100644 index a2c6f60c57..0000000000 --- a/source/sdk/java/api/io/realm/MapChangeListener.txt +++ /dev/null @@ -1,179 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface MapChangeListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_MapChangeListener: - - - -io.realm -======== - -:ref:`MapChangeListener ` can be registered with a :ref:`RealmMap ` to receive a notification with a :ref:`MapChangeSet ` to describe the details of what have been changed in the map since last time. - -Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`MapChangeListener ` . - - - - - - -.. seealso:: - - - - - :ref:`RealmMap.addChangeListener(MapChangeListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | :ref:`io.realm.RealmMap\ ` map, - | :ref:`io.realm.MapChangeSet\ ` changes - | ) - - - This will be called when the async query is finished the first time or the collection of objects has changed. - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _MapChangeListener_onChange: - -.. _MapChangeListener_onChange__: - -.. _io_realm_MapChangeListener_onChange: - -.. _io_realm_MapChangeListener_onChange__: - - - -onChange --------- - -.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap_io_realm_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap__io_realm_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_io_realm_RealmMap__MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_RealmMap_io_realm_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_RealmMap__io_realm_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_RealmMap_MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_RealmMap__MapChangeSet_: - -.. _onChange_io_realm_RealmMap_io_realm_MapChangeSet_: - -.. _onChange_io_realm_RealmMap__io_realm_MapChangeSet_: - -.. _onChange_io_realm_RealmMap_MapChangeSet_: - -.. _onChange_io_realm_RealmMap__MapChangeSet_: - -.. _onChange_RealmMap_io_realm_MapChangeSet_: - -.. _onChange_RealmMap__io_realm_MapChangeSet_: - -.. _onChange_RealmMap_MapChangeSet_: - -.. _onChange_RealmMap__MapChangeSet_: - -.. _MapChangeListener_onChange_io_realm_RealmMap_io_realm_MapChangeSet_: - -.. _MapChangeListener_onChange_io_realm_RealmMap__io_realm_MapChangeSet_: - -.. _MapChangeListener_onChange_io_realm_RealmMap_MapChangeSet_: - -.. _MapChangeListener_onChange_io_realm_RealmMap__MapChangeSet_: - -.. _MapChangeListener_onChange_RealmMap_io_realm_MapChangeSet_: - -.. _MapChangeListener_onChange_RealmMap__io_realm_MapChangeSet_: - -.. _MapChangeListener_onChange_RealmMap_MapChangeSet_: - -.. _MapChangeListener_onChange_RealmMap__MapChangeSet_: - -.. _io_realm_MapChangeListener_onChange_RealmMap_K__V___MapChangeSet_K__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | :ref:`io.realm.RealmMap\ ` map, - | :ref:`io.realm.MapChangeSet\ ` changes - | ) - - - - - * - This will be called when the async query is finished the first time or the collection of objects has changed. - - - - - **Parameters** - - - ``map`` - the map this listener is registered to. - - - - - ``changes`` - object with information about the change. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/MapChangeSet.txt b/source/sdk/java/api/io/realm/MapChangeSet.txt deleted file mode 100644 index 849eda657b..0000000000 --- a/source/sdk/java/api/io/realm/MapChangeSet.txt +++ /dev/null @@ -1,273 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface MapChangeSet -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_MapChangeSet: - - - -io.realm -======== - -This interface describes the changes made to a map during the last update.:ref:`MapChangeSet ` is passed to the :ref:`MapChangeListener ` which is registered by :ref:`RealmMap.addChangeListener(MapChangeListener) ` . - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **T** - - | :ref:`getChanges ` () - | - - - Array containing the keys that have been modified in the previous version of the map. - - - - - * - public **T** - - | :ref:`getDeletions ` () - | - - - The number of entries that have been deleted in the previous version of the map. - - - - - * - public **T** - - | :ref:`getInsertions ` () - | - - - Array containing the keys that have been inserted in the previous version of the map. - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - Whether the change set is empty or not. - - - - - - - -Method Detail -============= - -.. _getChanges: - -.. _getChanges__: - -.. _MapChangeSet_getChanges: - -.. _MapChangeSet_getChanges__: - -.. _io_realm_MapChangeSet_getChanges: - -.. _io_realm_MapChangeSet_getChanges__: - - - -getChanges ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`getChanges ` () - | - - - - - * - Array containing the keys that have been modified in the previous version of the map. - - - - - - - **Returns** - - array with the keys that have been modified. - - - - - - - - - - - -.. _getDeletions: - -.. _getDeletions__: - -.. _MapChangeSet_getDeletions: - -.. _MapChangeSet_getDeletions__: - -.. _io_realm_MapChangeSet_getDeletions: - -.. _io_realm_MapChangeSet_getDeletions__: - - - -getDeletions ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`getDeletions ` () - | - - - - - * - The number of entries that have been deleted in the previous version of the map. - - - - - - - **Returns** - - array with the keys that have been deleted. - - - - - - - - - - - -.. _getInsertions: - -.. _getInsertions__: - -.. _MapChangeSet_getInsertions: - -.. _MapChangeSet_getInsertions__: - -.. _io_realm_MapChangeSet_getInsertions: - -.. _io_realm_MapChangeSet_getInsertions__: - - - -getInsertions -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`getInsertions ` () - | - - - - - * - Array containing the keys that have been inserted in the previous version of the map. - - - - - - - **Returns** - - array with the keys that have been inserted. - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _MapChangeSet_isEmpty: - -.. _MapChangeSet_isEmpty__: - -.. _io_realm_MapChangeSet_isEmpty: - -.. _io_realm_MapChangeSet_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - Whether the change set is empty or not. This is needed to detect whether a notification has been triggered right after subscription. - - - - - - - **Returns** - - whether the change set contains changes. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/MutableRealmInteger.txt b/source/sdk/java/api/io/realm/MutableRealmInteger.txt deleted file mode 100644 index 9cc2e91cd6..0000000000 --- a/source/sdk/java/api/io/realm/MutableRealmInteger.txt +++ /dev/null @@ -1,1030 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MutableRealmInteger -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_MutableRealmInteger: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.MutableRealmInteger - - -**Implemented interfaces:** - - - -- `java.lang.Comparable `__ - - -A ``MutableRealmInteger`` is a mutable, `Long `__ -like numeric quantity. It behaves almost exactly as a reference to a `Long `__ . More specifically: - - - -- A ``MutableRealmInteger`` may have the value ``null`` . - - - - -- The :ref:`equals ` operator compares the contained `Long `__ values. ``null`` -valued ``MutableRealmInteger`` are ``.equals`` - - - - -- The :ref:`compareTo ` operator compares the contained `Long `__ values. It considers ``null`` < any non-``null`` value. - - - - -- The :ref:`increment ` and :ref:`decrement ` operators throw `IllegalStateException `__ when applied to a ``null`` -valued ``MutableRealmInteger`` . - - - - - - -``MutableRealmInteger`` s are most interesting as members of a managed :ref:`RealmModel ` object. When managed, the :ref:`increment ` and :ref:`decrement ` operators implement a - -`conflict free replicated data type `__ : Simultaneous increments and decrements from multiple distributed clients will be aggregated correctly. For instance, if the value of ``counter`` field for the object representing user "Fred" is currently 0, then the following code, executed on two different devices, simultaneously, even if connected by only a slow, unreliable network, will - -**always** cause the value of ``counter`` to converge, eventually on the value 2. - - - - - -.. code-block:: java - - MutableRealmInteger counter = realm.where(Users.class) - .equalTo("name", Fred) - .findFirst() - .counter.increment(1); - - -Note that the :ref:`set(Long) ` operator must be used with extreme care. It will quash the effects of any prior calls to :ref:`increment(long) ` or :ref:`decrement(long) ` . Although the value of a ``MutableRealmInteger`` will always converge across devices, the specific value on which it converges will depend on the actual order in which operations took place. Mixing :ref:`set(Long) ` with :ref:`increment(long) ` and :ref:`decrement(long) ` is, therefore, not advised, unless fuzzy counting is acceptable. - -``MutableRealmInteger`` s may not be primary keys. Their implementations are not thread safe. Like all managed Realm objects, managed ``MutableRealmInteger`` s may not be moved across threads. Unmanaged ``MutableRealmInteger`` s may be moved across threads but require safe publication. - - - -A ``MutableRealmInteger`` , in a model class, must always be declared ``final`` . For instance: - - - - ``public final MutableRealmInteger counter = MutableRealmInteger.ofNull();`` - - -Although initializing the ``MutableRealmInteger`` as ``null`` may work very limited circumstances, developers are advised - -**not** to do it: - -.. code-block:: java - - - public final MutableRealmInteger counter = null; // DO NOT DO THIS! - - - - -Also note that when a ``MutableRealmInteger`` is ``@Required`` , it is better, though not required, to initialize it with a non-null value. - - - \@Required - public final MutableRealmInteger counter = MutableRealmInteger.valueOf(0L); - - -A reference to a managed ``MutableRealmInteger`` is subject to all of the constraints that apply to the model object from which it was obtained: It can only be mutated within a transaction and it becomes invalid if the Realm backing it is closed. Use the ``isManaged()`` and ``isValid()`` operators to determine whether a ``MutableRealmInteger`` is in a consistent state. Note, in particular, that a reference to a managed ``MutableRealmInteger`` retains a reference to the model object to which it belongs. For example in this code: - - - - ``MutableRealmInteger counter = realm.where(Users.class).findFirst().counter;`` - - -the ``counter`` holds a reference to the ``User`` model object from which it was obtained. Neither can be GCed until all references to both are unreachable. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public final **int** - - | :ref:`compareTo ` ( - | :ref:`MutableRealmInteger ` o - | ) - - - ``MutableRealmInteger`` s compare strictly by their values. - - - - - - - * - public abstract **void** - - | :ref:`decrement ` ( - | **long** dec - | ) - - - Decrements the ``MutableRealmInteger`` , subtracting the value of the argument. - - - - - - - * - public final **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - Two ``MutableRealmInteger`` s are ``.equals`` if and only if their ``longValues`` are equal. - - - - - - - * - public abstract `Long `__ - - | :ref:`get ` () - | - - - Gets the ``MutableRealmInteger`` value. - - - - - - - * - public final **int** - - | :ref:`hashCode ` () - | - - - A ``MutableRealmInteger`` 's hash code is, exactly, the hash code of its value. - - - - - - - * - public abstract **void** - - | :ref:`increment ` ( - | **long** inc - | ) - - - Increments the ``MutableRealmInteger`` , adding the value of the argument. - - - - - - - * - public final **boolean** - - | :ref:`isNull ` () - | - - - - - - - - * - public static :ref:`MutableRealmInteger ` - - | :ref:`ofNull ` () - | - - - Creates a new, unmanaged ``MutableRealmInteger`` whose value is ``null`` . - - - - - - - * - public final **void** - - | :ref:`set ` ( - | **long** newValue - | ) - - - Sets the ``MutableRealmInteger`` value. - - - - - - - * - public abstract **void** - - | :ref:`set ` ( - | `Long `__ newValue - | ) - - - Sets the ``MutableRealmInteger`` value. - - - - - - - * - public static :ref:`MutableRealmInteger ` - - | :ref:`valueOf ` ( - | `String `__ value - | ) - - - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - * - public static :ref:`MutableRealmInteger ` - - | :ref:`valueOf ` ( - | **long** value - | ) - - - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - * - public static :ref:`MutableRealmInteger ` - - | :ref:`valueOf ` ( - | `Long `__ value - | ) - - - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _compareTo: - -.. _compareTo__: - -.. _MutableRealmInteger_compareTo: - -.. _MutableRealmInteger_compareTo__: - -.. _io_realm_MutableRealmInteger_compareTo: - -.. _io_realm_MutableRealmInteger_compareTo__: - - - -compareTo ---------- - -.. _io_realm_MutableRealmInteger_compareTo_io_realm_MutableRealmInteger_: - -.. _io_realm_MutableRealmInteger_compareTo_MutableRealmInteger_: - -.. _compareTo_io_realm_MutableRealmInteger_: - -.. _compareTo_MutableRealmInteger_: - -.. _MutableRealmInteger_compareTo_io_realm_MutableRealmInteger_: - -.. _MutableRealmInteger_compareTo_MutableRealmInteger_: - -.. list-table:: - :header-rows: 1 - - * - | public final **int** :ref:`compareTo ` ( - | :ref:`MutableRealmInteger ` o - | ) - - - - - * - ``MutableRealmInteger`` s compare strictly by their values. Null is a legal value for a ``MutableRealmInteger`` and ``null`` < any non-``null`` value - - - - - - - **Parameters** - - - ``o`` - the compare target - - - - - - - - **Returns** - - -1, 0, or 1, depending on whether this object's value is <, =, or > the target's. - - - - - - - - - - - -.. _decrement: - -.. _decrement__: - -.. _MutableRealmInteger_decrement: - -.. _MutableRealmInteger_decrement__: - -.. _io_realm_MutableRealmInteger_decrement: - -.. _io_realm_MutableRealmInteger_decrement__: - - - -decrement ---------- - -.. _io_realm_MutableRealmInteger_decrement_long_: - -.. _decrement_long_: - -.. _MutableRealmInteger_decrement_long_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`decrement ` ( - | **long** dec - | ) - - - - - * - Decrements the ``MutableRealmInteger`` , subtracting the value of the argument. Increment/decrement from all devices are reflected in the new value, which is guaranteed to converge. - - - - - - - **Parameters** - - - ``dec`` - quantity to be subtracted from the ``MutableRealmInteger`` . - - - - - - - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _MutableRealmInteger_equals: - -.. _MutableRealmInteger_equals__: - -.. _io_realm_MutableRealmInteger_equals: - -.. _io_realm_MutableRealmInteger_equals__: - - - -equals ------- - -.. _io_realm_MutableRealmInteger_equals_java_lang_Object_: - -.. _io_realm_MutableRealmInteger_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _MutableRealmInteger_equals_java_lang_Object_: - -.. _MutableRealmInteger_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - Two ``MutableRealmInteger`` s are ``.equals`` if and only if their ``longValues`` are equal. - - - - - - - **Parameters** - - - ``o`` - compare target - - - - - - - - **Returns** - - true if the target has the same value. - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _get: - -.. _get__: - -.. _MutableRealmInteger_get: - -.. _MutableRealmInteger_get__: - -.. _io_realm_MutableRealmInteger_get: - -.. _io_realm_MutableRealmInteger_get__: - - - -get ----- - -.. list-table:: - :header-rows: 1 - - * - | public abstract `Long `__ :ref:`get ` () - | - - - - - * - Gets the ``MutableRealmInteger`` value. The value may be null. - - - - - - - - - **Returns** - - the value. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _MutableRealmInteger_hashCode: - -.. _MutableRealmInteger_hashCode__: - -.. _io_realm_MutableRealmInteger_hashCode: - -.. _io_realm_MutableRealmInteger_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public final **int** :ref:`hashCode ` () - | - - - - - * - A ``MutableRealmInteger`` 's hash code is, exactly, the hash code of its value. - - - - - - - - - **Returns** - - true if the target has the same value. - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _increment: - -.. _increment__: - -.. _MutableRealmInteger_increment: - -.. _MutableRealmInteger_increment__: - -.. _io_realm_MutableRealmInteger_increment: - -.. _io_realm_MutableRealmInteger_increment__: - - - -increment ---------- - -.. _io_realm_MutableRealmInteger_increment_long_: - -.. _increment_long_: - -.. _MutableRealmInteger_increment_long_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`increment ` ( - | **long** inc - | ) - - - - - * - Increments the ``MutableRealmInteger`` , adding the value of the argument. Increment/decrement from all devices are reflected in the new value, which is guaranteed to converge. - - - - - - - **Parameters** - - - ``inc`` - quantity to be added to the ``MutableRealmInteger`` . - - - - - - - - - - - - - - - - - - -.. _isNull: - -.. _isNull__: - -.. _MutableRealmInteger_isNull: - -.. _MutableRealmInteger_isNull__: - -.. _io_realm_MutableRealmInteger_isNull: - -.. _io_realm_MutableRealmInteger_isNull__: - - - -isNull ------- - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`isNull ` () - | - - - - - * - - - - - - - - **Returns** - - true if and only if :ref:`get ` will return ``null`` . - - - - - - - - - - - - - -.. _ofNull: - -.. _ofNull__: - -.. _MutableRealmInteger_ofNull: - -.. _MutableRealmInteger_ofNull__: - -.. _io_realm_MutableRealmInteger_ofNull: - -.. _io_realm_MutableRealmInteger_ofNull__: - - - -ofNull ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`MutableRealmInteger ` :ref:`ofNull ` () - | - - - - - * - Creates a new, unmanaged ``MutableRealmInteger`` whose value is ``null`` . - - - - - - - - - - - - - - - - - -.. _set: - -.. _set__: - -.. _MutableRealmInteger_set: - -.. _MutableRealmInteger_set__: - -.. _io_realm_MutableRealmInteger_set: - -.. _io_realm_MutableRealmInteger_set__: - - - -set ----- - -.. _io_realm_MutableRealmInteger_set_long_: - -.. _set_long_: - -.. _MutableRealmInteger_set_long_: - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`set ` ( - | **long** newValue - | ) - - - - - * - Sets the ``MutableRealmInteger`` value. Calling :ref:`set ` forcibly sets the ``MutableRealmInteger`` to the provided value. Doing this obliterates the effects of any calls to :ref:`increment ` and :ref:`decrement ` perceived before the call to :ref:`set ` . - - - - - - - **Parameters** - - - ``newValue`` - new value. - - - - - - - - - - - - - - -.. _io_realm_MutableRealmInteger_set_java_lang_Long_: - -.. _io_realm_MutableRealmInteger_set_Long_: - -.. _set_java_lang_Long_: - -.. _set_Long_: - -.. _MutableRealmInteger_set_java_lang_Long_: - -.. _MutableRealmInteger_set_Long_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`set ` ( - | `Long `__ newValue - | ) - - - - - * - Sets the ``MutableRealmInteger`` value. Calling ``set`` forcibly sets the ``MutableRealmInteger`` to the provided value. Doing this obliterates the effects of any calls to :ref:`increment ` and :ref:`decrement ` perceived before the call to ``set`` . - - - - - - - **Parameters** - - - ``newValue`` - new value. - - - - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _MutableRealmInteger_valueOf: - -.. _MutableRealmInteger_valueOf__: - -.. _io_realm_MutableRealmInteger_valueOf: - -.. _io_realm_MutableRealmInteger_valueOf__: - - - -valueOf -------- - -.. _io_realm_MutableRealmInteger_valueOf_java_lang_String_: - -.. _io_realm_MutableRealmInteger_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _MutableRealmInteger_valueOf_java_lang_String_: - -.. _MutableRealmInteger_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`MutableRealmInteger ` :ref:`valueOf ` ( - | `String `__ value - | ) - - - - - * - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - **Parameters** - - - ``value`` - initial value: parsed by `Long.parseLong `__ . - - - - - - - - - - - - - - - - -.. _io_realm_MutableRealmInteger_valueOf_long_: - -.. _valueOf_long_: - -.. _MutableRealmInteger_valueOf_long_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`MutableRealmInteger ` :ref:`valueOf ` ( - | **long** value - | ) - - - - - * - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - **Parameters** - - - ``value`` - initial value. - - - - - - - - - - - - - - -.. _io_realm_MutableRealmInteger_valueOf_java_lang_Long_: - -.. _io_realm_MutableRealmInteger_valueOf_Long_: - -.. _valueOf_java_lang_Long_: - -.. _valueOf_Long_: - -.. _MutableRealmInteger_valueOf_java_lang_Long_: - -.. _MutableRealmInteger_valueOf_Long_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`MutableRealmInteger ` :ref:`valueOf ` ( - | `Long `__ value - | ) - - - - - * - Creates a new, unmanaged ``MutableRealmInteger`` with the specified initial value. - - - - - - - **Parameters** - - - ``value`` - initial value. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/ObjectChangeSet.txt b/source/sdk/java/api/io/realm/ObjectChangeSet.txt deleted file mode 100644 index 14e0ad823b..0000000000 --- a/source/sdk/java/api/io/realm/ObjectChangeSet.txt +++ /dev/null @@ -1,252 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface ObjectChangeSet -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_ObjectChangeSet: - - - -io.realm -======== - -Information about the changes made to an object. - - -.. seealso:: - - - - - :ref:`RealmObject.addChangeListener(RealmObjectChangeListener) . ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public `String `__ - - | :ref:`getChangedFields ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isDeleted ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isFieldChanged ` ( - | `String `__ fieldName - | ) - - - Checks if a given field has been changed. - - - - - - - -Method Detail -============= - -.. _getChangedFields: - -.. _getChangedFields__: - -.. _ObjectChangeSet_getChangedFields: - -.. _ObjectChangeSet_getChangedFields__: - -.. _io_realm_ObjectChangeSet_getChangedFields: - -.. _io_realm_ObjectChangeSet_getChangedFields__: - - - -getChangedFields ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getChangedFields ` () - | - - - - - * - - - - - - - - **Returns** - - the names of changed fields if the object still exists and there are field changes. Returns an empty ``String[]`` if the object has been deleted. - - - - - - - - - - - - - -.. _isDeleted: - -.. _isDeleted__: - -.. _ObjectChangeSet_isDeleted: - -.. _ObjectChangeSet_isDeleted__: - -.. _io_realm_ObjectChangeSet_isDeleted: - -.. _io_realm_ObjectChangeSet_isDeleted__: - - - -isDeleted ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isDeleted ` () - | - - - - - * - - - - - - - - **Returns** - - true if the object has been deleted from the Realm. - - - - - - - - - - - -.. _isFieldChanged: - -.. _isFieldChanged__: - -.. _ObjectChangeSet_isFieldChanged: - -.. _ObjectChangeSet_isFieldChanged__: - -.. _io_realm_ObjectChangeSet_isFieldChanged: - -.. _io_realm_ObjectChangeSet_isFieldChanged__: - - - -isFieldChanged --------------- - -.. _io_realm_ObjectChangeSet_isFieldChanged_java_lang_String_: - -.. _io_realm_ObjectChangeSet_isFieldChanged_String_: - -.. _isFieldChanged_java_lang_String_: - -.. _isFieldChanged_String_: - -.. _ObjectChangeSet_isFieldChanged_java_lang_String_: - -.. _ObjectChangeSet_isFieldChanged_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFieldChanged ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if a given field has been changed. - - - - - **Parameters** - - - ``fieldName`` - to be checked if its value has been changed. - - - - - - - - **Returns** - - ``true`` if the field has been changed. It returns ``false`` if the object is deleted, the field cannot be found or the field hasn't been changed. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt deleted file mode 100644 index 69b2027270..0000000000 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet.txt +++ /dev/null @@ -1,551 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface OrderedCollectionChangeSet -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedCollectionChangeSet: - - - -io.realm -======== - -This interface describes the changes made to a collection during the last update.:ref:`OrderedCollectionChangeSet ` is passed to the :ref:`OrderedRealmCollectionChangeListener ` which is registered by :ref:`RealmResults.addChangeListener(OrderedRealmCollectionChangeListener) ` . - - - -The change information is available in two formats: a simple array of row indices in the collection for each type of change, or an array of :ref:`Range ` s. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`OrderedCollectionChangeSet.State ` - - - * - ``public static`` - - :ref:`OrderedCollectionChangeSet.Range ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`OrderedCollectionChangeSet.Range ` - - | :ref:`getChangeRanges ` () - | - - - The modified ranges of objects in the new version of the collection. - - - - - * - public **int** - - | :ref:`getChanges ` () - | - - - The modified indices in the new version of the collection. - - - - - * - public :ref:`OrderedCollectionChangeSet.Range ` - - | :ref:`getDeletionRanges ` () - | - - - The deleted ranges of objects in the previous version of the collection. - - - - - * - public **int** - - | :ref:`getDeletions ` () - | - - - The deleted indices in the previous version of the collection. - - - - - * - public `Throwable `__ - - | :ref:`getError ` () - | - - - Returns any error that happened. - - - - - * - public :ref:`OrderedCollectionChangeSet.Range ` - - | :ref:`getInsertionRanges ` () - | - - - The inserted ranges of objects in the new version of the collection. - - - - - * - public **int** - - | :ref:`getInsertions ` () - | - - - The inserted indices in the new version of the collection. - - - - - * - public :ref:`OrderedCollectionChangeSet.State ` - - | :ref:`getState ` () - | - - - Returns the state represented by this change. - - - - - - - -Method Detail -============= - -.. _getChangeRanges: - -.. _getChangeRanges__: - -.. _OrderedCollectionChangeSet_getChangeRanges: - -.. _OrderedCollectionChangeSet_getChangeRanges__: - -.. _io_realm_OrderedCollectionChangeSet_getChangeRanges: - -.. _io_realm_OrderedCollectionChangeSet_getChangeRanges__: - - - -getChangeRanges ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedCollectionChangeSet.Range ` :ref:`getChangeRanges ` () - | - - - - - * - The modified ranges of objects in the new version of the collection. - - - - - - - **Returns** - - the :ref:`Range ` array. A zero-sized array will be returned if no objects were modified. - - - - - - - - - - - - - -.. _getChanges: - -.. _getChanges__: - -.. _OrderedCollectionChangeSet_getChanges: - -.. _OrderedCollectionChangeSet_getChanges__: - -.. _io_realm_OrderedCollectionChangeSet_getChanges: - -.. _io_realm_OrderedCollectionChangeSet_getChanges__: - - - -getChanges ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getChanges ` () - | - - - - - * - The modified indices in the new version of the collection.For :ref:`RealmResults ` , this means that one or more of the properties of the object at the given index were modified (or an object linked to by that object was modified). - - - - - - - - - - - **Returns** - - the indices array. A zero-sized array will be returned if objects were modified. - - - - - - - - - - - -.. _getDeletionRanges: - -.. _getDeletionRanges__: - -.. _OrderedCollectionChangeSet_getDeletionRanges: - -.. _OrderedCollectionChangeSet_getDeletionRanges__: - -.. _io_realm_OrderedCollectionChangeSet_getDeletionRanges: - -.. _io_realm_OrderedCollectionChangeSet_getDeletionRanges__: - - - -getDeletionRanges ------------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedCollectionChangeSet.Range ` :ref:`getDeletionRanges ` () - | - - - - - * - The deleted ranges of objects in the previous version of the collection. - - - - - - - **Returns** - - the :ref:`Range ` array. A zero-sized array will be returned if no objects were deleted. - - - - - - - - - - - - - -.. _getDeletions: - -.. _getDeletions__: - -.. _OrderedCollectionChangeSet_getDeletions: - -.. _OrderedCollectionChangeSet_getDeletions__: - -.. _io_realm_OrderedCollectionChangeSet_getDeletions: - -.. _io_realm_OrderedCollectionChangeSet_getDeletions__: - - - -getDeletions ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getDeletions ` () - | - - - - - * - The deleted indices in the previous version of the collection. - - - - - - - **Returns** - - the indices array. A zero-sized array will be returned if no objects were deleted. - - - - - - - - - - - -.. _getError: - -.. _getError__: - -.. _OrderedCollectionChangeSet_getError: - -.. _OrderedCollectionChangeSet_getError__: - -.. _io_realm_OrderedCollectionChangeSet_getError: - -.. _io_realm_OrderedCollectionChangeSet_getError__: - - - -getError --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Throwable `__ :ref:`getError ` () - | - - - - - * - Returns any error that happened. If an error has happened, the state of the collection and other changeset information is undefined. It is possible for a collection to go into an error state after being created and starting to send updates. - - - - - - - **Returns** - - the error that happened. - - - - - - - - - - - -.. _getInsertionRanges: - -.. _getInsertionRanges__: - -.. _OrderedCollectionChangeSet_getInsertionRanges: - -.. _OrderedCollectionChangeSet_getInsertionRanges__: - -.. _io_realm_OrderedCollectionChangeSet_getInsertionRanges: - -.. _io_realm_OrderedCollectionChangeSet_getInsertionRanges__: - - - -getInsertionRanges ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedCollectionChangeSet.Range ` :ref:`getInsertionRanges ` () - | - - - - - * - The inserted ranges of objects in the new version of the collection. - - - - - - - **Returns** - - the :ref:`Range ` array. A zero-sized array will be returned if no objects were inserted. - - - - - - - - - - - - - -.. _getInsertions: - -.. _getInsertions__: - -.. _OrderedCollectionChangeSet_getInsertions: - -.. _OrderedCollectionChangeSet_getInsertions__: - -.. _io_realm_OrderedCollectionChangeSet_getInsertions: - -.. _io_realm_OrderedCollectionChangeSet_getInsertions__: - - - -getInsertions -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getInsertions ` () - | - - - - - * - The inserted indices in the new version of the collection. - - - - - - - **Returns** - - the indices array. A zero-sized array will be returned if no objects were inserted. - - - - - - - - - - - -.. _getState: - -.. _getState__: - -.. _OrderedCollectionChangeSet_getState: - -.. _OrderedCollectionChangeSet_getState__: - -.. _io_realm_OrderedCollectionChangeSet_getState: - -.. _io_realm_OrderedCollectionChangeSet_getState__: - - - -getState --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedCollectionChangeSet.State ` :ref:`getState ` () - | - - - - - * - Returns the state represented by this change. See :ref:`State ` for a description of the different states a changeset can be in. - - - - - - - - - **Returns** - - what kind of state is represented by this changeset. - - - - - - - - - .. seealso:: - - - - - :ref:`State ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt deleted file mode 100644 index 0062a0de61..0000000000 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/Range.txt +++ /dev/null @@ -1,251 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class OrderedCollectionChangeSet.Range -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedCollectionChangeSet_Range: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.OrderedCollectionChangeSet.Range - - - - -**Enclosing class:** - -:ref:`OrderedCollectionChangeSet ` - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Range ` ( - | **int** startIndex, - | **int** length - | ) - - - Creates a :ref:`Range ` with given start index and length. - - - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public final **int** - - - - :ref:`length ` - - How many elements are inside this range. - - - * - public final **int** - - - - :ref:`startIndex ` - - The start index of this change range. - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_OrderedCollectionChangeSet_Range_length: - - - -``length`` ------------ - -How many elements are inside this range. - - -.. _io_realm_OrderedCollectionChangeSet_Range_startIndex: - - - -``startIndex`` ---------------- - -The start index of this change range. - - - - -Constructor Detail -================== - -.. _Range: - -.. _Range__: - -.. _io_realm_OrderedCollectionChangeSet_Range: - -.. _io_realm_OrderedCollectionChangeSet_Range__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Range ` ( - | **int** startIndex, - | **int** length - | ) - - - - - * - Creates a :ref:`Range ` with given start index and length. - - - - - - - **Parameters** - - - ``startIndex`` - the start index of this change range. - - - - - ``length`` - how many elements are inside this range. - - - - - - - - - - - - - - -Method Detail -============= - -.. _toString: - -.. _toString__: - -.. _Range_toString: - -.. _Range_toString__: - -.. _OrderedCollectionChangeSet_Range_toString: - -.. _OrderedCollectionChangeSet_Range_toString__: - -.. _io_realm_OrderedCollectionChangeSet_Range_toString: - -.. _io_realm_OrderedCollectionChangeSet_Range_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt b/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt deleted file mode 100644 index 9452db3910..0000000000 --- a/source/sdk/java/api/io/realm/OrderedCollectionChangeSet/State.txt +++ /dev/null @@ -1,276 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum OrderedCollectionChangeSet.State -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedCollectionChangeSet_State: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.OrderedCollectionChangeSet.State - - - - -**Enclosing class:** - -:ref:`OrderedCollectionChangeSet ` - - - -State describing the nature of the changeset. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ERROR ` - - This state is used if some error occurred on the background evaluating the query. - - - - - * - :ref:`INITIAL ` - - This state is used first time the callback is invoked. - - - - - * - :ref:`UPDATE ` - - This state is used for every subsequent update after the first. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`OrderedCollectionChangeSet.State ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`OrderedCollectionChangeSet.State ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_OrderedCollectionChangeSet_State_ERROR: - -.. _OrderedCollectionChangeSet_State_ERROR: - - - -``ERROR`` ----------- - -public static final :ref:`OrderedCollectionChangeSet.State ` - -This state is used if some error occurred on the background evaluating the query.For local and fully synchronized Realms, this state should only be encountered if the Realm could not be succesfully opened in the background,. - - - - - -.. _io_realm_OrderedCollectionChangeSet_State_INITIAL: - -.. _OrderedCollectionChangeSet_State_INITIAL: - - - -``INITIAL`` ------------- - -public static final :ref:`OrderedCollectionChangeSet.State ` - -This state is used first time the callback is invoked. The query will have completed and data is ready for the UI. - - - -.. _io_realm_OrderedCollectionChangeSet_State_UPDATE: - -.. _OrderedCollectionChangeSet_State_UPDATE: - - - -``UPDATE`` ------------ - -public static final :ref:`OrderedCollectionChangeSet.State ` - -This state is used for every subsequent update after the first. - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _State_valueOf: - -.. _State_valueOf__: - -.. _OrderedCollectionChangeSet_State_valueOf: - -.. _OrderedCollectionChangeSet_State_valueOf__: - -.. _io_realm_OrderedCollectionChangeSet_State_valueOf: - -.. _io_realm_OrderedCollectionChangeSet_State_valueOf__: - - - -valueOf -------- - -.. _io_realm_OrderedCollectionChangeSet_State_valueOf_java_lang_String_: - -.. _io_realm_OrderedCollectionChangeSet_State_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _OrderedCollectionChangeSet_State_valueOf_java_lang_String_: - -.. _OrderedCollectionChangeSet_State_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`OrderedCollectionChangeSet.State ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _State_values: - -.. _State_values__: - -.. _OrderedCollectionChangeSet_State_values: - -.. _OrderedCollectionChangeSet_State_values__: - -.. _io_realm_OrderedCollectionChangeSet_State_values: - -.. _io_realm_OrderedCollectionChangeSet_State_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`OrderedCollectionChangeSet.State ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollection.txt b/source/sdk/java/api/io/realm/OrderedRealmCollection.txt deleted file mode 100644 index f8535fad28..0000000000 --- a/source/sdk/java/api/io/realm/OrderedRealmCollection.txt +++ /dev/null @@ -1,1330 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface OrderedRealmCollection -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedRealmCollection: - - - -io.realm -======== - -**Implemented interfaces:** - - - -- `java.util.List `__ -- :ref:`io.realm.RealmCollection ` -- `java.util.Collection `__ -- `java.lang.Iterable `__ -- `java.util.Collection `__ -- `java.lang.Iterable `__ - - -An ``OrderedRealmCollection`` is a collection which maintains an ordering for its elements. Every element in the ``OrderedRealmCollection`` has an index. Each element can thus be accessed by its index, with the first index being zero. Normally, ``OrderedRealmCollection`` s allow duplicate elements, as compared to Sets, where elements have to be unique. - -There are three types of :ref:`OrderedRealmCollection ` . :ref:`RealmResults ` and :ref:`RealmList ` are live collections. They are up-to-date all the time and they will never contain an invalid :ref:`RealmObject ` . :ref:`OrderedRealmCollectionSnapshot ` is different. An :ref:`OrderedRealmCollectionSnapshot ` can be created from another :ref:`OrderedRealmCollection ` . Its size and elements order stay the same as the original collection's when it was created. :ref:`OrderedRealmCollectionSnapshot ` may contain invalid :ref:`RealmObject ` s if the objects get deleted. - - - -Using iterators to iterate on :ref:`OrderedRealmCollection ` will always work. You can delete or modify the elements without impacting the iterator. See below example: - - - -.. code-block:: java - - - RealmResults dogs = realm.where(Dog.class).findAll(); - int s = dogs.size(); // 10 - realm.beginTransaction(); - for (Dog dog : dogs) { - dog.deleteFromRealm(); - s = dogs.size(); // This will be decreased by 1 every time after a dog is removed. - } - realm.commitTransaction(); - s = dogs.size(); // 0 - - - - - -An iterator created from a live collection will create a stable view when the iterator is created, allowing you to delete and modify elements while iterating without impacting the iterator. However, the ``RealmResults`` backing the iterator will still be live updated meaning that size and order of elements can change when iterating. :ref:`RealmList ` has the same behaviour as :ref:`RealmResults ` since they are both live collections. - - - -A simple for-loop is different. See below example: - - - -.. code-block:: java - - - RealmResults dogs = realm.where(Dog.class).findAll(); - realm.beginTransaction(); - for (int i = 0; i < dogs.size(); i++) { - dogs.get(i).deleteFromRealm(); - } - realm.commitTransaction(); - s = dogs.size(); // 5 - - - - - -The above example only deletes half of elements in the :ref:`RealmResults ` . This is because of ``dogs.size()`` decreased by 1 for every loop. The deletion happens in the loop will immediately impact the size of ``RealmResults`` . To solve this problem, you can create a :ref:`OrderedRealmCollectionSnapshot ` from the :ref:`RealmResults ` or :ref:`RealmList ` and do simple for-loop on that instead: - - - - - -.. code-block:: java - - - RealmResults dogs = realm.where(Dog.class).findAll(); - OrderedRealmCollectionSnapshot snapshot = dogs.createSnapshot(); - // dogs.size() == 10 && snapshot.size() == 10 - realm.beginTransaction(); - for (int i = 0; i < snapshot.size(); i++) { - snapshot.get(0).deleteFromRealm(); - // snapshot.get(0).isValid() == false - } - realm.commitTransaction(); - // dogs.size() == 0 && snapshot.size() == 10 - - - - - -As you can see, after deletion, the size and elements order of snapshot stay the same as before. But the element at the position becomes invalid. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`OrderedRealmCollectionSnapshot ` - - | :ref:`createSnapshot ` () - | - - - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - * - public **boolean** - - | :ref:`deleteFirstFromRealm ` () - | - - - Deletes the first object from the Realm. - - - - - * - public **void** - - | :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - Deletes the object at the given index from the Realm. - - - - - * - public **boolean** - - | :ref:`deleteLastFromRealm ` () - | - - - Deletes the last object from the Realm. - - - - - * - public **E** - - | :ref:`first ` ( - | **E** defaultValue - | ) - - - Gets the first object from the collection. - - - - - * - public **E** - - | :ref:`first ` () - | - - - Gets the first object from the collection. - - - - - * - public **E** - - | :ref:`last ` ( - | **E** defaultValue - | ) - - - Gets the last object from the collection. - - - - - * - public **E** - - | :ref:`last ` () - | - - - Gets the last object from the collection. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - Sorts a collection based on the provided fields and sort orders. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - Sorts a collection based on the provided fields and sort orders. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - Sorts a collection based on the provided field and sort order. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName - | ) - - - Sorts a collection based on the provided field in ascending order. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _createSnapshot: - -.. _createSnapshot__: - -.. _OrderedRealmCollection_createSnapshot: - -.. _OrderedRealmCollection_createSnapshot__: - -.. _io_realm_OrderedRealmCollection_createSnapshot: - -.. _io_realm_OrderedRealmCollection_createSnapshot__: - - - -createSnapshot --------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedRealmCollectionSnapshot ` :ref:`createSnapshot ` () - | - - - - - * - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - - - **Returns** - - the snapshot of this collection. - - - - - **Throws** - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - - - - `UnsupportedOperationException `__ - if the collection is unmanaged. - - - - - - - - - - .. seealso:: - - - - - :ref:`OrderedRealmCollectionSnapshot ` - - - - - - - - - - - - -.. _deleteFirstFromRealm: - -.. _deleteFirstFromRealm__: - -.. _OrderedRealmCollection_deleteFirstFromRealm: - -.. _OrderedRealmCollection_deleteFirstFromRealm__: - -.. _io_realm_OrderedRealmCollection_deleteFirstFromRealm: - -.. _io_realm_OrderedRealmCollection_deleteFirstFromRealm__: - - - -deleteFirstFromRealm --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteFirstFromRealm ` () - | - - - - - * - Deletes the first object from the Realm. This also removes it from this collection. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. - - - - - `UnsupportedOperationException `__ - if the collection is unmanaged. - - - - - - - - - - - - -.. _deleteFromRealm: - -.. _deleteFromRealm__: - -.. _OrderedRealmCollection_deleteFromRealm: - -.. _OrderedRealmCollection_deleteFromRealm__: - -.. _io_realm_OrderedRealmCollection_deleteFromRealm: - -.. _io_realm_OrderedRealmCollection_deleteFromRealm__: - - - -deleteFromRealm ---------------- - -.. _io_realm_OrderedRealmCollection_deleteFromRealm_int_: - -.. _deleteFromRealm_int_: - -.. _OrderedRealmCollection_deleteFromRealm_int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - - - * - Deletes the object at the given index from the Realm. This also removes it from the collection. - - - - - **Parameters** - - - ``location`` - the array index identifying the object to be removed. - - - - - - - - - - **Throws** - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - - - - `UnsupportedOperationException `__ - if the collection is unmanaged. - - - - - - - - - - - - -.. _deleteLastFromRealm: - -.. _deleteLastFromRealm__: - -.. _OrderedRealmCollection_deleteLastFromRealm: - -.. _OrderedRealmCollection_deleteLastFromRealm__: - -.. _io_realm_OrderedRealmCollection_deleteLastFromRealm: - -.. _io_realm_OrderedRealmCollection_deleteLastFromRealm__: - - - -deleteLastFromRealm -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteLastFromRealm ` () - | - - - - - * - Deletes the last object from the Realm. This also removes it from this collection. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - - - - `UnsupportedOperationException `__ - if the collection is unmanaged. - - - - - - - - - - - - -.. _first: - -.. _first__: - -.. _OrderedRealmCollection_first: - -.. _OrderedRealmCollection_first__: - -.. _io_realm_OrderedRealmCollection_first: - -.. _io_realm_OrderedRealmCollection_first__: - - - -first ------ - -.. _io_realm_OrderedRealmCollection_first_E_: - -.. _first_E_: - -.. _OrderedRealmCollection_first_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`first ` ( - | **E** defaultValue - | ) - - - - - * - Gets the first object from the collection. If the collection is empty, the provided default will be used instead. - - - - - - - **Returns** - - the first object or the provided default. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`first ` () - | - - - - - * - Gets the first object from the collection. - - - - - - - **Returns** - - the first object. - - - - - **Throws** - - - `IndexOutOfBoundsException `__ - if the collection is empty. - - - - - - - - - - - - -.. _last: - -.. _last__: - -.. _OrderedRealmCollection_last: - -.. _OrderedRealmCollection_last__: - -.. _io_realm_OrderedRealmCollection_last: - -.. _io_realm_OrderedRealmCollection_last__: - - - -last ----- - -.. _io_realm_OrderedRealmCollection_last_E_: - -.. _last_E_: - -.. _OrderedRealmCollection_last_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`last ` ( - | **E** defaultValue - | ) - - - - - * - Gets the last object from the collection. If the collection is empty, the provided default will be used instead. - - - - - - - **Returns** - - the last object or the provided default. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`last ` () - | - - - - - * - Gets the last object from the collection. - - - - - - - **Returns** - - the last object. - - - - - **Throws** - - - `IndexOutOfBoundsException `__ - if the collection is empty. - - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _OrderedRealmCollection_sort: - -.. _OrderedRealmCollection_sort__: - -.. _io_realm_OrderedRealmCollection_sort: - -.. _io_realm_OrderedRealmCollection_sort__: - - - -sort ----- - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort____: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort____: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort____: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort____: - -.. _io_realm_OrderedRealmCollection_sort_String____io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_____io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String____Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_____Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String____Sort____: - -.. _io_realm_OrderedRealmCollection_sort_String_____Sort____: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort____: - -.. _sort_java_lang_String__Sort____: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _sort_String_Sort____: - -.. _sort_String__Sort____: - -.. _sort_String____io_realm_Sort_: - -.. _sort_String_____io_realm_Sort_: - -.. _sort_String____Sort_: - -.. _sort_String_____Sort_: - -.. _sort_String____Sort____: - -.. _sort_String_____Sort____: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort____: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort____: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort_: - -.. _OrderedRealmCollection_sort_String_Sort____: - -.. _OrderedRealmCollection_sort_String__Sort____: - -.. _OrderedRealmCollection_sort_String____io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_____io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String____Sort_: - -.. _OrderedRealmCollection_sort_String_____Sort_: - -.. _OrderedRealmCollection_sort_String____Sort____: - -.. _OrderedRealmCollection_sort_String_____Sort____: - -.. _io_realm_OrderedRealmCollection_sort_String[]__Sort[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - - - * - Sorts a collection based on the provided fields and sort orders. - - - - - **Parameters** - - - ``fieldNames`` - an array of field names to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported. - - - - - ``sortOrders`` - the directions to sort by. - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. - - - - - - - - - - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort__String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_String_Sort_: - -.. _sort_java_lang_String__Sort__String__Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_String_Sort_: - -.. _sort_String__io_realm_Sort__String__Sort_: - -.. _sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_Sort_java_lang_String_Sort_: - -.. _sort_String__Sort__java_lang_String__Sort_: - -.. _sort_String_Sort_String_io_realm_Sort_: - -.. _sort_String__Sort__String__io_realm_Sort_: - -.. _sort_String_Sort_String_Sort_: - -.. _sort_String__Sort__String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort__String__Sort_: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_String_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort__String__Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_String_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort__String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - - - * - Sorts a collection based on the provided fields and sort orders. - - - - - **Parameters** - - - ``fieldName1`` - first field name. Only fields of type boolean, short, int, long, float, double, Date, and String are supported. - - - - - ``sortOrder1`` - sort order for first field. - - - - - ``fieldName2`` - second field name. Only fields of type boolean, short, int, long, float, double, Date, and String are supported. - - - - - ``sortOrder2`` - sort order for second field. - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if a field name does not exist or has an invalid type. - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. - - - - - - - - - - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String_Sort_: - -.. _io_realm_OrderedRealmCollection_sort_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String_Sort_: - -.. _OrderedRealmCollection_sort_java_lang_String__Sort_: - -.. _OrderedRealmCollection_sort_String_io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String__io_realm_Sort_: - -.. _OrderedRealmCollection_sort_String_Sort_: - -.. _OrderedRealmCollection_sort_String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - - - * - Sorts a collection based on the provided field and sort order. - - - - - **Parameters** - - - ``fieldName`` - the field name to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported. - - - - - ``sortOrder`` - the direction to sort by. - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if field name does not exist or has an invalid type. - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. - - - - - - - - - - -.. _io_realm_OrderedRealmCollection_sort_java_lang_String_: - -.. _io_realm_OrderedRealmCollection_sort_String_: - -.. _sort_java_lang_String_: - -.. _sort_String_: - -.. _OrderedRealmCollection_sort_java_lang_String_: - -.. _OrderedRealmCollection_sort_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName - | ) - - - - - * - Sorts a collection based on the provided field in ascending order. - - - - - **Parameters** - - - ``fieldName`` - the field name to sort by. Only fields of type boolean, short, int, long, float, double, Date, and String are supported. - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if field name does not exist or it has an invalid type. - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed, called on the wrong thread or the collection is an unmanaged collection. - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt b/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt deleted file mode 100644 index cd20c368fa..0000000000 --- a/source/sdk/java/api/io/realm/OrderedRealmCollectionChangeListener.txt +++ /dev/null @@ -1,153 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface OrderedRealmCollectionChangeListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedRealmCollectionChangeListener: - - - -io.realm -======== - -:ref:`OrderedRealmCollectionChangeListener ` can be registered with a :ref:`RealmResults ` to receive a notification with a :ref:`OrderedCollectionChangeSet ` to describe the details of what have been changed in the collection since last time. - -Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`OrderedRealmCollectionChangeListener ` . - - - - - - -.. seealso:: - - - - - :ref:`RealmResults.addChangeListener(OrderedRealmCollectionChangeListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | **T** t, - | :ref:`OrderedCollectionChangeSet ` changeSet - | ) - - - This will be called when the async query is finished the first time or the collection of objects has changed. - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _OrderedRealmCollectionChangeListener_onChange: - -.. _OrderedRealmCollectionChangeListener_onChange__: - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange: - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange__: - - - -onChange --------- - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange_T_io_realm_OrderedCollectionChangeSet_: - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange_T__io_realm_OrderedCollectionChangeSet_: - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange_T_OrderedCollectionChangeSet_: - -.. _io_realm_OrderedRealmCollectionChangeListener_onChange_T__OrderedCollectionChangeSet_: - -.. _onChange_T_io_realm_OrderedCollectionChangeSet_: - -.. _onChange_T__io_realm_OrderedCollectionChangeSet_: - -.. _onChange_T_OrderedCollectionChangeSet_: - -.. _onChange_T__OrderedCollectionChangeSet_: - -.. _OrderedRealmCollectionChangeListener_onChange_T_io_realm_OrderedCollectionChangeSet_: - -.. _OrderedRealmCollectionChangeListener_onChange_T__io_realm_OrderedCollectionChangeSet_: - -.. _OrderedRealmCollectionChangeListener_onChange_T_OrderedCollectionChangeSet_: - -.. _OrderedRealmCollectionChangeListener_onChange_T__OrderedCollectionChangeSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | **T** t, - | :ref:`OrderedCollectionChangeSet ` changeSet - | ) - - - - - * - This will be called when the async query is finished the first time or the collection of objects has changed. - - - - - **Parameters** - - - ``t`` - the collection this listener is registered to. - - - - - ``changeSet`` - object with information about the change. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt b/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt deleted file mode 100644 index 54e5494e61..0000000000 --- a/source/sdk/java/api/io/realm/OrderedRealmCollectionSnapshot.txt +++ /dev/null @@ -1,1435 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class OrderedRealmCollectionSnapshot -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_OrderedRealmCollectionSnapshot: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ - | **io.realm.OrderedRealmCollectionImpl** - | io.realm.OrderedRealmCollectionSnapshot - - -An :ref:`OrderedRealmCollectionSnapshot ` is a special type of :ref:`OrderedRealmCollection ` . It can be created by calling :ref:`OrderedRealmCollection.createSnapshot() ` . Unlike :ref:`RealmResults ` and :ref:`RealmList ` , its size and order of elements will never be changed after creation. - -:ref:`OrderedRealmCollectionSnapshot ` is useful when making changes which may impact the size or order of the collection in simple loops. For example: - - - - - -.. code-block:: java - - - final RealmResults dogs = realm.where(Dog.class).findAll(); - final OrderedRealmCollectionSnapshot snapshot = dogs.createSnapshot(); - final int dogsCount = snapshot.size(); // dogs.size() == snapshot.size() == 10 - realm.executeTransaction(new Realm.Transaction() { - /@Override - public void execute(Realm realm) { - for (int i = 0; i < dogsCount; i++) { - // This won't work since RealmResults is always up-to-date, its size gets decreased by 1 after every loop. An - // IndexOutOfBoundsException will be thrown after 5 loops. - // dogs.deleteFromRealm(i); - snapshot.deleteFromRealm(i); // Deletion on OrderedRealmCollectionSnapshot won't change the size of it. - } - } - }); - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`OrderedRealmCollectionSnapshot ` - - | :ref:`createSnapshot ` () - | - - - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - * - public **boolean** - - | :ref:`deleteAllFromRealm ` () - | - - - This deletes all objects in the collection from the underlying Realm. - - - - - * - public **boolean** - - | :ref:`deleteFirstFromRealm ` () - | - - - Deletes the first object from the Realm. - - - - - * - public **void** - - | :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - Deletes the object at the given index from the Realm. - - - - - * - public **boolean** - - | :ref:`deleteLastFromRealm ` () - | - - - Deletes the last object from the Realm. - - - - - * - public :ref:`OrderedRealmCollection ` - - | :ref:`freeze ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isFrozen ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - Checks if a collection has finished loading its data yet. - - - - - * - public **boolean** - - | :ref:`load ` () - | - - - Blocks the collection until all data are available. - - - - - * - public **int** - - | :ref:`size ` () - | - - - Returns the number of elements in this query result. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName - | ) - - - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` () - | - - - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` -- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` , ``getCollectionOperator`` - - - - -Method Detail -============= - -.. _createSnapshot: - -.. _createSnapshot__: - -.. _OrderedRealmCollectionSnapshot_createSnapshot: - -.. _OrderedRealmCollectionSnapshot_createSnapshot__: - -.. _io_realm_OrderedRealmCollectionSnapshot_createSnapshot: - -.. _io_realm_OrderedRealmCollectionSnapshot_createSnapshot__: - - - -createSnapshot --------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedRealmCollectionSnapshot ` :ref:`createSnapshot ` () - | - - - - - * - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - - - **Returns** - - the snapshot of this collection. - - - - - - - **Overrides** - - ``createSnapshot`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _deleteAllFromRealm: - -.. _deleteAllFromRealm__: - -.. _OrderedRealmCollectionSnapshot_deleteAllFromRealm: - -.. _OrderedRealmCollectionSnapshot_deleteAllFromRealm__: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteAllFromRealm: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteAllFromRealm__: - - - -deleteAllFromRealm ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteAllFromRealm ` () - | - - - - - * - This deletes all objects in the collection from the underlying Realm. All objects in the collection snapshot will become invalid. - - - - - - - **Returns** - - ``true`` if objects was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - **Overrides** - - ``deleteAllFromRealm`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _deleteFirstFromRealm: - -.. _deleteFirstFromRealm__: - -.. _OrderedRealmCollectionSnapshot_deleteFirstFromRealm: - -.. _OrderedRealmCollectionSnapshot_deleteFirstFromRealm__: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteFirstFromRealm: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteFirstFromRealm__: - - - -deleteFirstFromRealm --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteFirstFromRealm ` () - | - - - - - * - Deletes the first object from the Realm. The first object will become invalid. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called on the wrong thread. - - - - - - - - **Overrides** - - ``deleteFirstFromRealm`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _deleteFromRealm: - -.. _deleteFromRealm__: - -.. _OrderedRealmCollectionSnapshot_deleteFromRealm: - -.. _OrderedRealmCollectionSnapshot_deleteFromRealm__: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteFromRealm: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteFromRealm__: - - - -deleteFromRealm ---------------- - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteFromRealm_int_: - -.. _deleteFromRealm_int_: - -.. _OrderedRealmCollectionSnapshot_deleteFromRealm_int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - - - * - Deletes the object at the given index from the Realm. The object at the given index will become invalid. Just returns if the object is invalid already. - - - - - **Parameters** - - - ``location`` - the array index identifying the object to be removed. - - - - - - - - - - **Throws** - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - - - - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - - - - - - - **Overrides** - - ``deleteFromRealm`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _deleteLastFromRealm: - -.. _deleteLastFromRealm__: - -.. _OrderedRealmCollectionSnapshot_deleteLastFromRealm: - -.. _OrderedRealmCollectionSnapshot_deleteLastFromRealm__: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteLastFromRealm: - -.. _io_realm_OrderedRealmCollectionSnapshot_deleteLastFromRealm__: - - - -deleteLastFromRealm -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteLastFromRealm ` () - | - - - - - * - Deletes the last object from the Realm. The last object will become invalid. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `java.lang.IllegalStateException `__ - if the Realm is closed or the method is called from the wrong thread. - - - - - - - - **Overrides** - - ``deleteLastFromRealm`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _freeze: - -.. _freeze__: - -.. _OrderedRealmCollectionSnapshot_freeze: - -.. _OrderedRealmCollectionSnapshot_freeze__: - -.. _io_realm_OrderedRealmCollectionSnapshot_freeze: - -.. _io_realm_OrderedRealmCollectionSnapshot_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedRealmCollection ` :ref:`freeze ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _OrderedRealmCollectionSnapshot_isFrozen: - -.. _OrderedRealmCollectionSnapshot_isFrozen__: - -.. _io_realm_OrderedRealmCollectionSnapshot_isFrozen: - -.. _io_realm_OrderedRealmCollectionSnapshot_isFrozen__: - - - -isFrozen --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFrozen ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _OrderedRealmCollectionSnapshot_isLoaded: - -.. _OrderedRealmCollectionSnapshot_isLoaded__: - -.. _io_realm_OrderedRealmCollectionSnapshot_isLoaded: - -.. _io_realm_OrderedRealmCollectionSnapshot_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - Checks if a collection has finished loading its data yet. - - - - - - - **Returns** - - ``true`` if data has been loaded and is available, ``false`` if data is still being loaded. - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _OrderedRealmCollectionSnapshot_load: - -.. _OrderedRealmCollectionSnapshot_load__: - -.. _io_realm_OrderedRealmCollectionSnapshot_load: - -.. _io_realm_OrderedRealmCollectionSnapshot_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`load ` () - | - - - - - * - Blocks the collection until all data are available. - - - - - - - **Returns** - - ``true`` if the data could be successfully loaded, ``false`` otherwise. - - - - - - - - - - - - - -.. _size: - -.. _size__: - -.. _OrderedRealmCollectionSnapshot_size: - -.. _OrderedRealmCollectionSnapshot_size__: - -.. _io_realm_OrderedRealmCollectionSnapshot_size: - -.. _io_realm_OrderedRealmCollectionSnapshot_size__: - - - -size ----- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`size ` () - | - - - - - * - Returns the number of elements in this query result. - - - - - - - **Returns** - - the number of elements in this query result. - - - - - - - **Overrides** - - ``size`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _sort: - -.. _sort__: - -.. _OrderedRealmCollectionSnapshot_sort: - -.. _OrderedRealmCollectionSnapshot_sort__: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort__: - - - -sort ----- - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String____io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_____io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String____Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_____Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String____Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_____Sort____: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort____: - -.. _sort_java_lang_String__Sort____: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _sort_String_Sort____: - -.. _sort_String__Sort____: - -.. _sort_String____io_realm_Sort_: - -.. _sort_String_____io_realm_Sort_: - -.. _sort_String____Sort_: - -.. _sort_String_____Sort_: - -.. _sort_String____Sort____: - -.. _sort_String_____Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_String____io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_____io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String____Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_____Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String____Sort____: - -.. _OrderedRealmCollectionSnapshot_sort_String_____Sort____: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String[]__Sort[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - - - * - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . Use 'sort()' on the original :ref:`OrderedRealmCollection ` instead. - - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - - - - - - - - - **Overrides** - - ``sort`` in class **OrderedRealmCollectionImpl** - - - - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort__java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort__String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort__String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_String_Sort_: - -.. _sort_java_lang_String__Sort__String__Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_String_Sort_: - -.. _sort_String__io_realm_Sort__String__Sort_: - -.. _sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_Sort_java_lang_String_Sort_: - -.. _sort_String__Sort__java_lang_String__Sort_: - -.. _sort_String_Sort_String_io_realm_Sort_: - -.. _sort_String__Sort__String__io_realm_Sort_: - -.. _sort_String_Sort_String_Sort_: - -.. _sort_String__Sort__String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort__String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort__String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort__java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort__String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort__String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - - - * - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . Use 'sort()' on the original :ref:`OrderedRealmCollection ` instead. - - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - - - - - - - - - **Overrides** - - ``sort`` in class **OrderedRealmCollectionImpl** - - - - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_Sort_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String__Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__io_realm_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String_Sort_: - -.. _OrderedRealmCollectionSnapshot_sort_String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - - - * - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . Use 'sort()' on the original :ref:`OrderedRealmCollection ` instead. - - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - - - - - - - - - **Overrides** - - ``sort`` in class **OrderedRealmCollectionImpl** - - - - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_java_lang_String_: - -.. _io_realm_OrderedRealmCollectionSnapshot_sort_String_: - -.. _sort_java_lang_String_: - -.. _sort_String_: - -.. _OrderedRealmCollectionSnapshot_sort_java_lang_String_: - -.. _OrderedRealmCollectionSnapshot_sort_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName - | ) - - - - - * - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . Use 'sort()' on the original :ref:`OrderedRealmCollection ` instead. - - - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - - - - - - - - - **Overrides** - - ``sort`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _where: - -.. _where__: - -.. _OrderedRealmCollectionSnapshot_where: - -.. _OrderedRealmCollectionSnapshot_where__: - -.. _io_realm_OrderedRealmCollectionSnapshot_where: - -.. _io_realm_OrderedRealmCollectionSnapshot_where__: - - - -where ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` () - | - - - - - * - Not supported by :ref:`OrderedRealmCollectionSnapshot ` . Use 'where()' on the original :ref:`OrderedRealmCollection ` instead. - - - - - - - - - **Returns** - - a RealmQuery object. - - - - - **Throws** - - - `UnsupportedOperationException `__ - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/ProxyState.txt b/source/sdk/java/api/io/realm/ProxyState.txt deleted file mode 100644 index 960afc9b4c..0000000000 --- a/source/sdk/java/api/io/realm/ProxyState.txt +++ /dev/null @@ -1,1144 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class ProxyState -^^^^^^^^^^^^^^^^ - -.. _io_realm_ProxyState: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.ProxyState - - -This implements ``RealmObjectProxy`` interface, to eliminate copying logic between :ref:`RealmObject ` and :ref:`DynamicRealmObject ` . - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`ProxyState ` () - | - - - - - - - - * - | :ref:`ProxyState ` ( - | **E** model - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - - - - * - public **void** - - | :ref:`checkValidObject ` ( - | :ref:`RealmModel ` value - | ) - - - Check that object is a valid and managed object by this Realm. - - - - - * - public **boolean** - - | :ref:`getAcceptDefaultValue$realm ` () - | - - - - - - - - * - public `List `__ - - | :ref:`getExcludeFields$realm ` () - | - - - - - - - - * - public **BaseRealm** - - | :ref:`getRealm$realm ` () - | - - - - - - - - * - public **Row** - - | :ref:`getRow$realm ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isUnderConstruction ` () - | - - - - - - - - * - public **void** - - | :ref:`load ` () - | - - - - - - - - * - public **void** - - | :ref:`onQueryFinished ` ( - | **Row** row - | ) - - - - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - - - - * - public **void** - - | :ref:`setAcceptDefaultValue$realm ` ( - | **boolean** acceptDefaultValue - | ) - - - - - - - - * - public **void** - - | :ref:`setConstructionFinished ` () - | - - - - - - - - * - public **void** - - | :ref:`setExcludeFields$realm ` ( - | `java.util.List\ `__ excludeFields - | ) - - - - - - - - * - public **void** - - | :ref:`setRealm$realm ` ( - | **BaseRealm** realm - | ) - - - - - - - - * - public **void** - - | :ref:`setRow$realm ` ( - | **Row** row - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _ProxyState: - -.. _ProxyState__: - -.. _io_realm_ProxyState: - -.. _io_realm_ProxyState__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ProxyState ` () - | - - - - - * - - - - - - - - - - - - -.. _ProxyState: - -.. _ProxyState__: - -.. _io_realm_ProxyState: - -.. _io_realm_ProxyState__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ProxyState ` ( - | **E** model - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _ProxyState_addChangeListener: - -.. _ProxyState_addChangeListener__: - -.. _io_realm_ProxyState_addChangeListener: - -.. _io_realm_ProxyState_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_ProxyState_addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _io_realm_ProxyState_addChangeListener_RealmObjectChangeListener_: - -.. _addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_RealmObjectChangeListener_: - -.. _ProxyState_addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _ProxyState_addChangeListener_RealmObjectChangeListener_: - -.. _io_realm_ProxyState_addChangeListener_RealmObjectChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _checkValidObject: - -.. _checkValidObject__: - -.. _ProxyState_checkValidObject: - -.. _ProxyState_checkValidObject__: - -.. _io_realm_ProxyState_checkValidObject: - -.. _io_realm_ProxyState_checkValidObject__: - - - -checkValidObject ----------------- - -.. _io_realm_ProxyState_checkValidObject_io_realm_RealmModel_: - -.. _io_realm_ProxyState_checkValidObject_RealmModel_: - -.. _checkValidObject_io_realm_RealmModel_: - -.. _checkValidObject_RealmModel_: - -.. _ProxyState_checkValidObject_io_realm_RealmModel_: - -.. _ProxyState_checkValidObject_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`checkValidObject ` ( - | :ref:`RealmModel ` value - | ) - - - - - * - Check that object is a valid and managed object by this Realm. Used by proxy classes to verify input. - - - - - **Parameters** - - - ``value`` - model object - - - - - - - - - - - - - - - - -.. _getAcceptDefaultValue_realm: - -.. _getAcceptDefaultValue_realm__: - -.. _ProxyState_getAcceptDefaultValue_realm: - -.. _ProxyState_getAcceptDefaultValue_realm__: - -.. _io_realm_ProxyState_getAcceptDefaultValue_realm: - -.. _io_realm_ProxyState_getAcceptDefaultValue_realm__: - - - -getAcceptDefaultValue$realm ---------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`getAcceptDefaultValue$realm ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getExcludeFields_realm: - -.. _getExcludeFields_realm__: - -.. _ProxyState_getExcludeFields_realm: - -.. _ProxyState_getExcludeFields_realm__: - -.. _io_realm_ProxyState_getExcludeFields_realm: - -.. _io_realm_ProxyState_getExcludeFields_realm__: - - - -getExcludeFields$realm ----------------------- - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`getExcludeFields$realm ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getRealm_realm: - -.. _getRealm_realm__: - -.. _ProxyState_getRealm_realm: - -.. _ProxyState_getRealm_realm__: - -.. _io_realm_ProxyState_getRealm_realm: - -.. _io_realm_ProxyState_getRealm_realm__: - - - -getRealm$realm --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BaseRealm** :ref:`getRealm$realm ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getRow_realm: - -.. _getRow_realm__: - -.. _ProxyState_getRow_realm: - -.. _ProxyState_getRow_realm__: - -.. _io_realm_ProxyState_getRow_realm: - -.. _io_realm_ProxyState_getRow_realm__: - - - -getRow$realm ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **Row** :ref:`getRow$realm ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _ProxyState_isLoaded: - -.. _ProxyState_isLoaded__: - -.. _io_realm_ProxyState_isLoaded: - -.. _io_realm_ProxyState_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isUnderConstruction: - -.. _isUnderConstruction__: - -.. _ProxyState_isUnderConstruction: - -.. _ProxyState_isUnderConstruction__: - -.. _io_realm_ProxyState_isUnderConstruction: - -.. _io_realm_ProxyState_isUnderConstruction__: - - - -isUnderConstruction -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isUnderConstruction ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _ProxyState_load: - -.. _ProxyState_load__: - -.. _io_realm_ProxyState_load: - -.. _io_realm_ProxyState_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`load ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _onQueryFinished: - -.. _onQueryFinished__: - -.. _ProxyState_onQueryFinished: - -.. _ProxyState_onQueryFinished__: - -.. _io_realm_ProxyState_onQueryFinished: - -.. _io_realm_ProxyState_onQueryFinished__: - - - -onQueryFinished ---------------- - -.. _io_realm_ProxyState_onQueryFinished_Row_: - -.. _onQueryFinished_Row_: - -.. _ProxyState_onQueryFinished_Row_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onQueryFinished ` ( - | **Row** row - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _ProxyState_removeAllChangeListeners: - -.. _ProxyState_removeAllChangeListeners__: - -.. _io_realm_ProxyState_removeAllChangeListeners: - -.. _io_realm_ProxyState_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _ProxyState_removeChangeListener: - -.. _ProxyState_removeChangeListener__: - -.. _io_realm_ProxyState_removeChangeListener: - -.. _io_realm_ProxyState_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_ProxyState_removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _io_realm_ProxyState_removeChangeListener_RealmObjectChangeListener_: - -.. _removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_RealmObjectChangeListener_: - -.. _ProxyState_removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _ProxyState_removeChangeListener_RealmObjectChangeListener_: - -.. _io_realm_ProxyState_removeChangeListener_RealmObjectChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setAcceptDefaultValue_realm: - -.. _setAcceptDefaultValue_realm__: - -.. _ProxyState_setAcceptDefaultValue_realm: - -.. _ProxyState_setAcceptDefaultValue_realm__: - -.. _io_realm_ProxyState_setAcceptDefaultValue_realm: - -.. _io_realm_ProxyState_setAcceptDefaultValue_realm__: - - - -setAcceptDefaultValue$realm ---------------------------- - -.. _io_realm_ProxyState_setAcceptDefaultValue_realm_boolean_: - -.. _setAcceptDefaultValue_realm_boolean_: - -.. _ProxyState_setAcceptDefaultValue_realm_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setAcceptDefaultValue$realm ` ( - | **boolean** acceptDefaultValue - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setConstructionFinished: - -.. _setConstructionFinished__: - -.. _ProxyState_setConstructionFinished: - -.. _ProxyState_setConstructionFinished__: - -.. _io_realm_ProxyState_setConstructionFinished: - -.. _io_realm_ProxyState_setConstructionFinished__: - - - -setConstructionFinished ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setConstructionFinished ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _setExcludeFields_realm: - -.. _setExcludeFields_realm__: - -.. _ProxyState_setExcludeFields_realm: - -.. _ProxyState_setExcludeFields_realm__: - -.. _io_realm_ProxyState_setExcludeFields_realm: - -.. _io_realm_ProxyState_setExcludeFields_realm__: - - - -setExcludeFields$realm ----------------------- - -.. _io_realm_ProxyState_setExcludeFields_realm_java_util_List_: - -.. _io_realm_ProxyState_setExcludeFields_realm_List_: - -.. _setExcludeFields_realm_java_util_List_: - -.. _setExcludeFields_realm_List_: - -.. _ProxyState_setExcludeFields_realm_java_util_List_: - -.. _ProxyState_setExcludeFields_realm_List_: - -.. _io_realm_ProxyState_setExcludeFields_realm_List_String__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setExcludeFields$realm ` ( - | `java.util.List\ `__ excludeFields - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setRealm_realm: - -.. _setRealm_realm__: - -.. _ProxyState_setRealm_realm: - -.. _ProxyState_setRealm_realm__: - -.. _io_realm_ProxyState_setRealm_realm: - -.. _io_realm_ProxyState_setRealm_realm__: - - - -setRealm$realm --------------- - -.. _io_realm_ProxyState_setRealm_realm_io_realm_BaseRealm_: - -.. _io_realm_ProxyState_setRealm_realm_BaseRealm_: - -.. _setRealm_realm_io_realm_BaseRealm_: - -.. _setRealm_realm_BaseRealm_: - -.. _ProxyState_setRealm_realm_io_realm_BaseRealm_: - -.. _ProxyState_setRealm_realm_BaseRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setRealm$realm ` ( - | **BaseRealm** realm - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setRow_realm: - -.. _setRow_realm__: - -.. _ProxyState_setRow_realm: - -.. _ProxyState_setRow_realm__: - -.. _io_realm_ProxyState_setRow_realm: - -.. _io_realm_ProxyState_setRow_realm__: - - - -setRow$realm ------------- - -.. _io_realm_ProxyState_setRow_realm_Row_: - -.. _setRow_realm_Row_: - -.. _ProxyState_setRow_realm_Row_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setRow$realm ` ( - | **Row** row - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm.txt b/source/sdk/java/api/io/realm/Realm.txt deleted file mode 100644 index aef7399019..0000000000 --- a/source/sdk/java/api/io/realm/Realm.txt +++ /dev/null @@ -1,6104 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Realm -^^^^^^^^^^^ - -.. _io_realm_Realm: - - - -io.realm -======== - - - | `java.lang.Object `__ - | **io.realm.BaseRealm** - | io.realm.Realm - - -The Realm class is the storage and transactional manager of your object persistent store. It is in charge of creating instances of your RealmObjects. Objects within a Realm can be queried and read at any time. Creating, modifying, and deleting objects must be done while inside a transaction. See :ref:`executeTransaction(Transaction) ` - -The transactions ensure that multiple instances (on multiple threads) can access the same objects in a consistent state with full ACID guarantees. - -It is important to remember to call the **close()** method when done with a Realm instance. Failing to do so can lead to `java.lang.OutOfMemoryError `__ as the native resources cannot be freed. - - - -Realm instances cannot be used across different threads. This means that you have to open an instance on each thread you want to use Realm. Realm instances are cached automatically per thread using reference counting, so as long as the reference count doesn't reach zero, calling :ref:`getInstance(RealmConfiguration) ` will just return the cached Realm and should be considered a lightweight operation. - - - -For the UI thread this means that opening and closing Realms should occur in either onCreate/onDestroy or onStart/onStop. - -Realm instances coordinate their state across threads using the `android.os.Handler `__ mechanism. This also means that Realm instances on threads without an `android.os.Looper `__ cannot receive updates unless **refresh()** is manually called. - - - -A standard pattern for working with Realm in Android activities can be seen below: - - - -.. code-block:: java - - public class RealmApplication extends Application { - - @Override - public void onCreate() { - super.onCreate(); - - // The Realm file will be located in package's "files" directory. - RealmConfiguration realmConfig = new RealmConfiguration.Builder(this).build(); - Realm.setDefaultConfiguration(realmConfig); - } - } - - public class RealmActivity extends Activity { - - private Realm realm; - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - setContentView(R.layout.layout_main); - realm = Realm.getDefaultInstance(); - } - - @Override - protected void onDestroy() { - super.onDestroy(); - realm.close(); - } - } - - -Realm supports String and byte fields containing up to 16 MB. - - - - -.. seealso:: - - - - - `ACID `__ - - - - - - `Examples using Realm `__ - - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static interface`` - - :ref:`Realm.Transaction ` - - - * - ``public abstract static`` - - :ref:`Realm.Callback ` - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`DEFAULT_REALM_NAME ` - - - - - * - public static final **int** - - - - :ref:`ENCRYPTION_KEY_LENGTH ` - - The required length for encryption keys used to encrypt Realm data. - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Adds a change listener to the Realm. - - - - - * - public **** - - | :ref:`asFlowable ` () - | - - - Returns an RxJava Flowable that monitors changes to this Realm. - - - - - * - public static **boolean** - - | :ref:`compactRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Compacts a Realm file. - - - - - * - public **E** - - | :ref:`copyFromRealm ` <**E** >( - | **E** realmObject, - | **int** maxDepth - | ) - - - Makes an unmanaged in-memory copy of an already persisted :ref:`RealmObject ` . - - - - - - - * - public **E** - - | :ref:`copyFromRealm ` <**E** >( - | **E** realmObject - | ) - - - Makes an unmanaged in-memory copy of an already persisted :ref:`RealmObject ` . - - - - - - - * - public `List `__ - - | :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects, - | **int** maxDepth - | ) - - - Makes an unmanaged in-memory copy of already persisted RealmObjects. - - - - - * - public `List `__ - - | :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects - | ) - - - Makes an unmanaged in-memory copy of already persisted RealmObjects. - - - - - * - public `List `__ - - | :ref:`copyToRealm ` <**E** >( - | `java.lang.Iterable\ `__ objects, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - Copies a collection of RealmObjects to the Realm instance and returns their copy. - - - - - * - public **E** - - | :ref:`copyToRealm ` <**E** >( - | **E** object, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - Copies a RealmObject to the Realm instance and returns the copy. - - - - - * - public `List `__ - - | :ref:`copyToRealmOrUpdate ` <**E** >( - | `java.lang.Iterable\ `__ objects, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - Updates a list of existing RealmObjects that is identified by their :ref:`io.realm.annotations.PrimaryKey ` or creates a new copy if no existing object could be found. - - - - - - - * - public **E** - - | :ref:`copyToRealmOrUpdate ` <**E** >( - | **E** object, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - Updates an existing RealmObject that is identified by the same :ref:`io.realm.annotations.PrimaryKey ` or creates a new copy if no existing object could be found. - - - - - - - * - public **void** - - | :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - Creates a Realm object for each object in a JSON array. - - - - - * - public **E** - - | :ref:`createEmbeddedObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | :ref:`RealmModel ` parentObject, - | `String `__ parentProperty - | ) - - - Instantiates and adds a new embedded object to the Realm. - - - - - * - public **E** - - | :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `Object `__ primaryKeyValue - | ) - - - Instantiates and adds a new object to the Realm with the primary key value already set. - - - - - * - public **E** - - | :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz - | ) - - - Instantiates and adds a new object to the Realm. - - - - - * - public **E** - - | :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONObject** json - | ) - - - Creates a Realm object pre-filled with data from a JSON object. - - - - - * - public **void** - - | :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - Tries to update a list of existing objects identified by their primary key with new JSON data. - - - - - * - public **E** - - | :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONObject** json - | ) - - - Tries to update an existing object defined by its primary key with new JSON data. - - - - - * - public **void** - - | :ref:`delete ` ( - | `java.lang.Class\ `__ clazz - | ) - - - Deletes all objects of the specified class from the Realm. - - - - - * - public static **boolean** - - | :ref:`deleteRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Deletes the Realm file along with the related temporary files specified by the given :ref:`RealmConfiguration ` from the filesystem. - - - - - - - * - public **void** - - | :ref:`executeTransaction ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - Executes a given transaction on the Realm. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnSuccess ` onSuccess, - | :ref:`Realm.Transaction.OnError ` onError - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess and OnError callbacks. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnError ` onError - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnError callback. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnSuccess ` onSuccess - | ) - - - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess callback. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - Similar to :ref:`executeTransaction(Transaction) ` but runs asynchronously on a worker thread. - - - - - - - * - public :ref:`Realm ` - - | :ref:`freeze ` () - | - - - Returns a frozen snapshot of the current Realm. - - - - - * - public static **Context** - - | :ref:`getApplicationContext ` () - | - - - Get the application context used when initializing Realm with :ref:`Realm.init(Context) ` or :ref:`Realm.init(Context, String) ` . - - - - - - - * - public static :ref:`RealmConfiguration ` - - | :ref:`getDefaultConfiguration ` () - | - - - Returns the default configuration for :ref:`getDefaultInstance() ` . - - - - - - - * - public static :ref:`Realm ` - - | :ref:`getDefaultInstance ` () - | - - - Realm static constructor that returns the Realm instance defined by the :ref:`io.realm.RealmConfiguration ` set by :ref:`setDefaultConfiguration(RealmConfiguration) ` - - - - - - - * - public static `Object `__ - - | :ref:`getDefaultModule ` () - | - - - Returns the default Realm module. - - - - - * - public static **int** - - | :ref:`getGlobalInstanceCount ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Returns the current number of open Realm instances across all threads in current process that are using this configuration. - - - - - * - public static :ref:`Realm ` - - | :ref:`getInstance ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Realm static constructor that returns the Realm instance defined by provided :ref:`io.realm.RealmConfiguration ` - - - - - - - * - public static :ref:`RealmAsyncTask ` - - | :ref:`getInstanceAsync ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`Realm.Callback ` callback - | ) - - - The creation of the first Realm instance per :ref:`RealmConfiguration ` in a process can take some time as all initialization code need to run at that point (setting up the Realm, validating schemas and creating initial data). - - - - - - - * - public static **int** - - | :ref:`getLocalInstanceCount ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Returns the current number of open Realm instances on the thread calling this method. - - - - - * - public :ref:`RealmSchema ` - - | :ref:`getSchema ` () - | - - - Returns the schema for this Realm. - - - - - * - public static synchronized **void** - - | :ref:`init ` ( - | **Context** context, - | `String `__ userAgent - | ) - - - Initializes the Realm library and creates a default configuration that is ready to use. - - - - - * - public static synchronized **void** - - | :ref:`init ` ( - | **Context** context - | ) - - - Initializes the Realm library and creates a default configuration that is ready to use. - - - - - * - public **void** - - | :ref:`insert ` ( - | :ref:`RealmModel ` object - | ) - - - Inserts an unmanaged RealmObject. - - - - - * - public **void** - - | :ref:`insert ` ( - | `java.util.Collection\ `__ objects - | ) - - - Inserts a list of an unmanaged RealmObjects. - - - - - * - public **void** - - | :ref:`insertOrUpdate ` ( - | :ref:`RealmModel ` object - | ) - - - Inserts or updates an unmanaged RealmObject. - - - - - * - public **void** - - | :ref:`insertOrUpdate ` ( - | `java.util.Collection\ `__ objects - | ) - - - Inserts or updates a list of unmanaged RealmObjects. - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - Checks if this :ref:`io.realm.Realm ` contains any objects. - - - - - - - * - public static **void** - - | :ref:`migrateRealm ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`RealmMigration ` migration - | ) - - - Manually triggers a migration on a RealmMigration. - - - - - * - public static **void** - - | :ref:`migrateRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Manually triggers the migration associated with a given RealmConfiguration. - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Removes the specified change listener. - - - - - * - public static **void** - - | :ref:`removeDefaultConfiguration ` () - | - - - Removes the current default configuration (if any). - - - - - * - public static **void** - - | :ref:`setDefaultConfiguration ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - Sets the :ref:`io.realm.RealmConfiguration ` used when calling :ref:`getDefaultInstance() ` . - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` <**E** >( - | `java.lang.Class\ `__ clazz - | ) - - - Returns a typed RealmQuery, which can be used to query for specific objects of this type - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm**: ``setAutoRefresh`` , ``isAutoRefresh`` , ``refresh`` , ``isInTransaction`` , ``addListener`` , ``removeListener`` , ``asFlowable`` , ``removeAllListeners`` , ``writeCopyTo`` , ``writeEncryptedCopyTo`` , ``waitForChange`` , ``stopWaitForChange`` , ``beginTransaction`` , ``commitTransaction`` , ``cancelTransaction`` , ``freeze`` , ``isFrozen`` , ``getNumberOfActiveVersions`` , ``checkIfValid`` , ``checkAllowQueriesOnUiThread`` , ``checkAllowWritesOnUiThread`` , ``checkIfInTransaction`` , ``checkIfValidAndInTransaction`` , ``getPath`` , ``getConfiguration`` , ``getVersion`` , ``close`` , ``isClosed`` , ``isEmpty`` , ``getSchema`` , ``getSubscriptions`` , ``deleteAll`` , ``migrateRealm`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_Realm_DEFAULT_REALM_NAME: - - - -``DEFAULT_REALM_NAME`` ------------------------ - - - - -.. _io_realm_Realm_ENCRYPTION_KEY_LENGTH: - - - -``ENCRYPTION_KEY_LENGTH`` --------------------------- - -The required length for encryption keys used to encrypt Realm data. - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _Realm_addChangeListener: - -.. _Realm_addChangeListener__: - -.. _io_realm_Realm_addChangeListener: - -.. _io_realm_Realm_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_Realm_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_Realm_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _Realm_addChangeListener_io_realm_RealmChangeListener_: - -.. _Realm_addChangeListener_RealmChangeListener_: - -.. _io_realm_Realm_addChangeListener_RealmChangeListener_Realm__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to the Realm.The listeners will be executed when changes are committed by this or another thread. - - Realm instances are per thread singletons and cached, so listeners should be removed manually even if calling **close()**. Otherwise there is a risk of memory leaks. - - - - - - - - - **Parameters** - - - ``listener`` - the change listener. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to register a listener from a non-Looper or **IntentService** thread. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - :ref:`removeChangeListener(RealmChangeListener) ` - - - - - :ref:`removeAllChangeListeners() ` - - - - - - - - - - - - -.. _asFlowable: - -.. _asFlowable__: - -.. _Realm_asFlowable: - -.. _Realm_asFlowable__: - -.. _io_realm_Realm_asFlowable: - -.. _io_realm_Realm_asFlowable__: - - - -asFlowable ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asFlowable ` () - | - - - - - * - Returns an RxJava Flowable that monitors changes to this Realm. It will emit the current state when subscribed to. Items will continually be emitted as the Realm is updated - ``onComplete`` will never be called. - - Items emitted from Realm Flowables are frozen (See **freeze()**. This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - realm.asFlowable() - .observeOn(Schedulers.computation()) - .map(rxRealm -> doExpensiveWork(rxRealm)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items, you can instruct RxJava to only emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - realm.asFlowable().first().subscribe( ... ); // You only get the results once - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - - - **Overrides** - - ``asFlowable`` in class **BaseRealm** - - - - - - -.. _compactRealm: - -.. _compactRealm__: - -.. _Realm_compactRealm: - -.. _Realm_compactRealm__: - -.. _io_realm_Realm_compactRealm: - -.. _io_realm_Realm_compactRealm__: - - - -compactRealm ------------- - -.. _io_realm_Realm_compactRealm_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_compactRealm_RealmConfiguration_: - -.. _compactRealm_io_realm_RealmConfiguration_: - -.. _compactRealm_RealmConfiguration_: - -.. _Realm_compactRealm_io_realm_RealmConfiguration_: - -.. _Realm_compactRealm_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`compactRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Compacts a Realm file. A Realm file usually contain free/unused space. This method removes this free space and the file size is thereby reduced. Objects within the Realm files are untouched.The file must be closed before this method is called, otherwise ``false`` will be returned. - - - | The file system should have free space for at least a copy of the Realm file. - | The Realm file is left untouched if any file operation fails. - | - - - - - - - **Parameters** - - - ``configuration`` - a :ref:`RealmConfiguration ` pointing to a Realm file. - - - - - - - - - - **Returns** - - ``true`` if successful, ``false`` if any file operation failed. - - - - - - - - - - - - - -.. _copyFromRealm: - -.. _copyFromRealm__: - -.. _Realm_copyFromRealm: - -.. _Realm_copyFromRealm__: - -.. _io_realm_Realm_copyFromRealm: - -.. _io_realm_Realm_copyFromRealm__: - - - -copyFromRealm -------------- - -.. _io_realm_Realm_copyFromRealm_E_int_: - -.. _io_realm_Realm_copyFromRealm_E__int_: - -.. _io_realm_Realm_copyFromRealm_RealmModel_int_: - -.. _io_realm_Realm_copyFromRealm_RealmModel__int_: - -.. _copyFromRealm_E_int_: - -.. _copyFromRealm_E__int_: - -.. _copyFromRealm_RealmModel_int_: - -.. _copyFromRealm_RealmModel__int_: - -.. _Realm_copyFromRealm_E_int_: - -.. _Realm_copyFromRealm_E__int_: - -.. _Realm_copyFromRealm_RealmModel_int_: - -.. _Realm_copyFromRealm_RealmModel__int_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`copyFromRealm ` <**E** >( - | **E** realmObject, - | **int** maxDepth - | ) - - - - - * - Makes an unmanaged in-memory copy of an already persisted :ref:`RealmObject ` . This is a deep copy that will copy all referenced objects up to the defined depth. - - The copied object(s) are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects. - - \*WARNING\*: Any changes to copied objects can be merged back into Realm using :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` , but all fields will be overridden, not just those that were changed. This includes references to other objects even though they might be ``null`` due to ``maxDepth`` being reached. This can also potentially override changes made by other threads. This behaviour can be modified using :ref:`ImportFlag ` s. - - - - - - - **Type Parameters** - - - ``E`` - type of object. - - - - - - - - **Parameters** - - - ``realmObject`` - :ref:`RealmObject ` to copy. - - - - - - - ``maxDepth`` - limit of the deep copy. All references after this depth will be ``null`` . Starting depth is ``0`` . - - - - - - - - - - **Returns** - - an in-memory detached copy of the managed :ref:`RealmObject ` . - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` - - - - - - - - - - -.. _io_realm_Realm_copyFromRealm_E_: - -.. _io_realm_Realm_copyFromRealm_RealmModel_: - -.. _copyFromRealm_E_: - -.. _copyFromRealm_RealmModel_: - -.. _Realm_copyFromRealm_E_: - -.. _Realm_copyFromRealm_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`copyFromRealm ` <**E** >( - | **E** realmObject - | ) - - - - - * - Makes an unmanaged in-memory copy of an already persisted :ref:`RealmObject ` . This is a deep copy that will copy all referenced objects. - - The copied object(s) are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects. - - \*WARNING\*: Any changes to copied objects can be merged back into Realm using :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` , but all fields will be overridden, not just those that were changed. This includes references to other objects, and can potentially override changes made by other threads. This behaviour can be modified using :ref:`ImportFlag ` s. - - - - - - - **Type Parameters** - - - ``E`` - type of object. - - - - - - - - **Parameters** - - - ``realmObject`` - :ref:`RealmObject ` to copy. - - - - - - - - - - **Returns** - - an in-memory detached copy of the managed :ref:`RealmObject ` . - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` - - - - - - - - - - -.. _io_realm_Realm_copyFromRealm_java_lang_Iterable_int_: - -.. _io_realm_Realm_copyFromRealm_java_lang_Iterable__int_: - -.. _io_realm_Realm_copyFromRealm_Iterable_int_: - -.. _io_realm_Realm_copyFromRealm_Iterable__int_: - -.. _copyFromRealm_java_lang_Iterable_int_: - -.. _copyFromRealm_java_lang_Iterable__int_: - -.. _copyFromRealm_Iterable_int_: - -.. _copyFromRealm_Iterable__int_: - -.. _Realm_copyFromRealm_java_lang_Iterable_int_: - -.. _Realm_copyFromRealm_java_lang_Iterable__int_: - -.. _Realm_copyFromRealm_Iterable_int_: - -.. _Realm_copyFromRealm_Iterable__int_: - -.. _io_realm_Realm_copyFromRealm_Iterable_E___int_: - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects, - | **int** maxDepth - | ) - - - - - * - Makes an unmanaged in-memory copy of already persisted RealmObjects. This is a deep copy that will copy all referenced objects up to the defined depth.The copied objects are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects. - - \*WARNING\*: Any changes to copied objects can be merged back into Realm using :ref:`copyToRealmOrUpdate(Iterable, ImportFlag...) ` , but all fields will be overridden, not just those that were changed. This includes references to other objects even though they might be ``null`` due to ``maxDepth`` being reached. This can also potentially override changes made by other threads. This behaviour can be modified using :ref:`ImportFlag ` s. - - - - - - - **Type Parameters** - - - ``E`` - type of object. - - - - - - - - **Parameters** - - - ``realmObjects`` - RealmObjects to copy. - - - - - ``maxDepth`` - limit of the deep copy. All references after this depth will be ``null`` . Starting depth is ``0`` . - - - - - - - - - - **Returns** - - an in-memory detached copy of the RealmObjects. - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``maxDepth < 0`` , the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(Iterable, ImportFlag...) ` - - - - - - - - - - -.. _io_realm_Realm_copyFromRealm_java_lang_Iterable_: - -.. _io_realm_Realm_copyFromRealm_Iterable_: - -.. _copyFromRealm_java_lang_Iterable_: - -.. _copyFromRealm_Iterable_: - -.. _Realm_copyFromRealm_java_lang_Iterable_: - -.. _Realm_copyFromRealm_Iterable_: - -.. _io_realm_Realm_copyFromRealm_Iterable_E__: - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`copyFromRealm ` <**E** >( - | `java.lang.Iterable\ `__ realmObjects - | ) - - - - - * - Makes an unmanaged in-memory copy of already persisted RealmObjects. This is a deep copy that will copy all referenced objects.The copied objects are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects. - - \*WARNING\*: Any changes to copied objects can be merged back into Realm using :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` , but all fields will be overridden, not just those that were changed. This includes references to other objects, and can potentially override changes made by other threads. This behaviour can be modified using :ref:`ImportFlag ` s. - - - - - - - **Type Parameters** - - - ``E`` - type of object. - - - - - - - - **Parameters** - - - ``realmObjects`` - RealmObjects to copy. - - - - - - - - **Returns** - - an in-memory detached copy of managed RealmObjects. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the RealmObject is no longer accessible or it is a :ref:`DynamicRealmObject ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealmOrUpdate(Iterable, ImportFlag...) ` - - - - - - - - - - - - -.. _copyToRealm: - -.. _copyToRealm__: - -.. _Realm_copyToRealm: - -.. _Realm_copyToRealm__: - -.. _io_realm_Realm_copyToRealm: - -.. _io_realm_Realm_copyToRealm__: - - - -copyToRealm ------------ - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable__ImportFlag_: - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable_ImportFlag____: - -.. _io_realm_Realm_copyToRealm_java_lang_Iterable__ImportFlag____: - -.. _io_realm_Realm_copyToRealm_Iterable_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_Iterable__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_Iterable_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_Iterable__ImportFlag_: - -.. _io_realm_Realm_copyToRealm_Iterable_ImportFlag____: - -.. _io_realm_Realm_copyToRealm_Iterable__ImportFlag____: - -.. _copyToRealm_java_lang_Iterable_io_realm_ImportFlag_: - -.. _copyToRealm_java_lang_Iterable__io_realm_ImportFlag_: - -.. _copyToRealm_java_lang_Iterable_ImportFlag_: - -.. _copyToRealm_java_lang_Iterable__ImportFlag_: - -.. _copyToRealm_java_lang_Iterable_ImportFlag____: - -.. _copyToRealm_java_lang_Iterable__ImportFlag____: - -.. _copyToRealm_Iterable_io_realm_ImportFlag_: - -.. _copyToRealm_Iterable__io_realm_ImportFlag_: - -.. _copyToRealm_Iterable_ImportFlag_: - -.. _copyToRealm_Iterable__ImportFlag_: - -.. _copyToRealm_Iterable_ImportFlag____: - -.. _copyToRealm_Iterable__ImportFlag____: - -.. _Realm_copyToRealm_java_lang_Iterable_io_realm_ImportFlag_: - -.. _Realm_copyToRealm_java_lang_Iterable__io_realm_ImportFlag_: - -.. _Realm_copyToRealm_java_lang_Iterable_ImportFlag_: - -.. _Realm_copyToRealm_java_lang_Iterable__ImportFlag_: - -.. _Realm_copyToRealm_java_lang_Iterable_ImportFlag____: - -.. _Realm_copyToRealm_java_lang_Iterable__ImportFlag____: - -.. _Realm_copyToRealm_Iterable_io_realm_ImportFlag_: - -.. _Realm_copyToRealm_Iterable__io_realm_ImportFlag_: - -.. _Realm_copyToRealm_Iterable_ImportFlag_: - -.. _Realm_copyToRealm_Iterable__ImportFlag_: - -.. _Realm_copyToRealm_Iterable_ImportFlag____: - -.. _Realm_copyToRealm_Iterable__ImportFlag____: - -.. _io_realm_Realm_copyToRealm_Iterable_E___ImportFlag____: - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`copyToRealm ` <**E** >( - | `java.lang.Iterable\ `__ objects, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - - - * - Copies a collection of RealmObjects to the Realm instance and returns their copy. Any further changes to the original RealmObjects will not be reflected in the Realm copies. This is a deep copy i.e., all referenced objects will be copied. Objects already in this Realm will be ignored.Please note, copying an object will copy all field values. Any unset field in the objects and child objects will be set to their default value if not provided. - - - - - - - **Parameters** - - - ``objects`` - the RealmObjects to copy to the Realm. - - - - - ``flags`` - any flag that modifies the behaviour of inserting the data into the Realm. - - - - - - - - **Returns** - - a list of the the converted RealmObjects that all has their properties managed by the Realm. - - - - - **Throws** - - - :ref:`io.realm.exceptions.RealmException ` - if any of the objects has already been added to Realm. - - - - - `java.lang.IllegalArgumentException `__ - if any of the elements in the input collection is ``null`` . - - - - - - - - - - - - -.. _io_realm_Realm_copyToRealm_E_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_E__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_E_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_E__ImportFlag_: - -.. _io_realm_Realm_copyToRealm_E_ImportFlag____: - -.. _io_realm_Realm_copyToRealm_E__ImportFlag____: - -.. _io_realm_Realm_copyToRealm_RealmModel_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_RealmModel__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_RealmModel_ImportFlag_: - -.. _io_realm_Realm_copyToRealm_RealmModel__ImportFlag_: - -.. _io_realm_Realm_copyToRealm_RealmModel_ImportFlag____: - -.. _io_realm_Realm_copyToRealm_RealmModel__ImportFlag____: - -.. _copyToRealm_E_io_realm_ImportFlag_: - -.. _copyToRealm_E__io_realm_ImportFlag_: - -.. _copyToRealm_E_ImportFlag_: - -.. _copyToRealm_E__ImportFlag_: - -.. _copyToRealm_E_ImportFlag____: - -.. _copyToRealm_E__ImportFlag____: - -.. _copyToRealm_RealmModel_io_realm_ImportFlag_: - -.. _copyToRealm_RealmModel__io_realm_ImportFlag_: - -.. _copyToRealm_RealmModel_ImportFlag_: - -.. _copyToRealm_RealmModel__ImportFlag_: - -.. _copyToRealm_RealmModel_ImportFlag____: - -.. _copyToRealm_RealmModel__ImportFlag____: - -.. _Realm_copyToRealm_E_io_realm_ImportFlag_: - -.. _Realm_copyToRealm_E__io_realm_ImportFlag_: - -.. _Realm_copyToRealm_E_ImportFlag_: - -.. _Realm_copyToRealm_E__ImportFlag_: - -.. _Realm_copyToRealm_E_ImportFlag____: - -.. _Realm_copyToRealm_E__ImportFlag____: - -.. _Realm_copyToRealm_RealmModel_io_realm_ImportFlag_: - -.. _Realm_copyToRealm_RealmModel__io_realm_ImportFlag_: - -.. _Realm_copyToRealm_RealmModel_ImportFlag_: - -.. _Realm_copyToRealm_RealmModel__ImportFlag_: - -.. _Realm_copyToRealm_RealmModel_ImportFlag____: - -.. _Realm_copyToRealm_RealmModel__ImportFlag____: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`copyToRealm ` <**E** >( - | **E** object, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - - - * - Copies a RealmObject to the Realm instance and returns the copy. Any further changes to the original RealmObject will not be reflected in the Realm copy. This is a deep copy, so all referenced objects will be copied. Objects already in this Realm will be ignored.Please note, copying an object will copy all field values. Any unset field in this and child objects will be set to their default value if not provided. - - - - - - - **Parameters** - - - ``object`` - the :ref:`io.realm.RealmObject ` to copy to the Realm. - - - - - - - ``flags`` - any flag that modifies the behaviour of inserting the data into the Realm. - - - - - - - - **Returns** - - a managed RealmObject with its properties backed by the Realm. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or it belongs to a Realm instance in a different thread. - - - - - - - - - - - - - - -.. _copyToRealmOrUpdate: - -.. _copyToRealmOrUpdate__: - -.. _Realm_copyToRealmOrUpdate: - -.. _Realm_copyToRealmOrUpdate__: - -.. _io_realm_Realm_copyToRealmOrUpdate: - -.. _io_realm_Realm_copyToRealmOrUpdate__: - - - -copyToRealmOrUpdate -------------------- - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable__ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable_ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_java_lang_Iterable__ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable__ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable_ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable__ImportFlag____: - -.. _copyToRealmOrUpdate_java_lang_Iterable_io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_java_lang_Iterable__io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_java_lang_Iterable_ImportFlag_: - -.. _copyToRealmOrUpdate_java_lang_Iterable__ImportFlag_: - -.. _copyToRealmOrUpdate_java_lang_Iterable_ImportFlag____: - -.. _copyToRealmOrUpdate_java_lang_Iterable__ImportFlag____: - -.. _copyToRealmOrUpdate_Iterable_io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_Iterable__io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_Iterable_ImportFlag_: - -.. _copyToRealmOrUpdate_Iterable__ImportFlag_: - -.. _copyToRealmOrUpdate_Iterable_ImportFlag____: - -.. _copyToRealmOrUpdate_Iterable__ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable_io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable__io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable__ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable_ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_java_lang_Iterable__ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_Iterable_io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_Iterable__io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_Iterable_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_Iterable__ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_Iterable_ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_Iterable__ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_Iterable_E___ImportFlag____: - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`copyToRealmOrUpdate ` <**E** >( - | `java.lang.Iterable\ `__ objects, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - - - * - Updates a list of existing RealmObjects that is identified by their :ref:`io.realm.annotations.PrimaryKey ` or creates a new copy if no existing object could be found. This is a deep copy or update i.e., all referenced objects will be either copied or updated. - - Please note, copying an object will copy all field values. Any unset field in the objects and child objects will be set to their default value if not provided. - - - - - - - **Parameters** - - - ``objects`` - a list of objects to update or copy into Realm. - - - - - ``flags`` - any flag that modifies the behaviour of inserting the data into the Realm. - - - - - - - - **Returns** - - a list of all the new or updated RealmObjects. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if RealmObject is ``null`` or doesn't have a Primary key defined. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealm(Iterable, ImportFlag...) ` - - - - - - - - - - -.. _io_realm_Realm_copyToRealmOrUpdate_E_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_E__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_E_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_E__ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_E_ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_E__ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel_io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel__io_realm_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel_ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel__ImportFlag_: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel_ImportFlag____: - -.. _io_realm_Realm_copyToRealmOrUpdate_RealmModel__ImportFlag____: - -.. _copyToRealmOrUpdate_E_io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_E__io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_E_ImportFlag_: - -.. _copyToRealmOrUpdate_E__ImportFlag_: - -.. _copyToRealmOrUpdate_E_ImportFlag____: - -.. _copyToRealmOrUpdate_E__ImportFlag____: - -.. _copyToRealmOrUpdate_RealmModel_io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_RealmModel__io_realm_ImportFlag_: - -.. _copyToRealmOrUpdate_RealmModel_ImportFlag_: - -.. _copyToRealmOrUpdate_RealmModel__ImportFlag_: - -.. _copyToRealmOrUpdate_RealmModel_ImportFlag____: - -.. _copyToRealmOrUpdate_RealmModel__ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_E_io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_E__io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_E_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_E__ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_E_ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_E__ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_RealmModel_io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_RealmModel__io_realm_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_RealmModel_ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_RealmModel__ImportFlag_: - -.. _Realm_copyToRealmOrUpdate_RealmModel_ImportFlag____: - -.. _Realm_copyToRealmOrUpdate_RealmModel__ImportFlag____: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`copyToRealmOrUpdate ` <**E** >( - | **E** object, - | :ref:`io.realm.ImportFlag[] ` flags - | ) - - - - - * - Updates an existing RealmObject that is identified by the same :ref:`io.realm.annotations.PrimaryKey ` or creates a new copy if no existing object could be found. This is a deep copy or update i.e., all referenced objects will be either copied or updated. - - Please note, copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided. - - - - - - - **Parameters** - - - ``object`` - :ref:`io.realm.RealmObject ` to copy or update. - - - - - - - ``flags`` - any flag that modifies the behaviour of inserting the data into the Realm. - - - - - - - - **Returns** - - the new or updated RealmObject with all its properties backed by the Realm. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the object is ``null`` or doesn't have a Primary key defined or it belongs to a Realm instance in a different thread. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`copyToRealm(RealmModel, ImportFlag...) ` - - - - - - - - - - - - -.. _createAllFromJson: - -.. _createAllFromJson__: - -.. _Realm_createAllFromJson: - -.. _Realm_createAllFromJson__: - -.. _io_realm_Realm_createAllFromJson: - -.. _io_realm_Realm_createAllFromJson__: - - - -createAllFromJson ------------------ - -.. _io_realm_Realm_createAllFromJson_java_lang_Class_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_java_lang_Class__JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class_JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class__JSONArray_: - -.. _createAllFromJson_java_lang_Class_JSONArray_: - -.. _createAllFromJson_java_lang_Class__JSONArray_: - -.. _createAllFromJson_Class_JSONArray_: - -.. _createAllFromJson_Class__JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class_JSONArray_: - -.. _Realm_createAllFromJson_java_lang_Class__JSONArray_: - -.. _Realm_createAllFromJson_Class_JSONArray_: - -.. _Realm_createAllFromJson_Class__JSONArray_: - -.. _io_realm_Realm_createAllFromJson_Class_E___JSONArray_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - - - * - Creates a Realm object for each object in a JSON array. This must be done within a transaction.JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm objects to create. - - - - - ``json`` - an array where each JSONObject must map to the specified class. - - - - - - - - - - **Throws** - - - :ref:`RealmException ` - if mapping from JSON fails. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmSet ` - - - - - :ref:`RealmDictionary ` - - - - - :ref:`RealmMap ` - - - - - - - - - - - - -.. _createEmbeddedObject: - -.. _createEmbeddedObject__: - -.. _Realm_createEmbeddedObject: - -.. _Realm_createEmbeddedObject__: - -.. _io_realm_Realm_createEmbeddedObject: - -.. _io_realm_Realm_createEmbeddedObject__: - - - -createEmbeddedObject --------------------- - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_RealmModel_String_: - -.. _io_realm_Realm_createEmbeddedObject_Class__RealmModel__String_: - -.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _createEmbeddedObject_Class_RealmModel_String_: - -.. _createEmbeddedObject_Class__RealmModel__String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_io_realm_RealmModel_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__io_realm_RealmModel__String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class_RealmModel_String_: - -.. _Realm_createEmbeddedObject_java_lang_Class__RealmModel__String_: - -.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_Class_io_realm_RealmModel_String_: - -.. _Realm_createEmbeddedObject_Class__io_realm_RealmModel__String_: - -.. _Realm_createEmbeddedObject_Class_RealmModel_java_lang_String_: - -.. _Realm_createEmbeddedObject_Class__RealmModel__java_lang_String_: - -.. _Realm_createEmbeddedObject_Class_RealmModel_String_: - -.. _Realm_createEmbeddedObject_Class__RealmModel__String_: - -.. _io_realm_Realm_createEmbeddedObject_Class_E___RealmModel__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createEmbeddedObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | :ref:`RealmModel ` parentObject, - | `String `__ parentProperty - | ) - - - - - * - Instantiates and adds a new embedded object to the Realm.This method should only be used to create objects of types marked as embedded. - - - - - - - **Parameters** - - - ``clazz`` - the Class of the object to create. It must be marked with ``@RealmClass(embedded = true)`` . - - - - - - - ``parentObject`` - The parent object which should hold a reference to the embedded object. - - - - - ``parentProperty`` - the property in the parent class which holds the reference. If the parent property is a list the embedded object will be added to the end of that list. - - - - - - - - **Returns** - - the newly created embedded object. - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``clazz`` is not an embedded class or if the property in the parent class cannot hold objects of the appropriate type. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmClass.embedded() ` - - - - - - - - - - - - -.. _createObject: - -.. _createObject__: - -.. _Realm_createObject: - -.. _Realm_createObject__: - -.. _io_realm_Realm_createObject: - -.. _io_realm_Realm_createObject__: - - - -createObject ------------- - -.. _io_realm_Realm_createObject_java_lang_Class_java_lang_Object_: - -.. _io_realm_Realm_createObject_java_lang_Class__java_lang_Object_: - -.. _io_realm_Realm_createObject_java_lang_Class_Object_: - -.. _io_realm_Realm_createObject_java_lang_Class__Object_: - -.. _io_realm_Realm_createObject_Class_java_lang_Object_: - -.. _io_realm_Realm_createObject_Class__java_lang_Object_: - -.. _io_realm_Realm_createObject_Class_Object_: - -.. _io_realm_Realm_createObject_Class__Object_: - -.. _createObject_java_lang_Class_java_lang_Object_: - -.. _createObject_java_lang_Class__java_lang_Object_: - -.. _createObject_java_lang_Class_Object_: - -.. _createObject_java_lang_Class__Object_: - -.. _createObject_Class_java_lang_Object_: - -.. _createObject_Class__java_lang_Object_: - -.. _createObject_Class_Object_: - -.. _createObject_Class__Object_: - -.. _Realm_createObject_java_lang_Class_java_lang_Object_: - -.. _Realm_createObject_java_lang_Class__java_lang_Object_: - -.. _Realm_createObject_java_lang_Class_Object_: - -.. _Realm_createObject_java_lang_Class__Object_: - -.. _Realm_createObject_Class_java_lang_Object_: - -.. _Realm_createObject_Class__java_lang_Object_: - -.. _Realm_createObject_Class_Object_: - -.. _Realm_createObject_Class__Object_: - -.. _io_realm_Realm_createObject_Class_E___Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz, - | `Object `__ primaryKeyValue - | ) - - - - - * - Instantiates and adds a new object to the Realm with the primary key value already set.If the value violates the primary key constraint, no object will be added and a :ref:`RealmException ` will be thrown. The default value for primary key provided by the model class will be ignored. - - - - - - - - - **Parameters** - - - ``clazz`` - the Class of the object to create. - - - - - ``primaryKeyValue`` - value for the primary key field. - - - - - - - - **Returns** - - the new object. - - - - - **Throws** - - - :ref:`RealmException ` - if object could not be created due to the primary key being invalid. - - - - - `IllegalStateException `__ - if the model class does not have an primary key defined. - - - - - `IllegalArgumentException `__ - if the ``primaryKeyValue`` doesn't have a value that can be converted to the expected value. - - - - - - - - - - - - -.. _io_realm_Realm_createObject_java_lang_Class_: - -.. _io_realm_Realm_createObject_Class_: - -.. _createObject_java_lang_Class_: - -.. _createObject_Class_: - -.. _Realm_createObject_java_lang_Class_: - -.. _Realm_createObject_Class_: - -.. _io_realm_Realm_createObject_Class_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObject ` <**E** >( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Instantiates and adds a new object to the Realm.This method is only available for model classes with no \@PrimaryKey annotation. If you like to create an object that has a primary key, use :ref:`createObject(Class, Object) ` or :ref:`copyToRealm(RealmModel, ImportFlag...) ` instead. - - - - - - - - - **Parameters** - - - ``clazz`` - the Class of the object to create. - - - - - - - - **Returns** - - the new object. - - - - - **Throws** - - - :ref:`RealmException ` - if the primary key is defined in the model class or an object cannot be created. - - - - - - - - - - .. seealso:: - - - - - :ref:`createObject(Class, Object) ` - - - - - - - - - - - - -.. _createObjectFromJson: - -.. _createObjectFromJson__: - -.. _Realm_createObjectFromJson: - -.. _Realm_createObjectFromJson__: - -.. _io_realm_Realm_createObjectFromJson: - -.. _io_realm_Realm_createObjectFromJson__: - - - -createObjectFromJson --------------------- - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_java_lang_Class__JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class_JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class__JSONObject_: - -.. _createObjectFromJson_java_lang_Class_JSONObject_: - -.. _createObjectFromJson_java_lang_Class__JSONObject_: - -.. _createObjectFromJson_Class_JSONObject_: - -.. _createObjectFromJson_Class__JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class_JSONObject_: - -.. _Realm_createObjectFromJson_java_lang_Class__JSONObject_: - -.. _Realm_createObjectFromJson_Class_JSONObject_: - -.. _Realm_createObjectFromJson_Class__JSONObject_: - -.. _io_realm_Realm_createObjectFromJson_Class_E___JSONObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONObject** json - | ) - - - - - * - Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a :ref:`RealmObject ` field is not present in the JSON object the :ref:`RealmObject ` field will be set to the default value for that type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of Realm object to create. - - - - - ``json`` - the JSONObject with object data. - - - - - - - - **Returns** - - created object or ``null`` if no JSON data was provided. - - - - - - - **Throws** - - - :ref:`RealmException ` - if the mapping from JSON fails. - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - - - - - - - - - - - .. seealso:: - - - - - **createOrUpdateObjectFromJson(Class, org.json.JSONObject)** - - - - - :ref:`RealmSet ` - - - - - :ref:`RealmDictionary ` - - - - - :ref:`RealmMap ` - - - - - - - - - - - - -.. _createOrUpdateAllFromJson: - -.. _createOrUpdateAllFromJson__: - -.. _Realm_createOrUpdateAllFromJson: - -.. _Realm_createOrUpdateAllFromJson__: - -.. _io_realm_Realm_createOrUpdateAllFromJson: - -.. _io_realm_Realm_createOrUpdateAllFromJson__: - - - -createOrUpdateAllFromJson -------------------------- - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class__JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _createOrUpdateAllFromJson_Class_JSONArray_: - -.. _createOrUpdateAllFromJson_Class__JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_java_lang_Class__JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class_JSONArray_: - -.. _Realm_createOrUpdateAllFromJson_Class__JSONArray_: - -.. _io_realm_Realm_createOrUpdateAllFromJson_Class_E___JSONArray_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createOrUpdateAllFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONArray** json - | ) - - - - - * - Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - - - - ``json`` - array with object data. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - :ref:`RealmException ` - if unable to map JSON. - - - - - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - - - - - - - - - - - .. seealso:: - - - - - **createAllFromJson(Class, org.json.JSONArray)** - - - - - :ref:`RealmSet ` - - - - - :ref:`RealmDictionary ` - - - - - :ref:`RealmMap ` - - - - - - - - - - - - -.. _createOrUpdateObjectFromJson: - -.. _createOrUpdateObjectFromJson__: - -.. _Realm_createOrUpdateObjectFromJson: - -.. _Realm_createOrUpdateObjectFromJson__: - -.. _io_realm_Realm_createOrUpdateObjectFromJson: - -.. _io_realm_Realm_createOrUpdateObjectFromJson__: - - - -createOrUpdateObjectFromJson ----------------------------- - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_JSONObject_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class__JSONObject_: - -.. _createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: - -.. _createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: - -.. _createOrUpdateObjectFromJson_Class_JSONObject_: - -.. _createOrUpdateObjectFromJson_Class__JSONObject_: - -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class_JSONObject_: - -.. _Realm_createOrUpdateObjectFromJson_java_lang_Class__JSONObject_: - -.. _Realm_createOrUpdateObjectFromJson_Class_JSONObject_: - -.. _Realm_createOrUpdateObjectFromJson_Class__JSONObject_: - -.. _io_realm_Realm_createOrUpdateObjectFromJson_Class_E___JSONObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`createOrUpdateObjectFromJson ` <**E** >( - | `java.lang.Class\ `__ clazz, - | **JSONObject** json - | ) - - - - - * - Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a :ref:`RealmObject ` and a field is not found in the JSON object, that field will not be updated. If a new :ref:`RealmObject ` is created and a field is not found in the JSON object, that field will be assigned the default value for the field type. - - This method currently does not support value list field. - - - - - - - **Parameters** - - - ``clazz`` - Type of :ref:`io.realm.RealmObject ` to create or update. It must have a primary key defined. - - - - - - - ``json`` - **org.json.JSONObject** with object data. - - - - - - - - - - **Returns** - - created or updated :ref:`io.realm.RealmObject ` . - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if trying to update a class without a :ref:`io.realm.annotations.PrimaryKey ` . - - - - - - - `IllegalArgumentException `__ - if the JSON object doesn't have a primary key property but the corresponding :ref:`RealmObjectSchema ` has a :ref:`io.realm.annotations.PrimaryKey ` defined. - - - - - - - :ref:`RealmException ` - if JSON data cannot be mapped. - - - - - `UnsupportedOperationException `__ - if the object to insert contains a :ref:`RealmDictionary ` or a :ref:`RealmSet ` . - - - - - - - - - - - - .. seealso:: - - - - - **createObjectFromJson(Class, org.json.JSONObject)** - - - - - :ref:`RealmSet ` - - - - - :ref:`RealmDictionary ` - - - - - :ref:`RealmMap ` - - - - - - - - - - - - -.. _delete: - -.. _delete__: - -.. _Realm_delete: - -.. _Realm_delete__: - -.. _io_realm_Realm_delete: - -.. _io_realm_Realm_delete__: - - - -delete ------- - -.. _io_realm_Realm_delete_java_lang_Class_: - -.. _io_realm_Realm_delete_Class_: - -.. _io_realm_Realm_delete_RealmModel__: - -.. _delete_java_lang_Class_: - -.. _delete_Class_: - -.. _delete_RealmModel__: - -.. _Realm_delete_java_lang_Class_: - -.. _Realm_delete_Class_: - -.. _Realm_delete_RealmModel__: - -.. _io_realm_Realm_delete_Class___extends_RealmModel__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`delete ` ( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Deletes all objects of the specified class from the Realm. - - - - - **Parameters** - - - ``clazz`` - the class which objects should be removed. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the Realm is closed or called from an incorrect thread. - - - - - - - - - - - - -.. _deleteRealm: - -.. _deleteRealm__: - -.. _Realm_deleteRealm: - -.. _Realm_deleteRealm__: - -.. _io_realm_Realm_deleteRealm: - -.. _io_realm_Realm_deleteRealm__: - - - -deleteRealm ------------ - -.. _io_realm_Realm_deleteRealm_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_deleteRealm_RealmConfiguration_: - -.. _deleteRealm_io_realm_RealmConfiguration_: - -.. _deleteRealm_RealmConfiguration_: - -.. _Realm_deleteRealm_io_realm_RealmConfiguration_: - -.. _Realm_deleteRealm_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`deleteRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Deletes the Realm file along with the related temporary files specified by the given :ref:`RealmConfiguration ` from the filesystem. Temporary file with ".lock" extension won't be deleted. - - All Realm instances must be closed before calling this method. - - WARNING: For synchronized Realm, there is a chance that an internal Realm instance on the background thread is not closed even all the user controlled Realm instances are closed. This will result an ``IllegalStateException`` . See issue https://github.com/realm/realm-java/issues/5416 . - - - - - - - - - **Parameters** - - - ``configuration`` - a :ref:`RealmConfiguration ` . - - - - - - - - - - **Returns** - - ``false`` if the Realm file could not be deleted. Temporary files deletion failure won't impact the return value. All of the failing file deletions will be logged. - - - - - - - **Throws** - - - `IllegalStateException `__ - if there are Realm instances opened on other threads or other processes. - - - - - - - - - - - - -.. _executeTransaction: - -.. _executeTransaction__: - -.. _Realm_executeTransaction: - -.. _Realm_executeTransaction__: - -.. _io_realm_Realm_executeTransaction: - -.. _io_realm_Realm_executeTransaction__: - - - -executeTransaction ------------------- - -.. _io_realm_Realm_executeTransaction_io_realm_Realm_Transaction_: - -.. _io_realm_Realm_executeTransaction_Transaction_: - -.. _io_realm_Realm_executeTransaction_Realm_Transaction_: - -.. _executeTransaction_io_realm_Realm_Transaction_: - -.. _executeTransaction_Transaction_: - -.. _executeTransaction_Realm_Transaction_: - -.. _Realm_executeTransaction_io_realm_Realm_Transaction_: - -.. _Realm_executeTransaction_Transaction_: - -.. _Realm_executeTransaction_Realm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`executeTransaction ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - - - * - Executes a given transaction on the Realm. **beginTransaction()** and **commitTransaction()** will be called automatically. If any exception is thrown during the transaction **cancelTransaction()** will be called instead of **commitTransaction()**. - - Calling this method from the UI thread will throw a :ref:`RealmException ` . Doing so may result in a drop of frames or even ANRs. We recommend calling this method from a non-UI thread or using :ref:`executeTransactionAsync(Transaction) ` instead. - - - - - - - - - **Parameters** - - - ``transaction`` - the :ref:`io.realm.Realm.Transaction ` to execute. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` . - - - - - - - :ref:`RealmMigrationNeededException ` - if the latest version contains incompatible schema changes. - - - - - :ref:`RealmException ` - if called from the UI thread, unless an explicit opt-in has been declared in :ref:`RealmConfiguration.Builder.allowWritesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _executeTransactionAsync: - -.. _executeTransactionAsync__: - -.. _Realm_executeTransactionAsync: - -.. _Realm_executeTransactionAsync__: - -.. _io_realm_Realm_executeTransactionAsync: - -.. _io_realm_Realm_executeTransactionAsync__: - - - -executeTransactionAsync ------------------------ - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__OnSuccess__OnError_: - -.. _executeTransactionAsync_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__OnSuccess__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess__Realm_Transaction_OnError_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnSuccess ` onSuccess, - | :ref:`Realm.Transaction.OnError ` onError - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess and OnError callbacks. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`io.realm.Realm.Transaction ` to execute. - - - - - - - ``onSuccess`` - callback invoked when the transaction succeeds. - - - - - ``onError`` - callback invoked when the transaction fails. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnError_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__OnError_: - -.. _executeTransactionAsync_Transaction_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Transaction__Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__OnError_: - -.. _executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnError_: - -.. _executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__OnError_: - -.. _Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnError_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnError_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnError ` onError - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnError callback. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`io.realm.Realm.Transaction ` to execute. - - - - - - - ``onError`` - callback invoked when the transaction fails. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__OnSuccess_: - -.. _executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction__OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction__OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Transaction__Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__io_realm_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_Realm_Transaction_OnSuccess_: - -.. _Realm_executeTransactionAsync_Realm_Transaction__Realm_Transaction_OnSuccess_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction, - | :ref:`Realm.Transaction.OnSuccess ` onSuccess - | ) - - - - - * - Similar to :ref:`executeTransactionAsync(Transaction) ` , but also accepts an OnSuccess callback. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`io.realm.Realm.Transaction ` to execute. - - - - - - - ``onSuccess`` - callback invoked when the transaction succeeds. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the realm is opened from another thread. - - - - - - - - - - - - -.. _io_realm_Realm_executeTransactionAsync_io_realm_Realm_Transaction_: - -.. _io_realm_Realm_executeTransactionAsync_Transaction_: - -.. _io_realm_Realm_executeTransactionAsync_Realm_Transaction_: - -.. _executeTransactionAsync_io_realm_Realm_Transaction_: - -.. _executeTransactionAsync_Transaction_: - -.. _executeTransactionAsync_Realm_Transaction_: - -.. _Realm_executeTransactionAsync_io_realm_Realm_Transaction_: - -.. _Realm_executeTransactionAsync_Transaction_: - -.. _Realm_executeTransactionAsync_Realm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`executeTransactionAsync ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - - - * - Similar to :ref:`executeTransaction(Transaction) ` but runs asynchronously on a worker thread. - - - - - - - **Parameters** - - - ``transaction`` - :ref:`io.realm.Realm.Transaction ` to execute. - - - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``transaction`` is ``null`` , or if the Realm is opened from another thread. - - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _Realm_freeze: - -.. _Realm_freeze__: - -.. _io_realm_Realm_freeze: - -.. _io_realm_Realm_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Realm ` :ref:`freeze ` () - | - - - - - * - Returns a frozen snapshot of the current Realm. This Realm can be read and queried from any thread without throwing an `IllegalStateException `__ . A frozen Realm has its own lifecycle and can be closed by calling **close()**, but fully closing the Realm that spawned the frozen copy will also close the frozen Realm. - - Frozen data can be queried as normal, but trying to mutate it in any way or attempting to register any listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of Realms with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation, it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - - - - - - - **Returns** - - a frozen copy of this Realm. - - - - - - - **Overrides** - - ``freeze`` in class **BaseRealm** - - - - - - -.. _getApplicationContext: - -.. _getApplicationContext__: - -.. _Realm_getApplicationContext: - -.. _Realm_getApplicationContext__: - -.. _io_realm_Realm_getApplicationContext: - -.. _io_realm_Realm_getApplicationContext__: - - - -getApplicationContext ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public static **Context** :ref:`getApplicationContext ` () - | - - - - - * - Get the application context used when initializing Realm with :ref:`Realm.init(Context) ` or :ref:`Realm.init(Context, String) ` . - - - - - - - - - **Returns** - - the application context used when initializing Realm with :ref:`Realm.init(Context) ` or :ref:`Realm.init(Context, String) ` , or null if Realm has not been initialized yet. - - - - - - - - - - - - - -.. _getDefaultConfiguration: - -.. _getDefaultConfiguration__: - -.. _Realm_getDefaultConfiguration: - -.. _Realm_getDefaultConfiguration__: - -.. _io_realm_Realm_getDefaultConfiguration: - -.. _io_realm_Realm_getDefaultConfiguration__: - - - -getDefaultConfiguration ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmConfiguration ` :ref:`getDefaultConfiguration ` () - | - - - - - * - Returns the default configuration for :ref:`getDefaultInstance() ` . - - - - - - - - - **Returns** - - default configuration object or ``null`` if no default configuration is specified. - - - - - - - - - - - - - -.. _getDefaultInstance: - -.. _getDefaultInstance__: - -.. _Realm_getDefaultInstance: - -.. _Realm_getDefaultInstance__: - -.. _io_realm_Realm_getDefaultInstance: - -.. _io_realm_Realm_getDefaultInstance__: - - - -getDefaultInstance ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Realm ` :ref:`getDefaultInstance ` () - | - - - - - * - Realm static constructor that returns the Realm instance defined by the :ref:`io.realm.RealmConfiguration ` set by :ref:`setDefaultConfiguration(RealmConfiguration) ` - - - - - - - - - **Returns** - - an instance of the Realm class. - - - - - **Throws** - - - `java.lang.NullPointerException `__ - if no default configuration has been defined. - - - - - :ref:`RealmMigrationNeededException ` - if no migration has been provided by the default configuration and the - - - - - :ref:`RealmFileException ` - if an error happened when accessing the underlying Realm file. was set and the thread opening the Realm was interrupted while the download was in progress. - - - - - - - - - - - - -.. _getDefaultModule: - -.. _getDefaultModule__: - -.. _Realm_getDefaultModule: - -.. _Realm_getDefaultModule__: - -.. _io_realm_Realm_getDefaultModule: - -.. _io_realm_Realm_getDefaultModule__: - - - -getDefaultModule ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public static `Object `__ :ref:`getDefaultModule ` () - | - - - - - * - Returns the default Realm module. This module contains all Realm classes in the current project, but not those from library or project dependencies. Realm classes in these should be exposed using their own module. - - - - - - - **Returns** - - the default Realm module or ``null`` if no default module exists. - - - - - - - **Throws** - - - :ref:`RealmException ` - if unable to create an instance of the module. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmConfiguration.Builder.modules(Object, Object...) ` - - - - - - - - - - - - -.. _getGlobalInstanceCount: - -.. _getGlobalInstanceCount__: - -.. _Realm_getGlobalInstanceCount: - -.. _Realm_getGlobalInstanceCount__: - -.. _io_realm_Realm_getGlobalInstanceCount: - -.. _io_realm_Realm_getGlobalInstanceCount__: - - - -getGlobalInstanceCount ----------------------- - -.. _io_realm_Realm_getGlobalInstanceCount_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_getGlobalInstanceCount_RealmConfiguration_: - -.. _getGlobalInstanceCount_io_realm_RealmConfiguration_: - -.. _getGlobalInstanceCount_RealmConfiguration_: - -.. _Realm_getGlobalInstanceCount_io_realm_RealmConfiguration_: - -.. _Realm_getGlobalInstanceCount_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **int** :ref:`getGlobalInstanceCount ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Returns the current number of open Realm instances across all threads in current process that are using this configuration. This includes both dynamic and normal Realms. - - - - - **Parameters** - - - ``configuration`` - the :ref:`io.realm.RealmConfiguration ` for the Realm. - - - - - - - - - - **Returns** - - number of open Realm instances across all threads. - - - - - - - - - - - -.. _getInstance: - -.. _getInstance__: - -.. _Realm_getInstance: - -.. _Realm_getInstance__: - -.. _io_realm_Realm_getInstance: - -.. _io_realm_Realm_getInstance__: - - - -getInstance ------------ - -.. _io_realm_Realm_getInstance_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_getInstance_RealmConfiguration_: - -.. _getInstance_io_realm_RealmConfiguration_: - -.. _getInstance_RealmConfiguration_: - -.. _Realm_getInstance_io_realm_RealmConfiguration_: - -.. _Realm_getInstance_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Realm ` :ref:`getInstance ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Realm static constructor that returns the Realm instance defined by provided :ref:`io.realm.RealmConfiguration ` - - - - - - - **Parameters** - - - ``configuration`` - :ref:`RealmConfiguration ` used to open the Realm - - - - - - - - - - **Returns** - - an instance of the Realm class - - - - - **Throws** - - - :ref:`RealmMigrationNeededException ` - if no migration has been provided by the configuration and the RealmObject classes or version has has changed so a migration is required. - - - - - :ref:`RealmFileException ` - if an error happened when accessing the underlying Realm file. - - - - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmConfiguration for details on how to configure a Realm. ` - - - - - - - - - - - - -.. _getInstanceAsync: - -.. _getInstanceAsync__: - -.. _Realm_getInstanceAsync: - -.. _Realm_getInstanceAsync__: - -.. _io_realm_Realm_getInstanceAsync: - -.. _io_realm_Realm_getInstanceAsync__: - - - -getInstanceAsync ----------------- - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration_io_realm_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration__io_realm_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_io_realm_RealmConfiguration__Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration_io_realm_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration__io_realm_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration_Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration__Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration_Realm_Callback_: - -.. _io_realm_Realm_getInstanceAsync_RealmConfiguration__Realm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_io_realm_Realm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__io_realm_Realm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration_Realm_Callback_: - -.. _getInstanceAsync_io_realm_RealmConfiguration__Realm_Callback_: - -.. _getInstanceAsync_RealmConfiguration_io_realm_Realm_Callback_: - -.. _getInstanceAsync_RealmConfiguration__io_realm_Realm_Callback_: - -.. _getInstanceAsync_RealmConfiguration_Callback_: - -.. _getInstanceAsync_RealmConfiguration__Callback_: - -.. _getInstanceAsync_RealmConfiguration_Realm_Callback_: - -.. _getInstanceAsync_RealmConfiguration__Realm_Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration_io_realm_Realm_Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration__io_realm_Realm_Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration_Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration__Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration_Realm_Callback_: - -.. _Realm_getInstanceAsync_io_realm_RealmConfiguration__Realm_Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration_io_realm_Realm_Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration__io_realm_Realm_Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration_Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration__Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration_Realm_Callback_: - -.. _Realm_getInstanceAsync_RealmConfiguration__Realm_Callback_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAsyncTask ` :ref:`getInstanceAsync ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`Realm.Callback ` callback - | ) - - - - - * - The creation of the first Realm instance per :ref:`RealmConfiguration ` in a process can take some time as all initialization code need to run at that point (setting up the Realm, validating schemas and creating initial data). This method places the initialization work in a background thread and deliver the Realm instance to the caller thread asynchronously after the initialization is finished. - - - - - - - **Parameters** - - - ``configuration`` - :ref:`RealmConfiguration ` used to open the Realm. - - - - - - - ``callback`` - invoked to return the results. - - - - - - - - **Returns** - - a :ref:`RealmAsyncTask ` representing a cancellable task. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` or a null :ref:`Callback ` is provided. - - - - - - - `IllegalStateException `__ - if it is called from a non-Looper or **IntentService** thread. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Callback for more details. ` - - - - - - - - - - - - -.. _getLocalInstanceCount: - -.. _getLocalInstanceCount__: - -.. _Realm_getLocalInstanceCount: - -.. _Realm_getLocalInstanceCount__: - -.. _io_realm_Realm_getLocalInstanceCount: - -.. _io_realm_Realm_getLocalInstanceCount__: - - - -getLocalInstanceCount ---------------------- - -.. _io_realm_Realm_getLocalInstanceCount_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_getLocalInstanceCount_RealmConfiguration_: - -.. _getLocalInstanceCount_io_realm_RealmConfiguration_: - -.. _getLocalInstanceCount_RealmConfiguration_: - -.. _Realm_getLocalInstanceCount_io_realm_RealmConfiguration_: - -.. _Realm_getLocalInstanceCount_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **int** :ref:`getLocalInstanceCount ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Returns the current number of open Realm instances on the thread calling this method. This include both dynamic and normal Realms. - - - - - **Parameters** - - - ``configuration`` - the :ref:`io.realm.RealmConfiguration ` for the Realm. - - - - - - - - - - **Returns** - - number of open Realm instances on the caller thread. - - - - - - - - - - - -.. _getSchema: - -.. _getSchema__: - -.. _Realm_getSchema: - -.. _Realm_getSchema__: - -.. _io_realm_Realm_getSchema: - -.. _io_realm_Realm_getSchema__: - - - -getSchema ---------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSchema ` :ref:`getSchema ` () - | - - - - - * - Returns the schema for this Realm. The schema is immutable. Any attempt to modify it will result in an `UnsupportedOperationException `__ . - - The schema can only be modified using :ref:`DynamicRealm.getSchema() ` or through an migration. - - - - - - - - - - - **Returns** - - The :ref:`RealmSchema ` for this Realm. - - - - - - - - - **Overrides** - - ``getSchema`` in class **BaseRealm** - - - - - - -.. _init: - -.. _init__: - -.. _Realm_init: - -.. _Realm_init__: - -.. _io_realm_Realm_init: - -.. _io_realm_Realm_init__: - - - -init ----- - -.. _io_realm_Realm_init_Context_java_lang_String_: - -.. _io_realm_Realm_init_Context__java_lang_String_: - -.. _io_realm_Realm_init_Context_String_: - -.. _io_realm_Realm_init_Context__String_: - -.. _init_Context_java_lang_String_: - -.. _init_Context__java_lang_String_: - -.. _init_Context_String_: - -.. _init_Context__String_: - -.. _Realm_init_Context_java_lang_String_: - -.. _Realm_init_Context__java_lang_String_: - -.. _Realm_init_Context_String_: - -.. _Realm_init_Context__String_: - -.. list-table:: - :header-rows: 1 - - * - | public static synchronized **void** :ref:`init ` ( - | **Context** context, - | `String `__ userAgent - | ) - - - - - * - Initializes the Realm library and creates a default configuration that is ready to use. It is required to call this method before interacting with any other of the Realm API's.A good place is in an `android.app.Application `__ subclass: - - - - - - .. code-block:: java - - - public class MyApplication extends Application { - @Override - public void onCreate() { - super.onCreate(); - Realm.init(this, "MyApp/" + BuildConfig.VERSION_NAME); - } - } - - - - - - Remember to register it in the ``AndroidManifest.xml`` file: - - - - - - .. code-block:: java - - - - - - // ... - - - - - - - - - - - - - **Parameters** - - - ``context`` - the Application Context. - - - - - ``userAgent`` - optional user defined string that will be sent to the Realm Object Server as part of a ``User-Agent`` header when a session is established. This setting will not be used by non-synchronized Realms. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a ``null`` context or userAgent is provided. - - - - - - - `IllegalStateException `__ - if **Context.getFilesDir()** could not be found. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`getDefaultInstance() ` - - - - - - - - - - -.. _io_realm_Realm_init_Context_: - -.. _init_Context_: - -.. _Realm_init_Context_: - -.. list-table:: - :header-rows: 1 - - * - | public static synchronized **void** :ref:`init ` ( - | **Context** context - | ) - - - - - * - Initializes the Realm library and creates a default configuration that is ready to use. It is required to call this method before interacting with any other of the Realm API's.A good place is in an `android.app.Application `__ subclass: - - - - - - .. code-block:: java - - - public class MyApplication extends Application { - @Override - public void onCreate() { - super.onCreate(); - Realm.init(this); - } - } - - - - - - Remember to register it in the ``AndroidManifest.xml`` file: - - - - - - .. code-block:: java - - - - - - // ... - - - - - - - - - - - - - **Parameters** - - - ``context`` - the Application Context. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a ``null`` context is provided. - - - - - - - `IllegalStateException `__ - if **Context.getFilesDir()** could not be found. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`getDefaultInstance() ` - - - - - - - - - - - - -.. _insert: - -.. _insert__: - -.. _Realm_insert: - -.. _Realm_insert__: - -.. _io_realm_Realm_insert: - -.. _io_realm_Realm_insert__: - - - -insert ------- - -.. _io_realm_Realm_insert_io_realm_RealmModel_: - -.. _io_realm_Realm_insert_RealmModel_: - -.. _insert_io_realm_RealmModel_: - -.. _insert_RealmModel_: - -.. _Realm_insert_io_realm_RealmModel_: - -.. _Realm_insert_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`insert ` ( - | :ref:`RealmModel ` object - | ) - - - - - * - Inserts an unmanaged RealmObject. This is generally faster than :ref:`copyToRealm(RealmModel, ImportFlag...) ` since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original object will not be persisted. - - Please note: - - - - - We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated. - - - - We don't create (nor return) a managed :ref:`RealmObject ` for each element - - - - - - Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided - - - - - If you want the managed :ref:`RealmObject ` returned, use :ref:`copyToRealm(RealmModel, ImportFlag...) ` , otherwise if you have a large number of object this method is generally faster. - - - - - - - - - **Parameters** - - - ``object`` - RealmObjects to insert. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. - - - - - :ref:`io.realm.exceptions.RealmPrimaryKeyConstraintException ` - if two objects with the same primary key is inserted or if a primary key value already exists in the Realm. - - - - - - - - - - -.. _io_realm_Realm_insert_java_util_Collection_: - -.. _io_realm_Realm_insert_Collection_: - -.. _io_realm_Realm_insert_RealmModel__: - -.. _insert_java_util_Collection_: - -.. _insert_Collection_: - -.. _insert_RealmModel__: - -.. _Realm_insert_java_util_Collection_: - -.. _Realm_insert_Collection_: - -.. _Realm_insert_RealmModel__: - -.. _io_realm_Realm_insert_Collection___extends_RealmModel__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`insert ` ( - | `java.util.Collection\ `__ objects - | ) - - - - - * - Inserts a list of an unmanaged RealmObjects. This is generally faster than :ref:`copyToRealm(Iterable, ImportFlag...) ` since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original objects will not be persisted. - - Please note: - - - - - We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated. - - - - We don't create (nor return) a managed :ref:`RealmObject ` for each element - - - - - - Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided - - - - - If you want the managed :ref:`RealmObject ` returned, use :ref:`copyToRealm(Iterable, ImportFlag...) ` , otherwise if you have a large number of object this method is generally faster. - - - - - - - - - **Parameters** - - - ``objects`` - RealmObjects to insert. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. - - - - - - - - - - - - -.. _insertOrUpdate: - -.. _insertOrUpdate__: - -.. _Realm_insertOrUpdate: - -.. _Realm_insertOrUpdate__: - -.. _io_realm_Realm_insertOrUpdate: - -.. _io_realm_Realm_insertOrUpdate__: - - - -insertOrUpdate --------------- - -.. _io_realm_Realm_insertOrUpdate_io_realm_RealmModel_: - -.. _io_realm_Realm_insertOrUpdate_RealmModel_: - -.. _insertOrUpdate_io_realm_RealmModel_: - -.. _insertOrUpdate_RealmModel_: - -.. _Realm_insertOrUpdate_io_realm_RealmModel_: - -.. _Realm_insertOrUpdate_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`insertOrUpdate ` ( - | :ref:`RealmModel ` object - | ) - - - - - * - Inserts or updates an unmanaged RealmObject. This is generally faster than :ref:`copyToRealmOrUpdate(RealmModel, ImportFlag...) ` since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original object will not be persisted. - - Please note: - - - - - We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated. - - - - We don't create (nor return) a managed :ref:`RealmObject ` for each element - - - - - - Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided - - - - - If you want the managed :ref:`RealmObject ` returned, use :ref:`copyToRealm(RealmModel, ImportFlag...) ` , otherwise if you have a large number of object this method is generally faster. - - - - - - - - - **Parameters** - - - ``object`` - RealmObjects to insert. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. - - - - - - - - - - -.. _io_realm_Realm_insertOrUpdate_java_util_Collection_: - -.. _io_realm_Realm_insertOrUpdate_Collection_: - -.. _io_realm_Realm_insertOrUpdate_RealmModel__: - -.. _insertOrUpdate_java_util_Collection_: - -.. _insertOrUpdate_Collection_: - -.. _insertOrUpdate_RealmModel__: - -.. _Realm_insertOrUpdate_java_util_Collection_: - -.. _Realm_insertOrUpdate_Collection_: - -.. _Realm_insertOrUpdate_RealmModel__: - -.. _io_realm_Realm_insertOrUpdate_Collection___extends_RealmModel__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`insertOrUpdate ` ( - | `java.util.Collection\ `__ objects - | ) - - - - - * - Inserts or updates a list of unmanaged RealmObjects. This is generally faster than :ref:`copyToRealmOrUpdate(Iterable, ImportFlag...) ` since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original objects will not be persisted. - - Please note: - - - - - We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated. - - - - We don't create (nor return) a managed :ref:`RealmObject ` for each element - - - - - - Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided - - - - - If you want the managed :ref:`RealmObject ` returned, use :ref:`copyToRealm(Iterable, ImportFlag...) ` , otherwise if you have a large number of object this method is generally faster. - - - - - - - - - **Parameters** - - - ``objects`` - RealmObjects to insert. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction. - - - - - :ref:`io.realm.exceptions.RealmPrimaryKeyConstraintException ` - if two objects with the same primary key is inserted or if a primary key value already exists in the Realm. - - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _Realm_isEmpty: - -.. _Realm_isEmpty__: - -.. _io_realm_Realm_isEmpty: - -.. _io_realm_Realm_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - Checks if this :ref:`io.realm.Realm ` contains any objects. - - - - - - - - - **Returns** - - ``true`` if empty, \@{code false} otherwise. - - - - - - - - - **Overrides** - - ``isEmpty`` in class **BaseRealm** - - - - - - -.. _migrateRealm: - -.. _migrateRealm__: - -.. _Realm_migrateRealm: - -.. _Realm_migrateRealm__: - -.. _io_realm_Realm_migrateRealm: - -.. _io_realm_Realm_migrateRealm__: - - - -migrateRealm ------------- - -.. _io_realm_Realm_migrateRealm_io_realm_RealmConfiguration_io_realm_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_io_realm_RealmConfiguration__io_realm_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_io_realm_RealmConfiguration_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_io_realm_RealmConfiguration__RealmMigration_: - -.. _io_realm_Realm_migrateRealm_RealmConfiguration_io_realm_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_RealmConfiguration__io_realm_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_RealmConfiguration_RealmMigration_: - -.. _io_realm_Realm_migrateRealm_RealmConfiguration__RealmMigration_: - -.. _migrateRealm_io_realm_RealmConfiguration_io_realm_RealmMigration_: - -.. _migrateRealm_io_realm_RealmConfiguration__io_realm_RealmMigration_: - -.. _migrateRealm_io_realm_RealmConfiguration_RealmMigration_: - -.. _migrateRealm_io_realm_RealmConfiguration__RealmMigration_: - -.. _migrateRealm_RealmConfiguration_io_realm_RealmMigration_: - -.. _migrateRealm_RealmConfiguration__io_realm_RealmMigration_: - -.. _migrateRealm_RealmConfiguration_RealmMigration_: - -.. _migrateRealm_RealmConfiguration__RealmMigration_: - -.. _Realm_migrateRealm_io_realm_RealmConfiguration_io_realm_RealmMigration_: - -.. _Realm_migrateRealm_io_realm_RealmConfiguration__io_realm_RealmMigration_: - -.. _Realm_migrateRealm_io_realm_RealmConfiguration_RealmMigration_: - -.. _Realm_migrateRealm_io_realm_RealmConfiguration__RealmMigration_: - -.. _Realm_migrateRealm_RealmConfiguration_io_realm_RealmMigration_: - -.. _Realm_migrateRealm_RealmConfiguration__io_realm_RealmMigration_: - -.. _Realm_migrateRealm_RealmConfiguration_RealmMigration_: - -.. _Realm_migrateRealm_RealmConfiguration__RealmMigration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`migrateRealm ` ( - | :ref:`RealmConfiguration ` configuration, - | :ref:`RealmMigration ` migration - | ) - - - - - * - Manually triggers a migration on a RealmMigration. - - - - - **Parameters** - - - ``configuration`` - the:ref:`RealmConfiguration ` . - - - - - - - ``migration`` - the :ref:`RealmMigration ` to run on the Realm. This will override any migration set on the configuration. - - - - - - - - - - - - **Throws** - - - `FileNotFoundException `__ - if the Realm file doesn't exist. - - - - - - - - - - -.. _io_realm_Realm_migrateRealm_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_migrateRealm_RealmConfiguration_: - -.. _migrateRealm_io_realm_RealmConfiguration_: - -.. _migrateRealm_RealmConfiguration_: - -.. _Realm_migrateRealm_io_realm_RealmConfiguration_: - -.. _Realm_migrateRealm_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`migrateRealm ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Manually triggers the migration associated with a given RealmConfiguration. If Realm is already at the latest version, nothing will happen. - - - - - **Parameters** - - - ``configuration`` - :ref:`RealmConfiguration ` - - - - - - - - - - - - **Throws** - - - `FileNotFoundException `__ - if the Realm file doesn't exist. - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _Realm_removeAllChangeListeners: - -.. _Realm_removeAllChangeListeners__: - -.. _io_realm_Realm_removeAllChangeListeners: - -.. _io_realm_Realm_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _Realm_removeChangeListener: - -.. _Realm_removeChangeListener__: - -.. _io_realm_Realm_removeChangeListener: - -.. _io_realm_Realm_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_Realm_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_Realm_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _Realm_removeChangeListener_io_realm_RealmChangeListener_: - -.. _Realm_removeChangeListener_RealmChangeListener_: - -.. _io_realm_Realm_removeChangeListener_RealmChangeListener_Realm__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeDefaultConfiguration: - -.. _removeDefaultConfiguration__: - -.. _Realm_removeDefaultConfiguration: - -.. _Realm_removeDefaultConfiguration__: - -.. _io_realm_Realm_removeDefaultConfiguration: - -.. _io_realm_Realm_removeDefaultConfiguration__: - - - -removeDefaultConfiguration --------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`removeDefaultConfiguration ` () - | - - - - - * - Removes the current default configuration (if any). Any further calls to :ref:`getDefaultInstance() ` will fail until a new default configuration has been set using :ref:`setDefaultConfiguration(RealmConfiguration) ` . - - - - - - - - - - - - - - - - - -.. _setDefaultConfiguration: - -.. _setDefaultConfiguration__: - -.. _Realm_setDefaultConfiguration: - -.. _Realm_setDefaultConfiguration__: - -.. _io_realm_Realm_setDefaultConfiguration: - -.. _io_realm_Realm_setDefaultConfiguration__: - - - -setDefaultConfiguration ------------------------ - -.. _io_realm_Realm_setDefaultConfiguration_io_realm_RealmConfiguration_: - -.. _io_realm_Realm_setDefaultConfiguration_RealmConfiguration_: - -.. _setDefaultConfiguration_io_realm_RealmConfiguration_: - -.. _setDefaultConfiguration_RealmConfiguration_: - -.. _Realm_setDefaultConfiguration_io_realm_RealmConfiguration_: - -.. _Realm_setDefaultConfiguration_RealmConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`setDefaultConfiguration ` ( - | :ref:`RealmConfiguration ` configuration - | ) - - - - - * - Sets the :ref:`io.realm.RealmConfiguration ` used when calling :ref:`getDefaultInstance() ` . - - - - - - - **Parameters** - - - ``configuration`` - the :ref:`io.realm.RealmConfiguration ` to use as the default configuration. - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a null :ref:`RealmConfiguration ` is provided. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmConfiguration for details on how to configure a Realm. ` - - - - - - - - - - - - -.. _where: - -.. _where__: - -.. _Realm_where: - -.. _Realm_where__: - -.. _io_realm_Realm_where: - -.. _io_realm_Realm_where__: - - - -where ------ - -.. _io_realm_Realm_where_java_lang_Class_: - -.. _io_realm_Realm_where_Class_: - -.. _where_java_lang_Class_: - -.. _where_Class_: - -.. _Realm_where_java_lang_Class_: - -.. _Realm_where_Class_: - -.. _io_realm_Realm_where_Class_E__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` <**E** >( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Returns a typed RealmQuery, which can be used to query for specific objects of this type - - - - - **Parameters** - - - ``clazz`` - the class of the object which is to be queried for. - - - - - - - - **Returns** - - a typed RealmQuery, which can be used to query for specific objects of this type. - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmQuery ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm/Callback.txt b/source/sdk/java/api/io/realm/Realm/Callback.txt deleted file mode 100644 index 36fa8082d6..0000000000 --- a/source/sdk/java/api/io/realm/Realm/Callback.txt +++ /dev/null @@ -1,274 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Realm.Callback -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_Realm_Callback: - - - -io.realm -======== - - - | `java.lang.Object `__ - | **io.realm.BaseRealm.InstanceCallback** - | io.realm.Realm.Callback - - - - -**Enclosing class:** - -:ref:`Realm ` - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Callback ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - Deliver an error happens when creating the Realm instance to the caller thread. - - - - - * - public abstract **void** - - | :ref:`onSuccess ` ( - | :ref:`Realm ` realm - | ) - - - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class **io.realm.BaseRealm.InstanceCallback**: ``onSuccess`` , ``onError`` - - - - -Constructor Detail -================== - -.. _Callback: - -.. _Callback__: - -.. _io_realm_Realm_Callback: - -.. _io_realm_Realm_Callback__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Callback ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _Callback_onError: - -.. _Callback_onError__: - -.. _Realm_Callback_onError: - -.. _Realm_Callback_onError__: - -.. _io_realm_Realm_Callback_onError: - -.. _io_realm_Realm_Callback_onError__: - - - -onError -------- - -.. _io_realm_Realm_Callback_onError_java_lang_Throwable_: - -.. _io_realm_Realm_Callback_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _Realm_Callback_onError_java_lang_Throwable_: - -.. _Realm_Callback_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - - - * - Deliver an error happens when creating the Realm instance to the caller thread. The default implementation will throw an exception on the caller thread. - - - - - - - - - - - **Overrides** - - ``onError`` in class **InstanceCallback** - - - - - - -.. _onSuccess: - -.. _onSuccess__: - -.. _Callback_onSuccess: - -.. _Callback_onSuccess__: - -.. _Realm_Callback_onSuccess: - -.. _Realm_Callback_onSuccess__: - -.. _io_realm_Realm_Callback_onSuccess: - -.. _io_realm_Realm_Callback_onSuccess__: - - - -onSuccess ---------- - -.. _io_realm_Realm_Callback_onSuccess_io_realm_Realm_: - -.. _io_realm_Realm_Callback_onSuccess_Realm_: - -.. _onSuccess_io_realm_Realm_: - -.. _onSuccess_Realm_: - -.. _Realm_Callback_onSuccess_io_realm_Realm_: - -.. _Realm_Callback_onSuccess_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`onSuccess ` ( - | :ref:`Realm ` realm - | ) - - - - - * - - - - - - - - - - - - - - **Overrides** - - ``onSuccess`` in class **InstanceCallback** - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm/Transaction.txt b/source/sdk/java/api/io/realm/Realm/Transaction.txt deleted file mode 100644 index dc8ef4e3e8..0000000000 --- a/source/sdk/java/api/io/realm/Realm/Transaction.txt +++ /dev/null @@ -1,147 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface Realm.Transaction -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_Realm_Transaction: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`Realm ` - - - -Encapsulates a Realm transaction.Using this class will automatically handle **io.realm.Realm.beginTransaction()** and **io.realm.Realm.commitTransaction()** If any exception is thrown during the transaction **io.realm.Realm.cancelTransaction()** will be called instead of **io.realm.Realm.commitTransaction()**. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`Realm.Transaction.Callback ` - - - * - ``public static interface`` - - :ref:`Realm.Transaction.OnSuccess ` - - - * - ``public static interface`` - - :ref:`Realm.Transaction.OnError ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`execute ` ( - | :ref:`Realm ` realm - | ) - - - - - - - - - - -Method Detail -============= - -.. _execute: - -.. _execute__: - -.. _Transaction_execute: - -.. _Transaction_execute__: - -.. _Realm_Transaction_execute: - -.. _Realm_Transaction_execute__: - -.. _io_realm_Realm_Transaction_execute: - -.. _io_realm_Realm_Transaction_execute__: - - - -execute -------- - -.. _io_realm_Realm_Transaction_execute_io_realm_Realm_: - -.. _io_realm_Realm_Transaction_execute_Realm_: - -.. _execute_io_realm_Realm_: - -.. _execute_Realm_: - -.. _Realm_Transaction_execute_io_realm_Realm_: - -.. _Realm_Transaction_execute_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`execute ` ( - | :ref:`Realm ` realm - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt b/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt deleted file mode 100644 index e94fe989ed..0000000000 --- a/source/sdk/java/api/io/realm/Realm/Transaction/Callback.txt +++ /dev/null @@ -1,244 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Realm.Transaction.Callback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_Realm_Transaction_Callback: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.Realm.Transaction.Callback - - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Callback ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Exception `__ ignore - | ) - - - - - - - - * - public **void** - - | :ref:`onSuccess ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Callback: - -.. _Callback__: - -.. _io_realm_Realm_Transaction_Callback: - -.. _io_realm_Realm_Transaction_Callback__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Callback ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _Callback_onError: - -.. _Callback_onError__: - -.. _Realm_Transaction_Callback_onError: - -.. _Realm_Transaction_Callback_onError__: - -.. _io_realm_Realm_Transaction_Callback_onError: - -.. _io_realm_Realm_Transaction_Callback_onError__: - - - -onError -------- - -.. _io_realm_Realm_Transaction_Callback_onError_java_lang_Exception_: - -.. _io_realm_Realm_Transaction_Callback_onError_Exception_: - -.. _onError_java_lang_Exception_: - -.. _onError_Exception_: - -.. _Realm_Transaction_Callback_onError_java_lang_Exception_: - -.. _Realm_Transaction_Callback_onError_Exception_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Exception `__ ignore - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _onSuccess: - -.. _onSuccess__: - -.. _Callback_onSuccess: - -.. _Callback_onSuccess__: - -.. _Realm_Transaction_Callback_onSuccess: - -.. _Realm_Transaction_Callback_onSuccess__: - -.. _io_realm_Realm_Transaction_Callback_onSuccess: - -.. _io_realm_Realm_Transaction_Callback_onSuccess__: - - - -onSuccess ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onSuccess ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt b/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt deleted file mode 100644 index d4d9f74de1..0000000000 --- a/source/sdk/java/api/io/realm/Realm/Transaction/OnError.txt +++ /dev/null @@ -1,121 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface Realm.Transaction.OnError -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_Realm_Transaction_OnError: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread about error during the transaction. The transaction will be rolled back and the background Realm will be closed before invoking :ref:`onError(Throwable) ` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ error - | ) - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _OnError_onError: - -.. _OnError_onError__: - -.. _Realm_Transaction_OnError_onError: - -.. _Realm_Transaction_OnError_onError__: - -.. _io_realm_Realm_Transaction_OnError_onError: - -.. _io_realm_Realm_Transaction_OnError_onError__: - - - -onError -------- - -.. _io_realm_Realm_Transaction_OnError_onError_java_lang_Throwable_: - -.. _io_realm_Realm_Transaction_OnError_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _Realm_Transaction_OnError_onError_java_lang_Throwable_: - -.. _Realm_Transaction_OnError_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ error - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Realm/Transaction/OnSuccess.txt b/source/sdk/java/api/io/realm/Realm/Transaction/OnSuccess.txt deleted file mode 100644 index 8f6211f962..0000000000 --- a/source/sdk/java/api/io/realm/Realm/Transaction/OnSuccess.txt +++ /dev/null @@ -1,105 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface Realm.Transaction.OnSuccess -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_Realm_Transaction_OnSuccess: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`Transaction ` - - - -Callback invoked to notify the caller thread about the success of the transaction. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onSuccess ` () - | - - - - - - - - - - -Method Detail -============= - -.. _onSuccess: - -.. _onSuccess__: - -.. _OnSuccess_onSuccess: - -.. _OnSuccess_onSuccess__: - -.. _Realm_Transaction_OnSuccess_onSuccess: - -.. _Realm_Transaction_OnSuccess_onSuccess__: - -.. _io_realm_Realm_Transaction_OnSuccess_onSuccess: - -.. _io_realm_Realm_Transaction_OnSuccess_onSuccess__: - - - -onSuccess ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onSuccess ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmAny.txt b/source/sdk/java/api/io/realm/RealmAny.txt deleted file mode 100644 index 949ccba9c3..0000000000 --- a/source/sdk/java/api/io/realm/RealmAny.txt +++ /dev/null @@ -1,2371 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmAny -^^^^^^^^^^^^^^ - -.. _io_realm_RealmAny: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmAny - - -:ref:`io.realm.RealmAny ` is used to represent a polymorphic Realm value. - -At any particular moment an instance of this class stores a definite value of a definite type. If, for instance, that is an double value, you may call asDouble() to extract that value. You may call getType() to discover what type of value is currently stored. Calling asDouble() on an instance that does not store an double would raise a `java.lang.ClassCastException `__ . - - - -RealmAny behaves like a value type on all the supported types except on Realm objects. It means that Realm will not persist any change to the RealmAny value except when the type is Realm object. When a RealmAny holds a Realm object, it just holds the reference to it, not a copy of the object. So modifications to the Realm object are reflected in the RealmAny value, including if the object is deleted. Because RealmAny instances are immutable, a new instance is needed to update a RealmAny attribute. - - - -.. code-block:: java - - - anObject.realmAnyAttribute = RealmAny.valueOf(5); - anObject.realmAnyAttribute = RealmAny.valueOf(10.f); - - - -It is crucial to understand that the act of extracting a value of a particular type requires definite knowledge about the stored type. Calling a getter method for any particular type, that is not the same type as the stored value, would raise an exception.Our recommendation to handle the RealmAny polymorphism is to write a switch case around the RealmAny type and its inner value class. - - - -.. code-block:: java - - - RealmAny realmAny = aRealmObject.realmAnyAttribute; - - switch (realmAny.getType()) { - case OBJECT: - if (realmAny.getValueClass().equals(DogRealmModel.class)) { - DogRealmModel value = realmAny.asRealmModel(DogRealmModel.class); - } - case INTEGER: - performAction(realmAny.asInteger()); - break; - case BOOLEAN: - performAction(realmAny.asBoolean()); - break; - case STRING: - performAction(realmAny.asString()); - break; - case BINARY: - performAction(realmAny.asBinary()); - break; - case DATE: - performAction(realmAny.asDate()); - break; - case FLOAT: - performAction(realmAny.asFloat()); - break; - case DOUBLE: - performAction(realmAny.asDouble()); - break; - case DECIMAL128: - performAction(realmAny.asDecimal128()); - break; - case OBJECT_ID: - performAction(realmAny.asObjectId()); - break; - case UUID: - performAction(realmAny.asUUID()); - break; - case NULL: - performNullAction(); - break; - } - - - -getValueClass() returns the Java class that represents the inner value wrapped by the RealmAny instance. If the resulting class is a realization of :ref:`io.realm.RealmModel ` asRealmModel() can be called to cast the RealmAny value to a Realm object reference. - - - -RealmAny values can also be sorted. The sorting order used between different RealmAny types, from lowest to highest, is: - - - -1. Boolean - - -#. Byte/Short/Integer/Long/Float/Double/Decimal128 - - -#. byte[]/String - - -#. Date - - -#. ObjectId - - -#. UUID - - -#. RealmObject - - - - -This has implications on how :ref:`RealmQuery.sort(String) ` , :ref:`RealmQuery.minRealmAny(String) ` and :ref:`RealmQuery.maxRealmAny(String) ` work. Especially ``min()`` and ``max()`` will not only take numeric fields into account, but will use the sorting order to determine the "largest" or "lowest" value. - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`RealmAny.Type ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **byte** - - | :ref:`asBinary ` () - | - - - Gets this value as a byte[] if it is one, otherwise throws exception. - - - - - * - public `Boolean `__ - - | :ref:`asBoolean ` () - | - - - Gets this value as a Boolean if it is one, otherwise throws exception. - - - - - * - public `Byte `__ - - | :ref:`asByte ` () - | - - - Gets this value as a Byte if it is one, otherwise throws exception. - - - - - * - public `Date `__ - - | :ref:`asDate ` () - | - - - Gets this value as a Date if it is one, otherwise throws exception. - - - - - * - public **Decimal128** - - | :ref:`asDecimal128 ` () - | - - - Gets this value as a Decimal128 if it is one, otherwise throws exception. - - - - - * - public `Double `__ - - | :ref:`asDouble ` () - | - - - Gets this value as a Double if it is one, otherwise throws exception. - - - - - * - public `Float `__ - - | :ref:`asFloat ` () - | - - - Gets this value as a Float if it is one, otherwise throws exception. - - - - - * - public `Integer `__ - - | :ref:`asInteger ` () - | - - - Gets this value as a Integer if it is one, otherwise throws exception. - - - - - * - public `Long `__ - - | :ref:`asLong ` () - | - - - Gets this value as a Long if it is one, otherwise throws exception. - - - - - * - public **ObjectId** - - | :ref:`asObjectId ` () - | - - - Gets this value as a ObjectId if it is one, otherwise throws exception. - - - - - * - public **T** - - | :ref:`asRealmModel ` <**T** >( - | `java.lang.Class\ `__ clazz - | ) - - - Gets this value as a RealmModel if it is one, otherwise throws exception. - - - - - * - public `Short `__ - - | :ref:`asShort ` () - | - - - Gets this value as a Short if it is one, otherwise throws exception. - - - - - * - public `String `__ - - | :ref:`asString ` () - | - - - Gets this value as a String if it is one, otherwise throws exception. - - - - - * - public `UUID `__ - - | :ref:`asUUID ` () - | - - - Gets this value as a UUID if it is one, otherwise throws exception. - - - - - * - public final **boolean** - - | :ref:`coercedEquals ` ( - | :ref:`RealmAny ` other - | ) - - - - - - - - * - public final **boolean** - - | :ref:`equals ` ( - | `Object `__ other - | ) - - - Two ``RealmAny`` s are ``.equals`` if and only if their contents are equal. - - - - - - - * - public :ref:`RealmAny.Type ` - - | :ref:`getType ` () - | - - - Gets the inner type of this RealmAny object. - - - - - * - public `Class `__ - - | :ref:`getValueClass ` () - | - - - Returns the Java class that represents the inner value wrapped by this RealmAny value. - - - - - * - public final **int** - - | :ref:`hashCode ` () - | - - - A ``RealmAny`` 's hash code is, exactly, the hash code of its value. - - - - - - - * - public **boolean** - - | :ref:`isNull ` () - | - - - Returns true if the inner value is null, false otherwise. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`nullValue ` () - | - - - Creates a new RealmAny of a null value. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | **Decimal128** value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | **ObjectId** value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Date `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | **byte[]** value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `String `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Double `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Float `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Boolean `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Long `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Integer `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Short `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - * - public static :ref:`RealmAny ` - - | :ref:`valueOf ` ( - | `Byte `__ value - | ) - - - Creates a new RealmAny with the specified value. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _asBinary: - -.. _asBinary__: - -.. _RealmAny_asBinary: - -.. _RealmAny_asBinary__: - -.. _io_realm_RealmAny_asBinary: - -.. _io_realm_RealmAny_asBinary__: - - - -asBinary --------- - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`asBinary ` () - | - - - - - * - Gets this value as a byte[] if it is one, otherwise throws exception. - - - - - - - **Returns** - - a byte[]. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asBoolean: - -.. _asBoolean__: - -.. _RealmAny_asBoolean: - -.. _RealmAny_asBoolean__: - -.. _io_realm_RealmAny_asBoolean: - -.. _io_realm_RealmAny_asBoolean__: - - - -asBoolean ---------- - -.. list-table:: - :header-rows: 1 - - * - | public `Boolean `__ :ref:`asBoolean ` () - | - - - - - * - Gets this value as a Boolean if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Boolean. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asByte: - -.. _asByte__: - -.. _RealmAny_asByte: - -.. _RealmAny_asByte__: - -.. _io_realm_RealmAny_asByte: - -.. _io_realm_RealmAny_asByte__: - - - -asByte ------- - -.. list-table:: - :header-rows: 1 - - * - | public `Byte `__ :ref:`asByte ` () - | - - - - - * - Gets this value as a Byte if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Byte. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asDate: - -.. _asDate__: - -.. _RealmAny_asDate: - -.. _RealmAny_asDate__: - -.. _io_realm_RealmAny_asDate: - -.. _io_realm_RealmAny_asDate__: - - - -asDate ------- - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`asDate ` () - | - - - - - * - Gets this value as a Date if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Date. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asDecimal128: - -.. _asDecimal128__: - -.. _RealmAny_asDecimal128: - -.. _RealmAny_asDecimal128__: - -.. _io_realm_RealmAny_asDecimal128: - -.. _io_realm_RealmAny_asDecimal128__: - - - -asDecimal128 ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **Decimal128** :ref:`asDecimal128 ` () - | - - - - - * - Gets this value as a Decimal128 if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Decimal128. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asDouble: - -.. _asDouble__: - -.. _RealmAny_asDouble: - -.. _RealmAny_asDouble__: - -.. _io_realm_RealmAny_asDouble: - -.. _io_realm_RealmAny_asDouble__: - - - -asDouble --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Double `__ :ref:`asDouble ` () - | - - - - - * - Gets this value as a Double if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Double. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asFloat: - -.. _asFloat__: - -.. _RealmAny_asFloat: - -.. _RealmAny_asFloat__: - -.. _io_realm_RealmAny_asFloat: - -.. _io_realm_RealmAny_asFloat__: - - - -asFloat -------- - -.. list-table:: - :header-rows: 1 - - * - | public `Float `__ :ref:`asFloat ` () - | - - - - - * - Gets this value as a Float if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Float. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asInteger: - -.. _asInteger__: - -.. _RealmAny_asInteger: - -.. _RealmAny_asInteger__: - -.. _io_realm_RealmAny_asInteger: - -.. _io_realm_RealmAny_asInteger__: - - - -asInteger ---------- - -.. list-table:: - :header-rows: 1 - - * - | public `Integer `__ :ref:`asInteger ` () - | - - - - - * - Gets this value as a Integer if it is one, otherwise throws exception. - - - - - - - **Returns** - - an Integer. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asLong: - -.. _asLong__: - -.. _RealmAny_asLong: - -.. _RealmAny_asLong__: - -.. _io_realm_RealmAny_asLong: - -.. _io_realm_RealmAny_asLong__: - - - -asLong ------- - -.. list-table:: - :header-rows: 1 - - * - | public `Long `__ :ref:`asLong ` () - | - - - - - * - Gets this value as a Long if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Long. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asObjectId: - -.. _asObjectId__: - -.. _RealmAny_asObjectId: - -.. _RealmAny_asObjectId__: - -.. _io_realm_RealmAny_asObjectId: - -.. _io_realm_RealmAny_asObjectId__: - - - -asObjectId ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **ObjectId** :ref:`asObjectId ` () - | - - - - - * - Gets this value as a ObjectId if it is one, otherwise throws exception. - - - - - - - **Returns** - - an ObjectId. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asRealmModel: - -.. _asRealmModel__: - -.. _RealmAny_asRealmModel: - -.. _RealmAny_asRealmModel__: - -.. _io_realm_RealmAny_asRealmModel: - -.. _io_realm_RealmAny_asRealmModel__: - - - -asRealmModel ------------- - -.. _io_realm_RealmAny_asRealmModel_java_lang_Class_: - -.. _io_realm_RealmAny_asRealmModel_Class_: - -.. _asRealmModel_java_lang_Class_: - -.. _asRealmModel_Class_: - -.. _RealmAny_asRealmModel_java_lang_Class_: - -.. _RealmAny_asRealmModel_Class_: - -.. _io_realm_RealmAny_asRealmModel_Class_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`asRealmModel ` <**T** >( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Gets this value as a RealmModel if it is one, otherwise throws exception. - - - **Type Parameters** - - - ``T`` - the RealmModel type to cast the inner value to. - - - - - - - - - - **Returns** - - a RealmModel of the T type. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asShort: - -.. _asShort__: - -.. _RealmAny_asShort: - -.. _RealmAny_asShort__: - -.. _io_realm_RealmAny_asShort: - -.. _io_realm_RealmAny_asShort__: - - - -asShort -------- - -.. list-table:: - :header-rows: 1 - - * - | public `Short `__ :ref:`asShort ` () - | - - - - - * - Gets this value as a Short if it is one, otherwise throws exception. - - - - - - - **Returns** - - a Short. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asString: - -.. _asString__: - -.. _RealmAny_asString: - -.. _RealmAny_asString__: - -.. _io_realm_RealmAny_asString: - -.. _io_realm_RealmAny_asString__: - - - -asString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`asString ` () - | - - - - - * - Gets this value as a String if it is one, otherwise throws exception. - - - - - - - **Returns** - - a String. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _asUUID: - -.. _asUUID__: - -.. _RealmAny_asUUID: - -.. _RealmAny_asUUID__: - -.. _io_realm_RealmAny_asUUID: - -.. _io_realm_RealmAny_asUUID__: - - - -asUUID ------- - -.. list-table:: - :header-rows: 1 - - * - | public `UUID `__ :ref:`asUUID ` () - | - - - - - * - Gets this value as a UUID if it is one, otherwise throws exception. - - - - - - - **Returns** - - an UUID. - - - - - **Throws** - - - `java.lang.ClassCastException `__ - if this value is not of the expected type. - - - - - - - - - - - - -.. _coercedEquals: - -.. _coercedEquals__: - -.. _RealmAny_coercedEquals: - -.. _RealmAny_coercedEquals__: - -.. _io_realm_RealmAny_coercedEquals: - -.. _io_realm_RealmAny_coercedEquals__: - - - -coercedEquals -------------- - -.. _io_realm_RealmAny_coercedEquals_io_realm_RealmAny_: - -.. _io_realm_RealmAny_coercedEquals_RealmAny_: - -.. _coercedEquals_io_realm_RealmAny_: - -.. _coercedEquals_RealmAny_: - -.. _RealmAny_coercedEquals_io_realm_RealmAny_: - -.. _RealmAny_coercedEquals_RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`coercedEquals ` ( - | :ref:`RealmAny ` other - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _RealmAny_equals: - -.. _RealmAny_equals__: - -.. _io_realm_RealmAny_equals: - -.. _io_realm_RealmAny_equals__: - - - -equals ------- - -.. _io_realm_RealmAny_equals_java_lang_Object_: - -.. _io_realm_RealmAny_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _RealmAny_equals_java_lang_Object_: - -.. _RealmAny_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`equals ` ( - | `Object `__ other - | ) - - - - - * - Two ``RealmAny`` s are ``.equals`` if and only if their contents are equal. - - - - - - - **Parameters** - - - ``other`` - compare target - - - - - - - - **Returns** - - true if the target has the same value - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getType: - -.. _getType__: - -.. _RealmAny_getType: - -.. _RealmAny_getType__: - -.. _io_realm_RealmAny_getType: - -.. _io_realm_RealmAny_getType__: - - - -getType -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAny.Type ` :ref:`getType ` () - | - - - - - * - Gets the inner type of this RealmAny object. - - - - - - - **Returns** - - the inner RealmAny.Type - - - - - - - - - - - -.. _getValueClass: - -.. _getValueClass__: - -.. _RealmAny_getValueClass: - -.. _RealmAny_getValueClass__: - -.. _io_realm_RealmAny_getValueClass: - -.. _io_realm_RealmAny_getValueClass__: - - - -getValueClass -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Class `__ :ref:`getValueClass ` () - | - - - - - * - Returns the Java class that represents the inner value wrapped by this RealmAny value. - - - - - - - **Returns** - - the class that represents the inner value wrapped by this RealmAny value. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _RealmAny_hashCode: - -.. _RealmAny_hashCode__: - -.. _io_realm_RealmAny_hashCode: - -.. _io_realm_RealmAny_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public final **int** :ref:`hashCode ` () - | - - - - - * - A ``RealmAny`` 's hash code is, exactly, the hash code of its value. - - - - - - - - - **Returns** - - true if the target has the same value - - - - - **Throws** - - - `NullPointerException `__ - if the inner value is null - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isNull: - -.. _isNull__: - -.. _RealmAny_isNull: - -.. _RealmAny_isNull__: - -.. _io_realm_RealmAny_isNull: - -.. _io_realm_RealmAny_isNull__: - - - -isNull ------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isNull ` () - | - - - - - * - Returns true if the inner value is null, false otherwise. - - - - - - - **Returns** - - true if the inner value is null, false otherwise. - - - - - - - - - - - -.. _nullValue: - -.. _nullValue__: - -.. _RealmAny_nullValue: - -.. _RealmAny_nullValue__: - -.. _io_realm_RealmAny_nullValue: - -.. _io_realm_RealmAny_nullValue__: - - - -nullValue ---------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`nullValue ` () - | - - - - - * - Creates a new RealmAny of a null value. - - - - - - - **Returns** - - a new RealmAny instance of a null value. - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _RealmAny_toString: - -.. _RealmAny_toString__: - -.. _io_realm_RealmAny_toString: - -.. _io_realm_RealmAny_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _RealmAny_valueOf: - -.. _RealmAny_valueOf__: - -.. _io_realm_RealmAny_valueOf: - -.. _io_realm_RealmAny_valueOf__: - - - -valueOf -------- - -.. _io_realm_RealmAny_valueOf_Decimal128_: - -.. _valueOf_Decimal128_: - -.. _RealmAny_valueOf_Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | **Decimal128** value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DECIMAL128 ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Decimal128. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_ObjectId_: - -.. _valueOf_ObjectId_: - -.. _RealmAny_valueOf_ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | **ObjectId** value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.OBJECT_ID ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of an ObjectId. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_util_Date_: - -.. _io_realm_RealmAny_valueOf_Date_: - -.. _valueOf_java_util_Date_: - -.. _valueOf_Date_: - -.. _RealmAny_valueOf_java_util_Date_: - -.. _RealmAny_valueOf_Date_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Date `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DATE ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Date. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_byte_: - -.. _io_realm_RealmAny_valueOf_byte____: - -.. _valueOf_byte_: - -.. _valueOf_byte____: - -.. _RealmAny_valueOf_byte_: - -.. _RealmAny_valueOf_byte____: - -.. _io_realm_RealmAny_valueOf_byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | **byte[]** value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.BINARY ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a byte[]. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_String_: - -.. _io_realm_RealmAny_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _RealmAny_valueOf_java_lang_String_: - -.. _RealmAny_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `String `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.STRING ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a String. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Double_: - -.. _io_realm_RealmAny_valueOf_Double_: - -.. _valueOf_java_lang_Double_: - -.. _valueOf_Double_: - -.. _RealmAny_valueOf_java_lang_Double_: - -.. _RealmAny_valueOf_Double_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Double `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.DOUBLE ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Double. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Float_: - -.. _io_realm_RealmAny_valueOf_Float_: - -.. _valueOf_java_lang_Float_: - -.. _valueOf_Float_: - -.. _RealmAny_valueOf_java_lang_Float_: - -.. _RealmAny_valueOf_Float_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Float `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.FLOAT ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Float. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Boolean_: - -.. _io_realm_RealmAny_valueOf_Boolean_: - -.. _valueOf_java_lang_Boolean_: - -.. _valueOf_Boolean_: - -.. _RealmAny_valueOf_java_lang_Boolean_: - -.. _RealmAny_valueOf_Boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Boolean `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.BOOLEAN ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Boolean. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Long_: - -.. _io_realm_RealmAny_valueOf_Long_: - -.. _valueOf_java_lang_Long_: - -.. _valueOf_Long_: - -.. _RealmAny_valueOf_java_lang_Long_: - -.. _RealmAny_valueOf_Long_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Long `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Long. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Integer_: - -.. _io_realm_RealmAny_valueOf_Integer_: - -.. _valueOf_java_lang_Integer_: - -.. _valueOf_Integer_: - -.. _RealmAny_valueOf_java_lang_Integer_: - -.. _RealmAny_valueOf_Integer_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Integer `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Integer. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Short_: - -.. _io_realm_RealmAny_valueOf_Short_: - -.. _valueOf_java_lang_Short_: - -.. _valueOf_Short_: - -.. _RealmAny_valueOf_java_lang_Short_: - -.. _RealmAny_valueOf_Short_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Short `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny of a Short. - - - - - - - - - -.. _io_realm_RealmAny_valueOf_java_lang_Byte_: - -.. _io_realm_RealmAny_valueOf_Byte_: - -.. _valueOf_java_lang_Byte_: - -.. _valueOf_Byte_: - -.. _RealmAny_valueOf_java_lang_Byte_: - -.. _RealmAny_valueOf_Byte_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny ` :ref:`valueOf ` ( - | `Byte `__ value - | ) - - - - - * - Creates a new RealmAny with the specified value. If the value is not null the type will be :ref:`RealmAny.Type.INTEGER ` , :ref:`RealmAny.Type.NULL ` otherwise. - - - - - - - **Parameters** - - - ``value`` - the RealmAny value. - - - - - - - - **Returns** - - a new RealmAny containing a Byte value. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmAny/Type.txt b/source/sdk/java/api/io/realm/RealmAny/Type.txt deleted file mode 100644 index 49de9562ba..0000000000 --- a/source/sdk/java/api/io/realm/RealmAny/Type.txt +++ /dev/null @@ -1,592 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum RealmAny.Type -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmAny_Type: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.RealmAny.Type - - - - -**Enclosing class:** - -:ref:`RealmAny ` - - - -Enum describing all the types supported by RealmAny. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`BINARY ` - - - - - - - * - :ref:`BOOLEAN ` - - - - - - - * - :ref:`DATE ` - - - - - - - * - :ref:`DECIMAL128 ` - - - - - - - * - :ref:`DOUBLE ` - - - - - - - * - :ref:`FLOAT ` - - - - - - - * - :ref:`INTEGER ` - - - - - - - * - :ref:`NULL ` - - - - - - - * - :ref:`OBJECT ` - - - - - - - * - :ref:`OBJECT_ID ` - - - - - - - * - :ref:`STRING ` - - - - - - - * - :ref:`UUID ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`RealmAny.Type ` - - | :ref:`fromNativeValue ` ( - | **int** realmFieldType - | ) - - - - - - - - * - public `Class `__ - - | :ref:`getTypedClass ` () - | - - - - - - - - * - public static :ref:`RealmAny.Type ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`RealmAny.Type ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_RealmAny_Type_BINARY: - -.. _RealmAny_Type_BINARY: - - - -``BINARY`` ------------ - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_BOOLEAN: - -.. _RealmAny_Type_BOOLEAN: - - - -``BOOLEAN`` ------------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_DATE: - -.. _RealmAny_Type_DATE: - - - -``DATE`` ---------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_DECIMAL128: - -.. _RealmAny_Type_DECIMAL128: - - - -``DECIMAL128`` ---------------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_DOUBLE: - -.. _RealmAny_Type_DOUBLE: - - - -``DOUBLE`` ------------ - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_FLOAT: - -.. _RealmAny_Type_FLOAT: - - - -``FLOAT`` ----------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_INTEGER: - -.. _RealmAny_Type_INTEGER: - - - -``INTEGER`` ------------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_NULL: - -.. _RealmAny_Type_NULL: - - - -``NULL`` ---------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_OBJECT: - -.. _RealmAny_Type_OBJECT: - - - -``OBJECT`` ------------ - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_OBJECT_ID: - -.. _RealmAny_Type_OBJECT_ID: - - - -``OBJECT_ID`` --------------- - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_STRING: - -.. _RealmAny_Type_STRING: - - - -``STRING`` ------------ - -public static final :ref:`RealmAny.Type ` - - - - - -.. _io_realm_RealmAny_Type_UUID: - -.. _RealmAny_Type_UUID: - - - -``UUID`` ---------- - -public static final :ref:`RealmAny.Type ` - - - - - - -Method Detail -============= - -.. _fromNativeValue: - -.. _fromNativeValue__: - -.. _Type_fromNativeValue: - -.. _Type_fromNativeValue__: - -.. _RealmAny_Type_fromNativeValue: - -.. _RealmAny_Type_fromNativeValue__: - -.. _io_realm_RealmAny_Type_fromNativeValue: - -.. _io_realm_RealmAny_Type_fromNativeValue__: - - - -fromNativeValue ---------------- - -.. _io_realm_RealmAny_Type_fromNativeValue_int_: - -.. _fromNativeValue_int_: - -.. _RealmAny_Type_fromNativeValue_int_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny.Type ` :ref:`fromNativeValue ` ( - | **int** realmFieldType - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getTypedClass: - -.. _getTypedClass__: - -.. _Type_getTypedClass: - -.. _Type_getTypedClass__: - -.. _RealmAny_Type_getTypedClass: - -.. _RealmAny_Type_getTypedClass__: - -.. _io_realm_RealmAny_Type_getTypedClass: - -.. _io_realm_RealmAny_Type_getTypedClass__: - - - -getTypedClass -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Class `__ :ref:`getTypedClass ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _Type_valueOf: - -.. _Type_valueOf__: - -.. _RealmAny_Type_valueOf: - -.. _RealmAny_Type_valueOf__: - -.. _io_realm_RealmAny_Type_valueOf: - -.. _io_realm_RealmAny_Type_valueOf__: - - - -valueOf -------- - -.. _io_realm_RealmAny_Type_valueOf_java_lang_String_: - -.. _io_realm_RealmAny_Type_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _RealmAny_Type_valueOf_java_lang_String_: - -.. _RealmAny_Type_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny.Type ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Type_values: - -.. _Type_values__: - -.. _RealmAny_Type_values: - -.. _RealmAny_Type_values__: - -.. _io_realm_RealmAny_Type_values: - -.. _io_realm_RealmAny_Type_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmAny.Type ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt b/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt deleted file mode 100644 index 4301db3b13..0000000000 --- a/source/sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl.txt +++ /dev/null @@ -1,397 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmAnyNativeFunctionsImpl -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmAnyNativeFunctionsImpl: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmAnyNativeFunctionsImpl - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmAnyNativeFunctionsImpl ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`callRawPredicate ` ( - | **TableQuery** query, - | **OsKeyPathMapping** mapping, - | `String `__ predicate, - | :ref:`io.realm.RealmAny[] ` arguments - | ) - - - - - - - - * - public **void** - - | :ref:`handleItem ` ( - | **long** containerPtr, - | `java.util.Map.Entry\ `__ entry - | ) - - - - - - - - * - public **void** - - | :ref:`handleItem ` ( - | **long** listPtr, - | :ref:`RealmAny ` realmAny - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmAnyNativeFunctionsImpl: - -.. _RealmAnyNativeFunctionsImpl__: - -.. _io_realm_RealmAnyNativeFunctionsImpl: - -.. _io_realm_RealmAnyNativeFunctionsImpl__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAnyNativeFunctionsImpl ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _callRawPredicate: - -.. _callRawPredicate__: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate__: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate__: - - - -callRawPredicate ----------------- - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: - -.. _io_realm_RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: - -.. _callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: - -.. _callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_java_lang_String_RealmAny____: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__java_lang_String__RealmAny____: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery_OsKeyPathMapping_String_RealmAny____: - -.. _RealmAnyNativeFunctionsImpl_callRawPredicate_TableQuery__OsKeyPathMapping__String__RealmAny____: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`callRawPredicate ` ( - | **TableQuery** query, - | **OsKeyPathMapping** mapping, - | `String `__ predicate, - | :ref:`io.realm.RealmAny[] ` arguments - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _handleItem: - -.. _handleItem__: - -.. _RealmAnyNativeFunctionsImpl_handleItem: - -.. _RealmAnyNativeFunctionsImpl_handleItem__: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem__: - - - -handleItem ----------- - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_java_util_Map_Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__java_util_Map_Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_Map_Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_: - -.. _handleItem_long_java_util_Map_Entry_: - -.. _handleItem_long__java_util_Map_Entry_: - -.. _handleItem_long_Entry_: - -.. _handleItem_long__Entry_: - -.. _handleItem_long_Map_Entry_: - -.. _handleItem_long__Map_Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long_java_util_Map_Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long__java_util_Map_Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long_Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long__Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long_Map_Entry_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__Map_Entry_String__RealmAny__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`handleItem ` ( - | **long** containerPtr, - | `java.util.Map.Entry\ `__ entry - | ) - - - - - * - - - - - - - - - - - - - - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__io_realm_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long_RealmAny_: - -.. _io_realm_RealmAnyNativeFunctionsImpl_handleItem_long__RealmAny_: - -.. _handleItem_long_io_realm_RealmAny_: - -.. _handleItem_long__io_realm_RealmAny_: - -.. _handleItem_long_RealmAny_: - -.. _handleItem_long__RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long_io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long__io_realm_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long_RealmAny_: - -.. _RealmAnyNativeFunctionsImpl_handleItem_long__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`handleItem ` ( - | **long** listPtr, - | :ref:`RealmAny ` realmAny - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmAnyOperator.txt b/source/sdk/java/api/io/realm/RealmAnyOperator.txt deleted file mode 100644 index 648eddbdc2..0000000000 --- a/source/sdk/java/api/io/realm/RealmAnyOperator.txt +++ /dev/null @@ -1,174 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmAnyOperator -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmAnyOperator: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmAnyOperator - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`checkValidObject ` ( - | **BaseRealm** realm - | ) - - - - - - - - * - protected abstract **NativeRealmAny** - - | :ref:`createNativeRealmAny ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _checkValidObject: - -.. _checkValidObject__: - -.. _RealmAnyOperator_checkValidObject: - -.. _RealmAnyOperator_checkValidObject__: - -.. _io_realm_RealmAnyOperator_checkValidObject: - -.. _io_realm_RealmAnyOperator_checkValidObject__: - - - -checkValidObject ----------------- - -.. _io_realm_RealmAnyOperator_checkValidObject_io_realm_BaseRealm_: - -.. _io_realm_RealmAnyOperator_checkValidObject_BaseRealm_: - -.. _checkValidObject_io_realm_BaseRealm_: - -.. _checkValidObject_BaseRealm_: - -.. _RealmAnyOperator_checkValidObject_io_realm_BaseRealm_: - -.. _RealmAnyOperator_checkValidObject_BaseRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`checkValidObject ` ( - | **BaseRealm** realm - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _createNativeRealmAny: - -.. _createNativeRealmAny__: - -.. _RealmAnyOperator_createNativeRealmAny: - -.. _RealmAnyOperator_createNativeRealmAny__: - -.. _io_realm_RealmAnyOperator_createNativeRealmAny: - -.. _io_realm_RealmAnyOperator_createNativeRealmAny__: - - - -createNativeRealmAny --------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected abstract **NativeRealmAny** :ref:`createNativeRealmAny ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmAsyncTask.txt b/source/sdk/java/api/io/realm/RealmAsyncTask.txt deleted file mode 100644 index 2fab62cc46..0000000000 --- a/source/sdk/java/api/io/realm/RealmAsyncTask.txt +++ /dev/null @@ -1,156 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmAsyncTask -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmAsyncTask: - - - -io.realm -======== - -Represents a pending asynchronous Realm task, like asynchronous transactions.Users are responsible for maintaining a reference to ``RealmAsyncTask`` in order to call :ref:`cancel() ` in case of a configuration change for example (to avoid memory leak, as the transaction will post the result to the caller's thread callback). - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`cancel ` () - | - - - Attempts to cancel execution of this transaction (if it hasn't already completed or previously cancelled). - - - - - * - public **boolean** - - | :ref:`isCancelled ` () - | - - - Checks whether an attempt to cancel the transaction was performed. - - - - - - - -Method Detail -============= - -.. _cancel: - -.. _cancel__: - -.. _RealmAsyncTask_cancel: - -.. _RealmAsyncTask_cancel__: - -.. _io_realm_RealmAsyncTask_cancel: - -.. _io_realm_RealmAsyncTask_cancel__: - - - -cancel ------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`cancel ` () - | - - - - - * - Attempts to cancel execution of this transaction (if it hasn't already completed or previously cancelled). - - - - - - - - - - - - - - - -.. _isCancelled: - -.. _isCancelled__: - -.. _RealmAsyncTask_isCancelled: - -.. _RealmAsyncTask_isCancelled__: - -.. _io_realm_RealmAsyncTask_isCancelled: - -.. _io_realm_RealmAsyncTask_isCancelled__: - - - -isCancelled ------------ - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isCancelled ` () - | - - - - - * - Checks whether an attempt to cancel the transaction was performed. - - - - - - - **Returns** - - ``true`` if :ref:`cancel() ` has already been called, ``false`` otherwise. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmChangeListener.txt b/source/sdk/java/api/io/realm/RealmChangeListener.txt deleted file mode 100644 index bcdf225121..0000000000 --- a/source/sdk/java/api/io/realm/RealmChangeListener.txt +++ /dev/null @@ -1,137 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmChangeListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmChangeListener: - - - -io.realm -======== - -RealmChangeListener can be registered with a :ref:`Realm ` , :ref:`RealmResults ` or :ref:`RealmObject ` to receive a notification about updates. - -When registered against a ``Realm`` you'll get notified when a Realm instance has been updated. Register against a ``RealmResults`` , ``RealmList`` , ``RealmDictionary`` or ``RealmObject`` to only get notified about changes to them. - - - -Realm instances on a thread without an `android.os.Looper `__ cannot register a RealmChangeListener. - - - -All :ref:`io.realm.RealmObject ` and :ref:`io.realm.RealmResults ` will automatically contain their new values when the **onChange(Object)** method is called. Normally this means that it isn't necessary to query again for those objects, but just invalidate any UI elements that are using them. If there is a chance that a object has been been deleted, it can be verified by using :ref:`RealmObject.isValid() ` . - - - - - - -.. seealso:: - - - - - :ref:`Realm.addChangeListener(RealmChangeListener) ` - - - - - :ref:`Realm.removeAllChangeListeners() ` - - - - - :ref:`Realm.removeChangeListener(RealmChangeListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | **T** t - | ) - - - Called when a transaction is committed. - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _RealmChangeListener_onChange: - -.. _RealmChangeListener_onChange__: - -.. _io_realm_RealmChangeListener_onChange: - -.. _io_realm_RealmChangeListener_onChange__: - - - -onChange --------- - -.. _io_realm_RealmChangeListener_onChange_T_: - -.. _onChange_T_: - -.. _RealmChangeListener_onChange_T_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | **T** t - | ) - - - - - * - Called when a transaction is committed. - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmCollection.txt b/source/sdk/java/api/io/realm/RealmCollection.txt deleted file mode 100644 index 7885a5a71a..0000000000 --- a/source/sdk/java/api/io/realm/RealmCollection.txt +++ /dev/null @@ -1,1111 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmCollection -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmCollection: - - - -io.realm -======== - -**Implemented interfaces:** - - - -- `java.util.Collection `__ -- `java.lang.Iterable `__ - - -``RealmCollection`` is the root of the collection hierarchy that Realm supports. It defines operations on data collections and the behavior that they will have in all implementations of ``RealmCollection`` s. - -Realm collections are "live" views to the underlying data. This means that they automatically will be kept up to date. As a consequence, using methods like `Collections.unmodifiableCollection(Collection) `__ will not prevent a collection from being modified. - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **double** - - | :ref:`average ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public **boolean** - - | :ref:`contains ` ( - | `Object `__ object - | ) - - - Tests whether this ``Collection`` contains the specified object. - - - - - - - * - public **boolean** - - | :ref:`deleteAllFromRealm ` () - | - - - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - Checks if a collection has finished loading its data yet. - - - - - * - public **boolean** - - | :ref:`isManaged ` () - | - - - Checks if the collection is managed by Realm. - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. - - - - - - - * - public **boolean** - - | :ref:`load ` () - | - - - Blocks the collection until all data are available. - - - - - * - public `Number `__ - - | :ref:`max ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a field. - - - - - * - public `Date `__ - - | :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - Finds the maximum date. - - - - - * - public `Number `__ - - | :ref:`min ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a field. - - - - - * - public `Date `__ - - | :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - Finds the minimum date. - - - - - * - public `Number `__ - - | :ref:`sum ` ( - | `String `__ fieldName - | ) - - - Calculates the sum of a given field. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` () - | - - - Returns a :ref:`RealmQuery ` , which can be used to query for specific objects from this collection. - - - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _average: - -.. _average__: - -.. _RealmCollection_average: - -.. _RealmCollection_average__: - -.. _io_realm_RealmCollection_average: - -.. _io_realm_RealmCollection_average__: - - - -average -------- - -.. _io_realm_RealmCollection_average_java_lang_String_: - -.. _io_realm_RealmCollection_average_String_: - -.. _average_java_lang_String_: - -.. _average_String_: - -.. _RealmCollection_average_java_lang_String_: - -.. _RealmCollection_average_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`average ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. - - - - - **Parameters** - - - ``fieldName`` - the field to calculate average on. Only number fields are supported. - - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _contains: - -.. _contains__: - -.. _RealmCollection_contains: - -.. _RealmCollection_contains__: - -.. _io_realm_RealmCollection_contains: - -.. _io_realm_RealmCollection_contains__: - - - -contains --------- - -.. _io_realm_RealmCollection_contains_java_lang_Object_: - -.. _io_realm_RealmCollection_contains_Object_: - -.. _contains_java_lang_Object_: - -.. _contains_Object_: - -.. _RealmCollection_contains_java_lang_Object_: - -.. _RealmCollection_contains_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`contains ` ( - | `Object `__ object - | ) - - - - - * - Tests whether this ``Collection`` contains the specified object. Returns ``true`` if and only if at least one element ``elem`` in this ``Collection`` meets following requirement: ``(object==null ? elem==null : object.equals(elem))`` . - - - - - - - **Parameters** - - - ``object`` - the object to search for. - - - - - - - - **Returns** - - ``true`` if object is an element of this ``Collection`` , ``false`` otherwise. - - - - - - - **Throws** - - - `NullPointerException `__ - if the object to look for is ``null`` and this ``Collection`` doesn't support ``null`` elements. - - - - - - - - - - - - - - -.. _deleteAllFromRealm: - -.. _deleteAllFromRealm__: - -.. _RealmCollection_deleteAllFromRealm: - -.. _RealmCollection_deleteAllFromRealm__: - -.. _io_realm_RealmCollection_deleteAllFromRealm: - -.. _io_realm_RealmCollection_deleteAllFromRealm__: - - - -deleteAllFromRealm ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteAllFromRealm ` () - | - - - - - * - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - - - **Returns** - - ``true`` if objects was deleted, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _RealmCollection_isLoaded: - -.. _RealmCollection_isLoaded__: - -.. _io_realm_RealmCollection_isLoaded: - -.. _io_realm_RealmCollection_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - Checks if a collection has finished loading its data yet. - - - - - - - **Returns** - - ``true`` if data has been loaded and is available, ``false`` if data is still being loaded. - - - - - - - - - - - - - -.. _isManaged: - -.. _isManaged__: - -.. _RealmCollection_isManaged: - -.. _RealmCollection_isManaged__: - -.. _io_realm_RealmCollection_isManaged: - -.. _io_realm_RealmCollection_isManaged__: - - - -isManaged ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isManaged ` () - | - - - - - * - Checks if the collection is managed by Realm. A managed collection is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed collection will be live-updated so it always points to the latest data. Managed collections are thread confined so that they cannot be accessed from other threads than the one that created them.If this method returns ``false`` , the collection is unmanaged. An unmanaged collection is just a normal java collection, so it will not be live updated. - - - - - - - - - - - **Returns** - - ``true`` if this is a managed :ref:`RealmCollection ` , ``false`` otherwise. - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmCollection_isValid: - -.. _RealmCollection_isValid__: - -.. _io_realm_RealmCollection_isValid: - -.. _io_realm_RealmCollection_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. It will always return ``true`` for an unmanaged collection. - - - - - - - - - **Returns** - - ``true`` if it is still valid to use or an unmanaged collection, ``false`` otherwise. - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _RealmCollection_load: - -.. _RealmCollection_load__: - -.. _io_realm_RealmCollection_load: - -.. _io_realm_RealmCollection_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`load ` () - | - - - - - * - Blocks the collection until all data are available. - - - - - - - **Returns** - - ``true`` if the data could be successfully loaded, ``false`` otherwise. - - - - - - - - - - - - - -.. _max: - -.. _max__: - -.. _RealmCollection_max: - -.. _RealmCollection_max__: - -.. _io_realm_RealmCollection_max: - -.. _io_realm_RealmCollection_max__: - - - -max ----- - -.. _io_realm_RealmCollection_max_java_lang_String_: - -.. _io_realm_RealmCollection_max_String_: - -.. _max_java_lang_String_: - -.. _max_String_: - -.. _RealmCollection_max_java_lang_String_: - -.. _RealmCollection_max_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field to look for a maximum on. Only number fields are supported. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _maxDate: - -.. _maxDate__: - -.. _RealmCollection_maxDate: - -.. _RealmCollection_maxDate__: - -.. _io_realm_RealmCollection_maxDate: - -.. _io_realm_RealmCollection_maxDate__: - - - -maxDate -------- - -.. _io_realm_RealmCollection_maxDate_java_lang_String_: - -.. _io_realm_RealmCollection_maxDate_String_: - -.. _maxDate_java_lang_String_: - -.. _maxDate_String_: - -.. _RealmCollection_maxDate_java_lang_String_: - -.. _RealmCollection_maxDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum date. - - - - - **Parameters** - - - ``fieldName`` - the field to look for the maximum date. If fieldName is not of Date type, an exception is thrown. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _min: - -.. _min__: - -.. _RealmCollection_min: - -.. _RealmCollection_min__: - -.. _io_realm_RealmCollection_min: - -.. _io_realm_RealmCollection_min__: - - - -min ----- - -.. _io_realm_RealmCollection_min_java_lang_String_: - -.. _io_realm_RealmCollection_min_String_: - -.. _min_java_lang_String_: - -.. _min_String_: - -.. _RealmCollection_min_java_lang_String_: - -.. _RealmCollection_min_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field to look for a minimum on. Only number fields are supported. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _minDate: - -.. _minDate__: - -.. _RealmCollection_minDate: - -.. _RealmCollection_minDate__: - -.. _io_realm_RealmCollection_minDate: - -.. _io_realm_RealmCollection_minDate__: - - - -minDate -------- - -.. _io_realm_RealmCollection_minDate_java_lang_String_: - -.. _io_realm_RealmCollection_minDate_String_: - -.. _minDate_java_lang_String_: - -.. _minDate_String_: - -.. _RealmCollection_minDate_java_lang_String_: - -.. _RealmCollection_minDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum date. - - - - - **Parameters** - - - ``fieldName`` - the field to look for the minimum date. If fieldName is not of Date type, an exception is thrown. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if fieldName is not a Date field. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _sum: - -.. _sum__: - -.. _RealmCollection_sum: - -.. _RealmCollection_sum__: - -.. _io_realm_RealmCollection_sum: - -.. _io_realm_RealmCollection_sum__: - - - -sum ----- - -.. _io_realm_RealmCollection_sum_java_lang_String_: - -.. _io_realm_RealmCollection_sum_String_: - -.. _sum_java_lang_String_: - -.. _sum_String_: - -.. _RealmCollection_sum_java_lang_String_: - -.. _RealmCollection_sum_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName - | ) - - - - - * - Calculates the sum of a given field. - - - - - **Parameters** - - - ``fieldName`` - the field to sum. Only number fields are supported. - - - - - - - - **Returns** - - the sum. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the sum, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - `java.lang.IllegalStateException `__ - if the Realm has been closed or called from an incorrect thread. - - - - - - - - - - - - -.. _where: - -.. _where__: - -.. _RealmCollection_where: - -.. _RealmCollection_where__: - -.. _io_realm_RealmCollection_where: - -.. _io_realm_RealmCollection_where__: - - - -where ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` () - | - - - - - * - Returns a :ref:`RealmQuery ` , which can be used to query for specific objects from this collection. - - - - - - - - - **Returns** - - a RealmQuery object. - - - - - **Throws** - - - `IllegalStateException `__ - if the Realm instance has been closed or queries are not otherwise available. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmQuery ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmConfiguration.txt b/source/sdk/java/api/io/realm/RealmConfiguration.txt deleted file mode 100644 index d66fd03182..0000000000 --- a/source/sdk/java/api/io/realm/RealmConfiguration.txt +++ /dev/null @@ -1,1963 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmConfiguration -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmConfiguration: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmConfiguration - - -A RealmConfiguration is used to setup a specific Realm instance.Instances of a RealmConfiguration can only created by using the :ref:`io.realm.RealmConfiguration.Builder ` and calling its :ref:`io.realm.RealmConfiguration.Builder.build() ` method. - - - -A commonly used RealmConfiguration can easily be accessed by first saving it as :ref:`Realm.setDefaultConfiguration(RealmConfiguration) ` and then using :ref:`io.realm.Realm.getDefaultInstance() ` . - - - -A minimal configuration can be created using: - -``RealmConfiguration config = new RealmConfiguration.Builder().build()`` - - - -This will create a RealmConfiguration with the following properties. - - - -- Realm file is called "default.realm" - - -- It is saved in Context.getFilesDir() - - -- It has its schema version set to 0. - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`RealmConfiguration.Builder ` - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`DEFAULT_REALM_NAME ` - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - protected static **RealmProxyMediator** - - | :ref:`createSchemaMediator ` ( - | `java.util.Set\ `__ modules, - | `java.util.Set\> `__ debugSchema, - | **boolean** excludeDebugSchema - | ) - - - - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ obj - | ) - - - - - - - - * - protected static :ref:`RealmConfiguration ` - - | :ref:`forRecovery ` ( - | `String `__ canonicalPath, - | **byte[]** encryptionKey, - | **RealmProxyMediator** schemaMediator - | ) - - - - - - - - * - public `String `__ - - | :ref:`getAssetFilePath ` () - | - - - Returns the path to the Realm asset file. - - - - - * - public :ref:`CompactOnLaunchCallback ` - - | :ref:`getCompactOnLaunchCallback ` () - | - - - Returns a callback to determine if the Realm file should be compacted before being returned to the user. - - - - - * - public **OsRealmConfig.Durability** - - | :ref:`getDurability ` () - | - - - - - - - - * - public **byte** - - | :ref:`getEncryptionKey ` () - | - - - - - - - - * - public :ref:`FlowFactory ` - - | :ref:`getFlowFactory ` () - | - - - Returns the :ref:`FlowFactory ` that is used to create Kotlin Flows from Realm objects. - - - - - - - * - protected :ref:`Realm.Transaction ` - - | :ref:`getInitialDataTransaction ` () - | - - - Returns the transaction instance with initial data. - - - - - * - protected :ref:`Realm ` - - | :ref:`getInstance ` ( - | **OsSharedRealm.VersionID** version - | ) - - - - - - - - * - public **long** - - | :ref:`getMaxNumberOfActiveVersions ` () - | - - - - - - - - * - public :ref:`RealmMigration ` - - | :ref:`getMigration ` () - | - - - - - - - - * - public `String `__ - - | :ref:`getPath ` () - | - - - Returns the absolute path to where the Realm file will be saved. - - - - - * - public `File `__ - - | :ref:`getRealmDirectory ` () - | - - - - - - - - * - public `String `__ - - | :ref:`getRealmFileName ` () - | - - - - - - - - * - public `Set `__ - - | :ref:`getRealmObjectClasses ` () - | - - - Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. - - - - - - - * - public :ref:`RxObservableFactory ` - - | :ref:`getRxFactory ` () - | - - - Returns the :ref:`RxObservableFactory ` that is used to create Rx Observables from Realm objects. - - - - - - - * - protected **RealmProxyMediator** - - | :ref:`getSchemaMediator ` () - | - - - Returns the mediator instance of schema which is defined by this configuration. - - - - - * - public **long** - - | :ref:`getSchemaVersion ` () - | - - - - - - - - * - public **boolean** - - | :ref:`hasAssetFile ` () - | - - - Indicates if an asset file has been configured for this configuration. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isAllowQueriesOnUiThread ` () - | - - - Returns whether a :ref:`RealmQuery ` is allowed to be launched from the UI thread. - - - - - - - * - public **boolean** - - | :ref:`isAllowWritesOnUiThread ` () - | - - - Returns whether calls to :ref:`Realm.executeTransaction ` can be done on the UI thread. - - - - - - - * - public **boolean** - - | :ref:`isReadOnly ` () - | - - - Returns whether this Realm is read-only or not. - - - - - * - public **boolean** - - | :ref:`isRecoveryConfiguration ` () - | - - - - - - - - * - protected **boolean** - - | :ref:`isSyncConfiguration ` () - | - - - - - - - - * - protected **boolean** - - | :ref:`realmExists ` () - | - - - Checks if the Realm file defined by this configuration already exists. - - - - - * - public **boolean** - - | :ref:`shouldDeleteRealmIfMigrationNeeded ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_RealmConfiguration_DEFAULT_REALM_NAME: - - - -``DEFAULT_REALM_NAME`` ------------------------ - - - - - - -Method Detail -============= - -.. _createSchemaMediator: - -.. _createSchemaMediator__: - -.. _RealmConfiguration_createSchemaMediator: - -.. _RealmConfiguration_createSchemaMediator__: - -.. _io_realm_RealmConfiguration_createSchemaMediator: - -.. _io_realm_RealmConfiguration_createSchemaMediator__: - - - -createSchemaMediator --------------------- - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set__boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_Set_boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__Set__boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel____boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_java_util_Set_boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__java_util_Set__boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Set_boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__Set__boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_RealmModel___boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set__RealmModel____boolean_: - -.. _createSchemaMediator_java_util_Set_java_util_Set_boolean_: - -.. _createSchemaMediator_java_util_Set__java_util_Set__boolean_: - -.. _createSchemaMediator_java_util_Set_Set_boolean_: - -.. _createSchemaMediator_java_util_Set__Set__boolean_: - -.. _createSchemaMediator_java_util_Set_RealmModel___boolean_: - -.. _createSchemaMediator_java_util_Set__RealmModel____boolean_: - -.. _createSchemaMediator_Set_java_util_Set_boolean_: - -.. _createSchemaMediator_Set__java_util_Set__boolean_: - -.. _createSchemaMediator_Set_Set_boolean_: - -.. _createSchemaMediator_Set__Set__boolean_: - -.. _createSchemaMediator_Set_RealmModel___boolean_: - -.. _createSchemaMediator_Set__RealmModel____boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set_java_util_Set_boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set__java_util_Set__boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set_Set_boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set__Set__boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set_RealmModel___boolean_: - -.. _RealmConfiguration_createSchemaMediator_java_util_Set__RealmModel____boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set_java_util_Set_boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set__java_util_Set__boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set_Set_boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set__Set__boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set_RealmModel___boolean_: - -.. _RealmConfiguration_createSchemaMediator_Set__RealmModel____boolean_: - -.. _io_realm_RealmConfiguration_createSchemaMediator_Set_Object___Set_Class___extends_RealmModel____boolean_: - -.. list-table:: - :header-rows: 1 - - * - | protected static **RealmProxyMediator** :ref:`createSchemaMediator ` ( - | `java.util.Set\ `__ modules, - | `java.util.Set\> `__ debugSchema, - | **boolean** excludeDebugSchema - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _RealmConfiguration_equals: - -.. _RealmConfiguration_equals__: - -.. _io_realm_RealmConfiguration_equals: - -.. _io_realm_RealmConfiguration_equals__: - - - -equals ------- - -.. _io_realm_RealmConfiguration_equals_java_lang_Object_: - -.. _io_realm_RealmConfiguration_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _RealmConfiguration_equals_java_lang_Object_: - -.. _RealmConfiguration_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ obj - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _forRecovery: - -.. _forRecovery__: - -.. _RealmConfiguration_forRecovery: - -.. _RealmConfiguration_forRecovery__: - -.. _io_realm_RealmConfiguration_forRecovery: - -.. _io_realm_RealmConfiguration_forRecovery__: - - - -forRecovery ------------ - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte__RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String_byte____RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_java_lang_String__byte_____RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String_byte_RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String__byte__RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String_byte____RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String__byte_____RealmProxyMediator_: - -.. _forRecovery_java_lang_String_byte_RealmProxyMediator_: - -.. _forRecovery_java_lang_String__byte__RealmProxyMediator_: - -.. _forRecovery_java_lang_String_byte____RealmProxyMediator_: - -.. _forRecovery_java_lang_String__byte_____RealmProxyMediator_: - -.. _forRecovery_String_byte_RealmProxyMediator_: - -.. _forRecovery_String__byte__RealmProxyMediator_: - -.. _forRecovery_String_byte____RealmProxyMediator_: - -.. _forRecovery_String__byte_____RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String_byte_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String__byte__RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String_byte____RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_java_lang_String__byte_____RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String_byte_RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String__byte__RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String_byte____RealmProxyMediator_: - -.. _RealmConfiguration_forRecovery_String__byte_____RealmProxyMediator_: - -.. _io_realm_RealmConfiguration_forRecovery_String__byte[]__RealmProxyMediator_: - -.. list-table:: - :header-rows: 1 - - * - | protected static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath, - | **byte[]** encryptionKey, - | **RealmProxyMediator** schemaMediator - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getAssetFilePath: - -.. _getAssetFilePath__: - -.. _RealmConfiguration_getAssetFilePath: - -.. _RealmConfiguration_getAssetFilePath__: - -.. _io_realm_RealmConfiguration_getAssetFilePath: - -.. _io_realm_RealmConfiguration_getAssetFilePath__: - - - -getAssetFilePath ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAssetFilePath ` () - | - - - - - * - Returns the path to the Realm asset file. - - - - - - - **Returns** - - path to the asset file relative to the asset directory or ``null`` if not asset file was specified. - - - - - - - - - - - - - -.. _getCompactOnLaunchCallback: - -.. _getCompactOnLaunchCallback__: - -.. _RealmConfiguration_getCompactOnLaunchCallback: - -.. _RealmConfiguration_getCompactOnLaunchCallback__: - -.. _io_realm_RealmConfiguration_getCompactOnLaunchCallback: - -.. _io_realm_RealmConfiguration_getCompactOnLaunchCallback__: - - - -getCompactOnLaunchCallback --------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`CompactOnLaunchCallback ` :ref:`getCompactOnLaunchCallback ` () - | - - - - - * - Returns a callback to determine if the Realm file should be compacted before being returned to the user. - - - - - - - **Returns** - - a callback called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the total bytes used by data in the file. - - - - - - - - - - - -.. _getDurability: - -.. _getDurability__: - -.. _RealmConfiguration_getDurability: - -.. _RealmConfiguration_getDurability__: - -.. _io_realm_RealmConfiguration_getDurability: - -.. _io_realm_RealmConfiguration_getDurability__: - - - -getDurability -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **OsRealmConfig.Durability** :ref:`getDurability ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getEncryptionKey: - -.. _getEncryptionKey__: - -.. _RealmConfiguration_getEncryptionKey: - -.. _RealmConfiguration_getEncryptionKey__: - -.. _io_realm_RealmConfiguration_getEncryptionKey: - -.. _io_realm_RealmConfiguration_getEncryptionKey__: - - - -getEncryptionKey ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`getEncryptionKey ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getFlowFactory: - -.. _getFlowFactory__: - -.. _RealmConfiguration_getFlowFactory: - -.. _RealmConfiguration_getFlowFactory__: - -.. _io_realm_RealmConfiguration_getFlowFactory: - -.. _io_realm_RealmConfiguration_getFlowFactory__: - - - -getFlowFactory --------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FlowFactory ` :ref:`getFlowFactory ` () - | - - - - - * - Returns the :ref:`FlowFactory ` that is used to create Kotlin Flows from Realm objects. - - - - - - - - - **Returns** - - the factory instance used to create Flows. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required coroutines framework is not on the classpath. - - - - - - - - - - - - -.. _getInitialDataTransaction: - -.. _getInitialDataTransaction__: - -.. _RealmConfiguration_getInitialDataTransaction: - -.. _RealmConfiguration_getInitialDataTransaction__: - -.. _io_realm_RealmConfiguration_getInitialDataTransaction: - -.. _io_realm_RealmConfiguration_getInitialDataTransaction__: - - - -getInitialDataTransaction -------------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected :ref:`Realm.Transaction ` :ref:`getInitialDataTransaction ` () - | - - - - - * - Returns the transaction instance with initial data. - - - - - - - **Returns** - - the initial data transaction. - - - - - - - - - - - -.. _getInstance: - -.. _getInstance__: - -.. _RealmConfiguration_getInstance: - -.. _RealmConfiguration_getInstance__: - -.. _io_realm_RealmConfiguration_getInstance: - -.. _io_realm_RealmConfiguration_getInstance__: - - - -getInstance ------------ - -.. _io_realm_RealmConfiguration_getInstance_OsSharedRealm_VersionID_: - -.. _getInstance_OsSharedRealm_VersionID_: - -.. _RealmConfiguration_getInstance_OsSharedRealm_VersionID_: - -.. list-table:: - :header-rows: 1 - - * - | protected :ref:`Realm ` :ref:`getInstance ` ( - | **OsSharedRealm.VersionID** version - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _getMaxNumberOfActiveVersions: - -.. _getMaxNumberOfActiveVersions__: - -.. _RealmConfiguration_getMaxNumberOfActiveVersions: - -.. _RealmConfiguration_getMaxNumberOfActiveVersions__: - -.. _io_realm_RealmConfiguration_getMaxNumberOfActiveVersions: - -.. _io_realm_RealmConfiguration_getMaxNumberOfActiveVersions__: - - - -getMaxNumberOfActiveVersions ----------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getMaxNumberOfActiveVersions ` () - | - - - - - * - - - - - - - - **Returns** - - the maximum number of active versions allowed before an exception is thrown. - - - - - - - - - - - -.. _getMigration: - -.. _getMigration__: - -.. _RealmConfiguration_getMigration: - -.. _RealmConfiguration_getMigration__: - -.. _io_realm_RealmConfiguration_getMigration: - -.. _io_realm_RealmConfiguration_getMigration__: - - - -getMigration ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmMigration ` :ref:`getMigration ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getPath: - -.. _getPath__: - -.. _RealmConfiguration_getPath: - -.. _RealmConfiguration_getPath__: - -.. _io_realm_RealmConfiguration_getPath: - -.. _io_realm_RealmConfiguration_getPath__: - - - -getPath -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getPath ` () - | - - - - - * - Returns the absolute path to where the Realm file will be saved. - - - - - - - **Returns** - - the absolute path to the Realm file defined by this configuration. - - - - - - - - - - - -.. _getRealmDirectory: - -.. _getRealmDirectory__: - -.. _RealmConfiguration_getRealmDirectory: - -.. _RealmConfiguration_getRealmDirectory__: - -.. _io_realm_RealmConfiguration_getRealmDirectory: - -.. _io_realm_RealmConfiguration_getRealmDirectory__: - - - -getRealmDirectory ------------------ - -.. list-table:: - :header-rows: 1 - - * - | public `File `__ :ref:`getRealmDirectory ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getRealmFileName: - -.. _getRealmFileName__: - -.. _RealmConfiguration_getRealmFileName: - -.. _RealmConfiguration_getRealmFileName__: - -.. _io_realm_RealmConfiguration_getRealmFileName: - -.. _io_realm_RealmConfiguration_getRealmFileName__: - - - -getRealmFileName ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getRealmFileName ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getRealmObjectClasses: - -.. _getRealmObjectClasses__: - -.. _RealmConfiguration_getRealmObjectClasses: - -.. _RealmConfiguration_getRealmObjectClasses__: - -.. _io_realm_RealmConfiguration_getRealmObjectClasses: - -.. _io_realm_RealmConfiguration_getRealmObjectClasses__: - - - -getRealmObjectClasses ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Set `__ :ref:`getRealmObjectClasses ` () - | - - - - - * - Returns the unmodifiable `Set `__ of model classes that make up the schema for this Realm. - - - - - - - - - **Returns** - - unmodifiable `Set `__ of model classes. - - - - - - - - - - - - - -.. _getRxFactory: - -.. _getRxFactory__: - -.. _RealmConfiguration_getRxFactory: - -.. _RealmConfiguration_getRxFactory__: - -.. _io_realm_RealmConfiguration_getRxFactory: - -.. _io_realm_RealmConfiguration_getRxFactory__: - - - -getRxFactory ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RxObservableFactory ` :ref:`getRxFactory ` () - | - - - - - * - Returns the :ref:`RxObservableFactory ` that is used to create Rx Observables from Realm objects. - - - - - - - - - **Returns** - - the factory instance used to create Rx Observables. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. - - - - - - - - - - - - -.. _getSchemaMediator: - -.. _getSchemaMediator__: - -.. _RealmConfiguration_getSchemaMediator: - -.. _RealmConfiguration_getSchemaMediator__: - -.. _io_realm_RealmConfiguration_getSchemaMediator: - -.. _io_realm_RealmConfiguration_getSchemaMediator__: - - - -getSchemaMediator ------------------ - -.. list-table:: - :header-rows: 1 - - * - | protected **RealmProxyMediator** :ref:`getSchemaMediator ` () - | - - - - - * - Returns the mediator instance of schema which is defined by this configuration. - - - - - - - **Returns** - - the mediator of the schema. - - - - - - - - - - - -.. _getSchemaVersion: - -.. _getSchemaVersion__: - -.. _RealmConfiguration_getSchemaVersion: - -.. _RealmConfiguration_getSchemaVersion__: - -.. _io_realm_RealmConfiguration_getSchemaVersion: - -.. _io_realm_RealmConfiguration_getSchemaVersion__: - - - -getSchemaVersion ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getSchemaVersion ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _hasAssetFile: - -.. _hasAssetFile__: - -.. _RealmConfiguration_hasAssetFile: - -.. _RealmConfiguration_hasAssetFile__: - -.. _io_realm_RealmConfiguration_hasAssetFile: - -.. _io_realm_RealmConfiguration_hasAssetFile__: - - - -hasAssetFile ------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasAssetFile ` () - | - - - - - * - Indicates if an asset file has been configured for this configuration. - - - - - - - **Returns** - - ``true`` if there is asset file, ``false`` otherwise. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _RealmConfiguration_hashCode: - -.. _RealmConfiguration_hashCode__: - -.. _io_realm_RealmConfiguration_hashCode: - -.. _io_realm_RealmConfiguration_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isAllowQueriesOnUiThread: - -.. _isAllowQueriesOnUiThread__: - -.. _RealmConfiguration_isAllowQueriesOnUiThread: - -.. _RealmConfiguration_isAllowQueriesOnUiThread__: - -.. _io_realm_RealmConfiguration_isAllowQueriesOnUiThread: - -.. _io_realm_RealmConfiguration_isAllowQueriesOnUiThread__: - - - -isAllowQueriesOnUiThread ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isAllowQueriesOnUiThread ` () - | - - - - - * - Returns whether a :ref:`RealmQuery ` is allowed to be launched from the UI thread. - - By default Realm allows queries on the main thread. To disallow this users have to explicitly opt in with :ref:`Builder.allowQueriesOnUiThread(boolean) ` or its Realm Sync builder counterpart. - - - - - - - - - - - **Returns** - - whether or not queries are allowed to be run from the UI thread. - - - - - - - - - - - -.. _isAllowWritesOnUiThread: - -.. _isAllowWritesOnUiThread__: - -.. _RealmConfiguration_isAllowWritesOnUiThread: - -.. _RealmConfiguration_isAllowWritesOnUiThread__: - -.. _io_realm_RealmConfiguration_isAllowWritesOnUiThread: - -.. _io_realm_RealmConfiguration_isAllowWritesOnUiThread__: - - - -isAllowWritesOnUiThread ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isAllowWritesOnUiThread ` () - | - - - - - * - Returns whether calls to :ref:`Realm.executeTransaction ` can be done on the UI thread. - - **Note: Realm does not allow blocking transactions to be run on the main thread unless users explicitly opt in with :ref:`Builder.allowWritesOnUiThread(boolean) ` or its Realm Sync builder counterpart. - - ** - - - - - - - - - **Returns** - - whether or not write operations are allowed to be run from the UI thread. - - - - - - - - - - - -.. _isReadOnly: - -.. _isReadOnly__: - -.. _RealmConfiguration_isReadOnly: - -.. _RealmConfiguration_isReadOnly__: - -.. _io_realm_RealmConfiguration_isReadOnly: - -.. _io_realm_RealmConfiguration_isReadOnly__: - - - -isReadOnly ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isReadOnly ` () - | - - - - - * - Returns whether this Realm is read-only or not. Read-only Realms cannot be modified and will throw an `IllegalStateException `__ if **Realm.beginTransaction()** is called on it. - - - - - - - - - **Returns** - - ``true`` if this Realm is read only, ``false`` if not. - - - - - - - - - - - - - -.. _isRecoveryConfiguration: - -.. _isRecoveryConfiguration__: - -.. _RealmConfiguration_isRecoveryConfiguration: - -.. _RealmConfiguration_isRecoveryConfiguration__: - -.. _io_realm_RealmConfiguration_isRecoveryConfiguration: - -.. _io_realm_RealmConfiguration_isRecoveryConfiguration__: - - - -isRecoveryConfiguration ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isRecoveryConfiguration ` () - | - - - - - * - - - - - - - - **Returns** - - ``true`` if this configuration is intended to open a backup Realm (as a result of a client reset). - - - - - - - - - - - .. seealso:: - - - - - **{\@link ClientResetRequiredError}** - - - - - - - - - - - - -.. _isSyncConfiguration: - -.. _isSyncConfiguration__: - -.. _RealmConfiguration_isSyncConfiguration: - -.. _RealmConfiguration_isSyncConfiguration__: - -.. _io_realm_RealmConfiguration_isSyncConfiguration: - -.. _io_realm_RealmConfiguration_isSyncConfiguration__: - - - -isSyncConfiguration -------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected **boolean** :ref:`isSyncConfiguration ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _realmExists: - -.. _realmExists__: - -.. _RealmConfiguration_realmExists: - -.. _RealmConfiguration_realmExists__: - -.. _io_realm_RealmConfiguration_realmExists: - -.. _io_realm_RealmConfiguration_realmExists__: - - - -realmExists ------------ - -.. list-table:: - :header-rows: 1 - - * - | protected **boolean** :ref:`realmExists ` () - | - - - - - * - Checks if the Realm file defined by this configuration already exists.WARNING: This method is just a point-in-time check. Unless protected by external synchronization another thread or process might have created or deleted the Realm file right after this method has returned. - - - - - - - - - **Returns** - - ``true`` if the Realm file exists, ``false`` otherwise. - - - - - - - - - - - - - -.. _shouldDeleteRealmIfMigrationNeeded: - -.. _shouldDeleteRealmIfMigrationNeeded__: - -.. _RealmConfiguration_shouldDeleteRealmIfMigrationNeeded: - -.. _RealmConfiguration_shouldDeleteRealmIfMigrationNeeded__: - -.. _io_realm_RealmConfiguration_shouldDeleteRealmIfMigrationNeeded: - -.. _io_realm_RealmConfiguration_shouldDeleteRealmIfMigrationNeeded__: - - - -shouldDeleteRealmIfMigrationNeeded ----------------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`shouldDeleteRealmIfMigrationNeeded ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _RealmConfiguration_toString: - -.. _RealmConfiguration_toString__: - -.. _io_realm_RealmConfiguration_toString: - -.. _io_realm_RealmConfiguration_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt b/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt deleted file mode 100644 index c17a6e27be..0000000000 --- a/source/sdk/java/api/io/realm/RealmConfiguration/Builder.txt +++ /dev/null @@ -1,1721 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmConfiguration.Builder -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmConfiguration_Builder: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmConfiguration.Builder - - - - -**Enclosing class:** - -:ref:`RealmConfiguration ` - - - -RealmConfiguration.Builder used to construct instances of a RealmConfiguration in a fluent manner. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Builder ` () - | - - - Creates an instance of the Builder for the RealmConfiguration. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public final :ref:`RealmConfiguration.Builder ` - - | :ref:`addModule ` ( - | `Object `__ module - | ) - - - FIXME: Temporary visible DEBUG method. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`allowQueriesOnUiThread ` ( - | **boolean** allowQueriesOnUiThread - | ) - - - Sets whether or not a :ref:`RealmQuery ` can be launched from the UI thread. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`allowWritesOnUiThread ` ( - | **boolean** allowWritesOnUiThread - | ) - - - Sets whether or not calls to :ref:`Realm.executeTransaction ` are allowed from the UI thread. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`assetFile ` ( - | `String `__ assetFile - | ) - - - Copies the Realm file from the given asset file path. - - - - - * - public :ref:`RealmConfiguration ` - - | :ref:`build ` () - | - - - Creates the RealmConfiguration based on the builder parameters. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`compactOnLaunch ` ( - | :ref:`CompactOnLaunchCallback ` compactOnLaunch - | ) - - - Sets this to determine if the Realm file should be compacted before returned to the user. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`compactOnLaunch ` () - | - - - Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`deleteRealmIfMigrationNeeded ` () - | - - - Setting this will change the behavior of how migration exceptions are handled. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`directory ` ( - | `File `__ directory - | ) - - - Specifies the directory where the Realm file will be saved. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - Sets the 64 byte key used to encrypt and decrypt the Realm file. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`flowFactory ` ( - | :ref:`FlowFactory ` factory - | ) - - - Sets the :ref:`FlowFactory ` used to create coroutines Flows from Realm objects. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`inMemory ` () - | - - - Setting this will create an in-memory Realm instead of saving it to disk. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`initialData ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - Sets the initial data in :ref:`io.realm.Realm ` . - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`maxNumberOfActiveVersions ` ( - | **long** number - | ) - - - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`migration ` ( - | :ref:`RealmMigration ` migration - | ) - - - Sets the :ref:`io.realm.RealmMigration ` to be run if a migration is needed. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules - | ) - - - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`name ` ( - | `String `__ filename - | ) - - - Sets the filename for the Realm file. - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`readOnly ` () - | - - - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`rxFactory ` ( - | :ref:`RxObservableFactory ` factory - | ) - - - Sets the :ref:`RxObservableFactory ` used to create Rx Observables from Realm objects. - - - - - - - * - public :ref:`RealmConfiguration.Builder ` - - | :ref:`schemaVersion ` ( - | **long** schemaVersion - | ) - - - Sets the schema version of the Realm. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Builder: - -.. _Builder__: - -.. _io_realm_RealmConfiguration_Builder: - -.. _io_realm_RealmConfiguration_Builder__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Builder ` () - | - - - - - * - Creates an instance of the Builder for the RealmConfiguration.This will use the app's own internal directory for storing the Realm file. This does not require any additional permissions. The default location is ``/data/data//files`` , but can change depending on vendor implementations of Android. - - - - - - - - - - - - - - - - - -Method Detail -============= - -.. _addModule: - -.. _addModule__: - -.. _Builder_addModule: - -.. _Builder_addModule__: - -.. _RealmConfiguration_Builder_addModule: - -.. _RealmConfiguration_Builder_addModule__: - -.. _io_realm_RealmConfiguration_Builder_addModule: - -.. _io_realm_RealmConfiguration_Builder_addModule__: - - - -addModule ---------- - -.. _io_realm_RealmConfiguration_Builder_addModule_java_lang_Object_: - -.. _io_realm_RealmConfiguration_Builder_addModule_Object_: - -.. _addModule_java_lang_Object_: - -.. _addModule_Object_: - -.. _RealmConfiguration_Builder_addModule_java_lang_Object_: - -.. _RealmConfiguration_Builder_addModule_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public final :ref:`RealmConfiguration.Builder ` :ref:`addModule ` ( - | `Object `__ module - | ) - - - - - * - FIXME: Temporary visible DEBUG method. Will add a module unconditionally. Adds a module to already defined modules. - - - - - - - - - - - - - - - -.. _allowQueriesOnUiThread: - -.. _allowQueriesOnUiThread__: - -.. _Builder_allowQueriesOnUiThread: - -.. _Builder_allowQueriesOnUiThread__: - -.. _RealmConfiguration_Builder_allowQueriesOnUiThread: - -.. _RealmConfiguration_Builder_allowQueriesOnUiThread__: - -.. _io_realm_RealmConfiguration_Builder_allowQueriesOnUiThread: - -.. _io_realm_RealmConfiguration_Builder_allowQueriesOnUiThread__: - - - -allowQueriesOnUiThread ----------------------- - -.. _io_realm_RealmConfiguration_Builder_allowQueriesOnUiThread_boolean_: - -.. _allowQueriesOnUiThread_boolean_: - -.. _RealmConfiguration_Builder_allowQueriesOnUiThread_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`allowQueriesOnUiThread ` ( - | **boolean** allowQueriesOnUiThread - | ) - - - - - * - Sets whether or not a :ref:`RealmQuery ` can be launched from the UI thread. - - By default Realm allows queries on the main thread. However, by doing so your application may experience a drop of frames or even ANRs. We recommend diverting queries to non-UI threads or, alternatively, using :ref:`RealmQuery.findAllAsync() ` or :ref:`RealmQuery.findFirstAsync() ` . - - - - - - - - - - - - - - - - - - - -.. _allowWritesOnUiThread: - -.. _allowWritesOnUiThread__: - -.. _Builder_allowWritesOnUiThread: - -.. _Builder_allowWritesOnUiThread__: - -.. _RealmConfiguration_Builder_allowWritesOnUiThread: - -.. _RealmConfiguration_Builder_allowWritesOnUiThread__: - -.. _io_realm_RealmConfiguration_Builder_allowWritesOnUiThread: - -.. _io_realm_RealmConfiguration_Builder_allowWritesOnUiThread__: - - - -allowWritesOnUiThread ---------------------- - -.. _io_realm_RealmConfiguration_Builder_allowWritesOnUiThread_boolean_: - -.. _allowWritesOnUiThread_boolean_: - -.. _RealmConfiguration_Builder_allowWritesOnUiThread_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`allowWritesOnUiThread ` ( - | **boolean** allowWritesOnUiThread - | ) - - - - - * - Sets whether or not calls to :ref:`Realm.executeTransaction ` are allowed from the UI thread. - - **WARNING: Realm does not allow synchronous transactions to be run on the main thread unless users explicitly opt in with this method.** We recommend diverting calls to ``executeTransaction`` to non-UI threads or, alternatively, using :ref:`Realm.executeTransactionAsync ` . - - - - - - - - - - - - - - - - - - - -.. _assetFile: - -.. _assetFile__: - -.. _Builder_assetFile: - -.. _Builder_assetFile__: - -.. _RealmConfiguration_Builder_assetFile: - -.. _RealmConfiguration_Builder_assetFile__: - -.. _io_realm_RealmConfiguration_Builder_assetFile: - -.. _io_realm_RealmConfiguration_Builder_assetFile__: - - - -assetFile ---------- - -.. _io_realm_RealmConfiguration_Builder_assetFile_java_lang_String_: - -.. _io_realm_RealmConfiguration_Builder_assetFile_String_: - -.. _assetFile_java_lang_String_: - -.. _assetFile_String_: - -.. _RealmConfiguration_Builder_assetFile_java_lang_String_: - -.. _RealmConfiguration_Builder_assetFile_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`assetFile ` ( - | `String `__ assetFile - | ) - - - - - * - Copies the Realm file from the given asset file path.When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided asset file and used instead. - - This cannot be combined with :ref:`deleteRealmIfMigrationNeeded() ` as doing so would just result in the copied file being deleted. - - - - WARNING: This could potentially be a lengthy operation and should ideally be done on a background thread. - - - - - - - **Parameters** - - - ``assetFile`` - path to the asset database file. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if this is configured to clear its schema by calling :ref:`deleteRealmIfMigrationNeeded() ` . - - - - - - - - - - - - - - -.. _build: - -.. _build__: - -.. _Builder_build: - -.. _Builder_build__: - -.. _RealmConfiguration_Builder_build: - -.. _RealmConfiguration_Builder_build__: - -.. _io_realm_RealmConfiguration_Builder_build: - -.. _io_realm_RealmConfiguration_Builder_build__: - - - -build ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration ` :ref:`build ` () - | - - - - - * - Creates the RealmConfiguration based on the builder parameters. - - - - - - - **Returns** - - the created :ref:`RealmConfiguration ` . - - - - - - - - - - - - - -.. _compactOnLaunch: - -.. _compactOnLaunch__: - -.. _Builder_compactOnLaunch: - -.. _Builder_compactOnLaunch__: - -.. _RealmConfiguration_Builder_compactOnLaunch: - -.. _RealmConfiguration_Builder_compactOnLaunch__: - -.. _io_realm_RealmConfiguration_Builder_compactOnLaunch: - -.. _io_realm_RealmConfiguration_Builder_compactOnLaunch__: - - - -compactOnLaunch ---------------- - -.. _io_realm_RealmConfiguration_Builder_compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _io_realm_RealmConfiguration_Builder_compactOnLaunch_CompactOnLaunchCallback_: - -.. _compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _compactOnLaunch_CompactOnLaunchCallback_: - -.. _RealmConfiguration_Builder_compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _RealmConfiguration_Builder_compactOnLaunch_CompactOnLaunchCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`compactOnLaunch ` ( - | :ref:`CompactOnLaunchCallback ` compactOnLaunch - | ) - - - - - * - Sets this to determine if the Realm file should be compacted before returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - **Parameters** - - - ``compactOnLaunch`` - a callback called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`compactOnLaunch ` () - | - - - - - * - Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered. See :ref:`DefaultCompactOnLaunchCallback ` for details. - - - - - - - - - - - - - - - - - -.. _deleteRealmIfMigrationNeeded: - -.. _deleteRealmIfMigrationNeeded__: - -.. _Builder_deleteRealmIfMigrationNeeded: - -.. _Builder_deleteRealmIfMigrationNeeded__: - -.. _RealmConfiguration_Builder_deleteRealmIfMigrationNeeded: - -.. _RealmConfiguration_Builder_deleteRealmIfMigrationNeeded__: - -.. _io_realm_RealmConfiguration_Builder_deleteRealmIfMigrationNeeded: - -.. _io_realm_RealmConfiguration_Builder_deleteRealmIfMigrationNeeded__: - - - -deleteRealmIfMigrationNeeded ----------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`deleteRealmIfMigrationNeeded ` () - | - - - - - * - Setting this will change the behavior of how migration exceptions are handled. Instead of throwing a :ref:`io.realm.exceptions.RealmMigrationNeededException ` the on-disc Realm will be cleared and recreated with the new Realm schema. - - This cannot be configured to have an asset file at the same time by calling :ref:`assetFile(String) ` as the provided asset file will be deleted in migrations. - - - - **WARNING!** This will result in loss of data. - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if configured to use an asset file by calling :ref:`assetFile(String) ` previously. - - - - - - - - - - - - - - -.. _directory: - -.. _directory__: - -.. _Builder_directory: - -.. _Builder_directory__: - -.. _RealmConfiguration_Builder_directory: - -.. _RealmConfiguration_Builder_directory__: - -.. _io_realm_RealmConfiguration_Builder_directory: - -.. _io_realm_RealmConfiguration_Builder_directory__: - - - -directory ---------- - -.. _io_realm_RealmConfiguration_Builder_directory_java_io_File_: - -.. _io_realm_RealmConfiguration_Builder_directory_File_: - -.. _directory_java_io_File_: - -.. _directory_File_: - -.. _RealmConfiguration_Builder_directory_java_io_File_: - -.. _RealmConfiguration_Builder_directory_File_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`directory ` ( - | `File `__ directory - | ) - - - - - * - Specifies the directory where the Realm file will be saved. The default value is ``context.getFilesDir()`` . If the directory does not exist, it will be created. - - - - - - - **Parameters** - - - ``directory`` - the directory to save the Realm file in. Directory must be writable. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``directory`` is null, not writable or a file. - - - - - - - - - - - - - - -.. _encryptionKey: - -.. _encryptionKey__: - -.. _Builder_encryptionKey: - -.. _Builder_encryptionKey__: - -.. _RealmConfiguration_Builder_encryptionKey: - -.. _RealmConfiguration_Builder_encryptionKey__: - -.. _io_realm_RealmConfiguration_Builder_encryptionKey: - -.. _io_realm_RealmConfiguration_Builder_encryptionKey__: - - - -encryptionKey -------------- - -.. _io_realm_RealmConfiguration_Builder_encryptionKey_byte_: - -.. _io_realm_RealmConfiguration_Builder_encryptionKey_byte____: - -.. _encryptionKey_byte_: - -.. _encryptionKey_byte____: - -.. _RealmConfiguration_Builder_encryptionKey_byte_: - -.. _RealmConfiguration_Builder_encryptionKey_byte____: - -.. _io_realm_RealmConfiguration_Builder_encryptionKey_byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - - - * - Sets the 64 byte key used to encrypt and decrypt the Realm file. Sets the io.realm.Realm#ENCRYPTION_KEY_LENGTH bytes key used to encrypt and decrypt the Realm file. - - - - - - - - - - - - - - - - - -.. _flowFactory: - -.. _flowFactory__: - -.. _Builder_flowFactory: - -.. _Builder_flowFactory__: - -.. _RealmConfiguration_Builder_flowFactory: - -.. _RealmConfiguration_Builder_flowFactory__: - -.. _io_realm_RealmConfiguration_Builder_flowFactory: - -.. _io_realm_RealmConfiguration_Builder_flowFactory__: - - - -flowFactory ------------ - -.. _io_realm_RealmConfiguration_Builder_flowFactory_io_realm_coroutines_FlowFactory_: - -.. _io_realm_RealmConfiguration_Builder_flowFactory_FlowFactory_: - -.. _flowFactory_io_realm_coroutines_FlowFactory_: - -.. _flowFactory_FlowFactory_: - -.. _RealmConfiguration_Builder_flowFactory_io_realm_coroutines_FlowFactory_: - -.. _RealmConfiguration_Builder_flowFactory_FlowFactory_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`flowFactory ` ( - | :ref:`FlowFactory ` factory - | ) - - - - - * - Sets the :ref:`FlowFactory ` used to create coroutines Flows from Realm objects. The default factory is :ref:`RealmFlowFactory ` . - - - - - - - **Parameters** - - - ``factory`` - factory to use. - - - - - - - - - - - - - - - - -.. _inMemory: - -.. _inMemory__: - -.. _Builder_inMemory: - -.. _Builder_inMemory__: - -.. _RealmConfiguration_Builder_inMemory: - -.. _RealmConfiguration_Builder_inMemory__: - -.. _io_realm_RealmConfiguration_Builder_inMemory: - -.. _io_realm_RealmConfiguration_Builder_inMemory__: - - - -inMemory --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`inMemory ` () - | - - - - - * - Setting this will create an in-memory Realm instead of saving it to disk. In-memory Realms might still use disk space if memory is running low, but all files created by an in-memory Realm will be deleted when the Realm is closed.Note that because in-memory Realms are not persisted, you must be sure to hold on to at least one non-closed reference to the in-memory Realm object with the specific name as long as you want the data to last. - - - - - - - - - - - - - - - - - -.. _initialData: - -.. _initialData__: - -.. _Builder_initialData: - -.. _Builder_initialData__: - -.. _RealmConfiguration_Builder_initialData: - -.. _RealmConfiguration_Builder_initialData__: - -.. _io_realm_RealmConfiguration_Builder_initialData: - -.. _io_realm_RealmConfiguration_Builder_initialData__: - - - -initialData ------------ - -.. _io_realm_RealmConfiguration_Builder_initialData_io_realm_Realm_Transaction_: - -.. _io_realm_RealmConfiguration_Builder_initialData_Transaction_: - -.. _io_realm_RealmConfiguration_Builder_initialData_Realm_Transaction_: - -.. _initialData_io_realm_Realm_Transaction_: - -.. _initialData_Transaction_: - -.. _initialData_Realm_Transaction_: - -.. _RealmConfiguration_Builder_initialData_io_realm_Realm_Transaction_: - -.. _RealmConfiguration_Builder_initialData_Transaction_: - -.. _RealmConfiguration_Builder_initialData_Realm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`initialData ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - - - * - Sets the initial data in :ref:`io.realm.Realm ` . This transaction will be executed only for the first time when database file is created or while migrating the data when :ref:`Builder.deleteRealmIfMigrationNeeded() ` is set. - - - - - - - **Parameters** - - - ``transaction`` - transaction to execute. - - - - - - - - - - - - - - - - -.. _maxNumberOfActiveVersions: - -.. _maxNumberOfActiveVersions__: - -.. _Builder_maxNumberOfActiveVersions: - -.. _Builder_maxNumberOfActiveVersions__: - -.. _RealmConfiguration_Builder_maxNumberOfActiveVersions: - -.. _RealmConfiguration_Builder_maxNumberOfActiveVersions__: - -.. _io_realm_RealmConfiguration_Builder_maxNumberOfActiveVersions: - -.. _io_realm_RealmConfiguration_Builder_maxNumberOfActiveVersions__: - - - -maxNumberOfActiveVersions -------------------------- - -.. _io_realm_RealmConfiguration_Builder_maxNumberOfActiveVersions_long_: - -.. _maxNumberOfActiveVersions_long_: - -.. _RealmConfiguration_Builder_maxNumberOfActiveVersions_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`maxNumberOfActiveVersions ` ( - | **long** number - | ) - - - - - * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. - - Realm is capable of concurrently handling many different versions of Realm objects. This can e.g. happen if you have a Realm open on many different threads or are freezing objects while data is being written to the file. - - Under normal circumstances this is not a problem, but if the number of active versions grow too large, it will have a negative effect on the filesize on disk. Setting this parameters can therefore be used to prevent uses of Realm that can result in very large Realms. - - - - - - - **Parameters** - - - ``number`` - the maximum number of active versions before an exception is thrown. - - - - - - - - - - - - - - .. seealso:: - - - - - `FAQ `__ - - - - - - - - - - - - - -.. _migration: - -.. _migration__: - -.. _Builder_migration: - -.. _Builder_migration__: - -.. _RealmConfiguration_Builder_migration: - -.. _RealmConfiguration_Builder_migration__: - -.. _io_realm_RealmConfiguration_Builder_migration: - -.. _io_realm_RealmConfiguration_Builder_migration__: - - - -migration ---------- - -.. _io_realm_RealmConfiguration_Builder_migration_io_realm_RealmMigration_: - -.. _io_realm_RealmConfiguration_Builder_migration_RealmMigration_: - -.. _migration_io_realm_RealmMigration_: - -.. _migration_RealmMigration_: - -.. _RealmConfiguration_Builder_migration_io_realm_RealmMigration_: - -.. _RealmConfiguration_Builder_migration_RealmMigration_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`migration ` ( - | :ref:`RealmMigration ` migration - | ) - - - - - * - Sets the :ref:`io.realm.RealmMigration ` to be run if a migration is needed. If this migration fails to upgrade the on-disc schema to the runtime schema, a :ref:`io.realm.exceptions.RealmMigrationNeededException ` will be thrown. - - - - - - - - - - - - - - - - - -.. _modules: - -.. _modules__: - -.. _Builder_modules: - -.. _Builder_modules__: - -.. _RealmConfiguration_Builder_modules: - -.. _RealmConfiguration_Builder_modules__: - -.. _io_realm_RealmConfiguration_Builder_modules: - -.. _io_realm_RealmConfiguration_Builder_modules__: - - - -modules -------- - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object_java_lang_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object__java_lang_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object__Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object_Object____: - -.. _io_realm_RealmConfiguration_Builder_modules_java_lang_Object__Object____: - -.. _io_realm_RealmConfiguration_Builder_modules_Object_java_lang_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_Object__java_lang_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_Object_Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_Object__Object_: - -.. _io_realm_RealmConfiguration_Builder_modules_Object_Object____: - -.. _io_realm_RealmConfiguration_Builder_modules_Object__Object____: - -.. _modules_java_lang_Object_java_lang_Object_: - -.. _modules_java_lang_Object__java_lang_Object_: - -.. _modules_java_lang_Object_Object_: - -.. _modules_java_lang_Object__Object_: - -.. _modules_java_lang_Object_Object____: - -.. _modules_java_lang_Object__Object____: - -.. _modules_Object_java_lang_Object_: - -.. _modules_Object__java_lang_Object_: - -.. _modules_Object_Object_: - -.. _modules_Object__Object_: - -.. _modules_Object_Object____: - -.. _modules_Object__Object____: - -.. _RealmConfiguration_Builder_modules_java_lang_Object_java_lang_Object_: - -.. _RealmConfiguration_Builder_modules_java_lang_Object__java_lang_Object_: - -.. _RealmConfiguration_Builder_modules_java_lang_Object_Object_: - -.. _RealmConfiguration_Builder_modules_java_lang_Object__Object_: - -.. _RealmConfiguration_Builder_modules_java_lang_Object_Object____: - -.. _RealmConfiguration_Builder_modules_java_lang_Object__Object____: - -.. _RealmConfiguration_Builder_modules_Object_java_lang_Object_: - -.. _RealmConfiguration_Builder_modules_Object__java_lang_Object_: - -.. _RealmConfiguration_Builder_modules_Object_Object_: - -.. _RealmConfiguration_Builder_modules_Object__Object_: - -.. _RealmConfiguration_Builder_modules_Object_Object____: - -.. _RealmConfiguration_Builder_modules_Object__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules - | ) - - - - - * - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. Using this method will replace the current schema for this Realm with the schema defined by the provided modules. - - A reference to the default Realm module containing all Realm classes in the project (but not dependencies), can be found using :ref:`Realm.getDefaultModule() ` . Combining the schema from the app project and a library dependency is thus done using the following code: - - - - ``builder.modules(Realm.getDefaultMode(), new MyLibraryModule());`` - - - - - - - - - **Parameters** - - - ``baseModule`` - the first Realm module (required). - - - - - ``additionalModules`` - the additional Realm modules - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if any of the modules doesn't have the :ref:`RealmModule ` annotation. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Realm.getDefaultModule() ` - - - - - - - - - - - - -.. _name: - -.. _name__: - -.. _Builder_name: - -.. _Builder_name__: - -.. _RealmConfiguration_Builder_name: - -.. _RealmConfiguration_Builder_name__: - -.. _io_realm_RealmConfiguration_Builder_name: - -.. _io_realm_RealmConfiguration_Builder_name__: - - - -name ----- - -.. _io_realm_RealmConfiguration_Builder_name_java_lang_String_: - -.. _io_realm_RealmConfiguration_Builder_name_String_: - -.. _name_java_lang_String_: - -.. _name_String_: - -.. _RealmConfiguration_Builder_name_java_lang_String_: - -.. _RealmConfiguration_Builder_name_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`name ` ( - | `String `__ filename - | ) - - - - - * - Sets the filename for the Realm file. - - - - - - - - - - - - - - - -.. _readOnly: - -.. _readOnly__: - -.. _Builder_readOnly: - -.. _Builder_readOnly__: - -.. _RealmConfiguration_Builder_readOnly: - -.. _RealmConfiguration_Builder_readOnly__: - -.. _io_realm_RealmConfiguration_Builder_readOnly: - -.. _io_realm_RealmConfiguration_Builder_readOnly__: - - - -readOnly --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`readOnly ` () - | - - - - - * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - - This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. - - - - Marking a Realm as read only only applies to the Realm in this process. Other processes can still write to the Realm. - - - - - - - - - - - - - - - -.. _rxFactory: - -.. _rxFactory__: - -.. _Builder_rxFactory: - -.. _Builder_rxFactory__: - -.. _RealmConfiguration_Builder_rxFactory: - -.. _RealmConfiguration_Builder_rxFactory__: - -.. _io_realm_RealmConfiguration_Builder_rxFactory: - -.. _io_realm_RealmConfiguration_Builder_rxFactory__: - - - -rxFactory ---------- - -.. _io_realm_RealmConfiguration_Builder_rxFactory_io_realm_rx_RxObservableFactory_: - -.. _io_realm_RealmConfiguration_Builder_rxFactory_RxObservableFactory_: - -.. _rxFactory_io_realm_rx_RxObservableFactory_: - -.. _rxFactory_RxObservableFactory_: - -.. _RealmConfiguration_Builder_rxFactory_io_realm_rx_RxObservableFactory_: - -.. _RealmConfiguration_Builder_rxFactory_RxObservableFactory_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`rxFactory ` ( - | :ref:`RxObservableFactory ` factory - | ) - - - - - * - Sets the :ref:`RxObservableFactory ` used to create Rx Observables from Realm objects. The default factory is :ref:`RealmObservableFactory ` . - - - - - - - **Parameters** - - - ``factory`` - factory to use. - - - - - - - - - - - - - - - - -.. _schemaVersion: - -.. _schemaVersion__: - -.. _Builder_schemaVersion: - -.. _Builder_schemaVersion__: - -.. _RealmConfiguration_Builder_schemaVersion: - -.. _RealmConfiguration_Builder_schemaVersion__: - -.. _io_realm_RealmConfiguration_Builder_schemaVersion: - -.. _io_realm_RealmConfiguration_Builder_schemaVersion__: - - - -schemaVersion -------------- - -.. _io_realm_RealmConfiguration_Builder_schemaVersion_long_: - -.. _schemaVersion_long_: - -.. _RealmConfiguration_Builder_schemaVersion_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration.Builder ` :ref:`schemaVersion ` ( - | **long** schemaVersion - | ) - - - - - * - Sets the schema version of the Realm. This must be equal to or higher than the schema version of the existing Realm file, if any. If the schema version is higher than the already existing Realm, a migration is needed.If no migration code is provided, Realm will throw a :ref:`io.realm.exceptions.RealmMigrationNeededException ` . - - - - - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`migration(RealmMigration) ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmDictionary.txt b/source/sdk/java/api/io/realm/RealmDictionary.txt deleted file mode 100644 index 385d18e36e..0000000000 --- a/source/sdk/java/api/io/realm/RealmDictionary.txt +++ /dev/null @@ -1,157 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmDictionary -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmDictionary: - - - -io.realm -======== - - - | `java.lang.Object `__ - | :ref:`io.realm.RealmMap ` - | io.realm.RealmDictionary - - -Specialization of :ref:`RealmMap ` s whose keys are strings. - -Similarly to :ref:`RealmList ` s, a RealmDictionary can operate in managed and unmanaged modes. In managed mode a RealmDictionary persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashMap `__ . - - - -Managed RealmDictionaries can only be created by Realm and will automatically update its content whenever the underlying Realm is updated. Managed RealmDictionaries can only be accessed using the getter that points to a RealmDictionary field of a :ref:`RealmObject ` . - - - -Unmanaged RealmDictionaries can be created by the user and can contain both managed and unmanaged RealmObjects. This is useful when dealing with JSON deserializers like GSON or other frameworks that inject values into a class. Unmanaged RealmDictionaries can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmDictionary ` () - | - - - Instantiates a RealmDictionary in unmanaged mode. - - - - - * - | :ref:`RealmDictionary ` ( - | `java.util.Map\ `__ map - | ) - - - Instantiates a RealmDictionary in unmanaged mode with an initial dictionary. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.RealmMap ` : ``isManaged`` , ``isValid`` , ``isFrozen`` , ``size`` , ``isEmpty`` , ``containsKey`` , ``containsValue`` , ``get`` , ``put`` , ``remove`` , ``putAll`` , ``clear`` , ``keySet`` , ``values`` , ``entrySet`` , ``freeze`` , ``addChangeListener`` , ``addChangeListener`` , ``removeChangeListener`` , ``removeChangeListener`` , ``removeAllChangeListeners`` - - - - -Constructor Detail -================== - -.. _RealmDictionary: - -.. _RealmDictionary__: - -.. _io_realm_RealmDictionary: - -.. _io_realm_RealmDictionary__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmDictionary ` () - | - - - - - * - Instantiates a RealmDictionary in unmanaged mode. - - - - - - - - - - - -.. _RealmDictionary: - -.. _RealmDictionary__: - -.. _io_realm_RealmDictionary: - -.. _io_realm_RealmDictionary__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmDictionary ` ( - | `java.util.Map\ `__ map - | ) - - - - - * - Instantiates a RealmDictionary in unmanaged mode with an initial dictionary. - - - - - **Parameters** - - - ``map`` - initial dictionary - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmFieldType.txt b/source/sdk/java/api/io/realm/RealmFieldType.txt deleted file mode 100644 index bbe9d936f1..0000000000 --- a/source/sdk/java/api/io/realm/RealmFieldType.txt +++ /dev/null @@ -1,1515 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum RealmFieldType -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmFieldType: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.RealmFieldType - - -List of the types used by Realm's underlying storage engine.Normally there is no reason to interact with the underlying Realm types as Realm will automatically convert between normal Java types and the Realm types. However it is possible to access these types through a :ref:`DynamicRealmObject ` . - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`BINARY ` - - - - - - - * - :ref:`BINARY_LIST ` - - - - - - - * - :ref:`BINARY_SET ` - - - - - - - * - :ref:`BOOLEAN ` - - - - - - - * - :ref:`BOOLEAN_LIST ` - - - - - - - * - :ref:`BOOLEAN_SET ` - - - - - - - * - :ref:`DATE ` - - - - - - - * - :ref:`DATE_LIST ` - - - - - - - * - :ref:`DATE_SET ` - - - - - - - * - :ref:`DECIMAL128 ` - - - - - - - * - :ref:`DECIMAL128_LIST ` - - - - - - - * - :ref:`DECIMAL128_SET ` - - - - - - - * - :ref:`DOUBLE ` - - - - - - - * - :ref:`DOUBLE_LIST ` - - - - - - - * - :ref:`DOUBLE_SET ` - - - - - - - * - :ref:`FLOAT ` - - - - - - - * - :ref:`FLOAT_LIST ` - - - - - - - * - :ref:`FLOAT_SET ` - - - - - - - * - :ref:`INTEGER ` - - - - - - - * - :ref:`INTEGER_LIST ` - - - - - - - * - :ref:`INTEGER_SET ` - - - - - - - * - :ref:`LINKING_OBJECTS ` - - - - - - - * - :ref:`LINK_SET ` - - - - - - - * - :ref:`LIST ` - - - - - - - * - :ref:`MIXED ` - - - - - - - * - :ref:`MIXED_LIST ` - - - - - - - * - :ref:`MIXED_SET ` - - - - - - - * - :ref:`OBJECT ` - - - - - - - * - :ref:`OBJECT_ID ` - - - - - - - * - :ref:`OBJECT_ID_LIST ` - - - - - - - * - :ref:`OBJECT_ID_SET ` - - - - - - - * - :ref:`STRING ` - - - - - - - * - :ref:`STRING_LIST ` - - - - - - - * - :ref:`STRING_SET ` - - - - - - - * - :ref:`STRING_TO_BINARY_MAP ` - - - - - - - * - :ref:`STRING_TO_BOOLEAN_MAP ` - - - - - - - * - :ref:`STRING_TO_DATE_MAP ` - - - - - - - * - :ref:`STRING_TO_DECIMAL128_MAP ` - - - - - - - * - :ref:`STRING_TO_DOUBLE_MAP ` - - - - - - - * - :ref:`STRING_TO_FLOAT_MAP ` - - - - - - - * - :ref:`STRING_TO_INTEGER_MAP ` - - - - - - - * - :ref:`STRING_TO_LINK_MAP ` - - - - - - - * - :ref:`STRING_TO_MIXED_MAP ` - - - - - - - * - :ref:`STRING_TO_OBJECT_ID_MAP ` - - - - - - - * - :ref:`STRING_TO_STRING_MAP ` - - - - - - - * - :ref:`STRING_TO_UUID_MAP ` - - - - - - - * - :ref:`TYPED_LINK ` - - - - - - - * - :ref:`UUID ` - - - - - - - * - :ref:`UUID_LIST ` - - - - - - - * - :ref:`UUID_SET ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`RealmFieldType ` - - | :ref:`fromNativeValue ` ( - | **int** value - | ) - - - Converts the underlying value used by the storage engine to the proper Realm type. - - - - - * - public **int** - - | :ref:`getNativeValue ` () - | - - - Returns the native value representing this type. - - - - - * - public **boolean** - - | :ref:`isValid ` ( - | `Object `__ obj - | ) - - - Checks if the given Java object can be converted to the underlying Realm type. - - - - - * - public static :ref:`RealmFieldType ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`RealmFieldType ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_RealmFieldType_BINARY: - -.. _RealmFieldType_BINARY: - - - -``BINARY`` ------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_BINARY_LIST: - -.. _RealmFieldType_BINARY_LIST: - - - -``BINARY_LIST`` ----------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_BINARY_SET: - -.. _RealmFieldType_BINARY_SET: - - - -``BINARY_SET`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_BOOLEAN: - -.. _RealmFieldType_BOOLEAN: - - - -``BOOLEAN`` ------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_BOOLEAN_LIST: - -.. _RealmFieldType_BOOLEAN_LIST: - - - -``BOOLEAN_LIST`` ------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_BOOLEAN_SET: - -.. _RealmFieldType_BOOLEAN_SET: - - - -``BOOLEAN_SET`` ----------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DATE: - -.. _RealmFieldType_DATE: - - - -``DATE`` ---------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DATE_LIST: - -.. _RealmFieldType_DATE_LIST: - - - -``DATE_LIST`` --------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DATE_SET: - -.. _RealmFieldType_DATE_SET: - - - -``DATE_SET`` -------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DECIMAL128: - -.. _RealmFieldType_DECIMAL128: - - - -``DECIMAL128`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DECIMAL128_LIST: - -.. _RealmFieldType_DECIMAL128_LIST: - - - -``DECIMAL128_LIST`` --------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DECIMAL128_SET: - -.. _RealmFieldType_DECIMAL128_SET: - - - -``DECIMAL128_SET`` -------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DOUBLE: - -.. _RealmFieldType_DOUBLE: - - - -``DOUBLE`` ------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DOUBLE_LIST: - -.. _RealmFieldType_DOUBLE_LIST: - - - -``DOUBLE_LIST`` ----------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_DOUBLE_SET: - -.. _RealmFieldType_DOUBLE_SET: - - - -``DOUBLE_SET`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_FLOAT: - -.. _RealmFieldType_FLOAT: - - - -``FLOAT`` ----------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_FLOAT_LIST: - -.. _RealmFieldType_FLOAT_LIST: - - - -``FLOAT_LIST`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_FLOAT_SET: - -.. _RealmFieldType_FLOAT_SET: - - - -``FLOAT_SET`` --------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_INTEGER: - -.. _RealmFieldType_INTEGER: - - - -``INTEGER`` ------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_INTEGER_LIST: - -.. _RealmFieldType_INTEGER_LIST: - - - -``INTEGER_LIST`` ------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_INTEGER_SET: - -.. _RealmFieldType_INTEGER_SET: - - - -``INTEGER_SET`` ----------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_LINKING_OBJECTS: - -.. _RealmFieldType_LINKING_OBJECTS: - - - -``LINKING_OBJECTS`` --------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_LINK_SET: - -.. _RealmFieldType_LINK_SET: - - - -``LINK_SET`` -------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_LIST: - -.. _RealmFieldType_LIST: - - - -``LIST`` ---------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_MIXED: - -.. _RealmFieldType_MIXED: - - - -``MIXED`` ----------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_MIXED_LIST: - -.. _RealmFieldType_MIXED_LIST: - - - -``MIXED_LIST`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_MIXED_SET: - -.. _RealmFieldType_MIXED_SET: - - - -``MIXED_SET`` --------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_OBJECT: - -.. _RealmFieldType_OBJECT: - - - -``OBJECT`` ------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_OBJECT_ID: - -.. _RealmFieldType_OBJECT_ID: - - - -``OBJECT_ID`` --------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_OBJECT_ID_LIST: - -.. _RealmFieldType_OBJECT_ID_LIST: - - - -``OBJECT_ID_LIST`` -------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_OBJECT_ID_SET: - -.. _RealmFieldType_OBJECT_ID_SET: - - - -``OBJECT_ID_SET`` ------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING: - -.. _RealmFieldType_STRING: - - - -``STRING`` ------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_LIST: - -.. _RealmFieldType_STRING_LIST: - - - -``STRING_LIST`` ----------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_SET: - -.. _RealmFieldType_STRING_SET: - - - -``STRING_SET`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_BINARY_MAP: - -.. _RealmFieldType_STRING_TO_BINARY_MAP: - - - -``STRING_TO_BINARY_MAP`` -------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_BOOLEAN_MAP: - -.. _RealmFieldType_STRING_TO_BOOLEAN_MAP: - - - -``STRING_TO_BOOLEAN_MAP`` --------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_DATE_MAP: - -.. _RealmFieldType_STRING_TO_DATE_MAP: - - - -``STRING_TO_DATE_MAP`` ------------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_DECIMAL128_MAP: - -.. _RealmFieldType_STRING_TO_DECIMAL128_MAP: - - - -``STRING_TO_DECIMAL128_MAP`` ------------------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_DOUBLE_MAP: - -.. _RealmFieldType_STRING_TO_DOUBLE_MAP: - - - -``STRING_TO_DOUBLE_MAP`` -------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_FLOAT_MAP: - -.. _RealmFieldType_STRING_TO_FLOAT_MAP: - - - -``STRING_TO_FLOAT_MAP`` ------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_INTEGER_MAP: - -.. _RealmFieldType_STRING_TO_INTEGER_MAP: - - - -``STRING_TO_INTEGER_MAP`` --------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_LINK_MAP: - -.. _RealmFieldType_STRING_TO_LINK_MAP: - - - -``STRING_TO_LINK_MAP`` ------------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_MIXED_MAP: - -.. _RealmFieldType_STRING_TO_MIXED_MAP: - - - -``STRING_TO_MIXED_MAP`` ------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_OBJECT_ID_MAP: - -.. _RealmFieldType_STRING_TO_OBJECT_ID_MAP: - - - -``STRING_TO_OBJECT_ID_MAP`` ----------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_STRING_MAP: - -.. _RealmFieldType_STRING_TO_STRING_MAP: - - - -``STRING_TO_STRING_MAP`` -------------------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_STRING_TO_UUID_MAP: - -.. _RealmFieldType_STRING_TO_UUID_MAP: - - - -``STRING_TO_UUID_MAP`` ------------------------ - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_TYPED_LINK: - -.. _RealmFieldType_TYPED_LINK: - - - -``TYPED_LINK`` ---------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_UUID: - -.. _RealmFieldType_UUID: - - - -``UUID`` ---------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_UUID_LIST: - -.. _RealmFieldType_UUID_LIST: - - - -``UUID_LIST`` --------------- - -public static final :ref:`RealmFieldType ` - - - - - -.. _io_realm_RealmFieldType_UUID_SET: - -.. _RealmFieldType_UUID_SET: - - - -``UUID_SET`` -------------- - -public static final :ref:`RealmFieldType ` - - - - - - -Method Detail -============= - -.. _fromNativeValue: - -.. _fromNativeValue__: - -.. _RealmFieldType_fromNativeValue: - -.. _RealmFieldType_fromNativeValue__: - -.. _io_realm_RealmFieldType_fromNativeValue: - -.. _io_realm_RealmFieldType_fromNativeValue__: - - - -fromNativeValue ---------------- - -.. _io_realm_RealmFieldType_fromNativeValue_int_: - -.. _fromNativeValue_int_: - -.. _RealmFieldType_fromNativeValue_int_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmFieldType ` :ref:`fromNativeValue ` ( - | **int** value - | ) - - - - - * - Converts the underlying value used by the storage engine to the proper Realm type. - - - - - **Parameters** - - - ``value`` - the value to convert - - - - - - - - **Returns** - - the corresponding Realm type. - - - - - **Throws** - - - `IllegalArgumentException `__ - if value isn't valid. - - - - - - - - - - - - -.. _getNativeValue: - -.. _getNativeValue__: - -.. _RealmFieldType_getNativeValue: - -.. _RealmFieldType_getNativeValue__: - -.. _io_realm_RealmFieldType_getNativeValue: - -.. _io_realm_RealmFieldType_getNativeValue__: - - - -getNativeValue --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getNativeValue ` () - | - - - - - * - Returns the native value representing this type. - - - - - - - **Returns** - - the value used by the underlying storage engine to represent this type. - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmFieldType_isValid: - -.. _RealmFieldType_isValid__: - -.. _io_realm_RealmFieldType_isValid: - -.. _io_realm_RealmFieldType_isValid__: - - - -isValid -------- - -.. _io_realm_RealmFieldType_isValid_java_lang_Object_: - -.. _io_realm_RealmFieldType_isValid_Object_: - -.. _isValid_java_lang_Object_: - -.. _isValid_Object_: - -.. _RealmFieldType_isValid_java_lang_Object_: - -.. _RealmFieldType_isValid_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` ( - | `Object `__ obj - | ) - - - - - * - Checks if the given Java object can be converted to the underlying Realm type. - - - - - **Parameters** - - - ``obj`` - object to test compatibility on. - - - - - - - - **Returns** - - ``true`` if object can be converted to the Realm type, ``false`` otherwise. - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _RealmFieldType_valueOf: - -.. _RealmFieldType_valueOf__: - -.. _io_realm_RealmFieldType_valueOf: - -.. _io_realm_RealmFieldType_valueOf__: - - - -valueOf -------- - -.. _io_realm_RealmFieldType_valueOf_java_lang_String_: - -.. _io_realm_RealmFieldType_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _RealmFieldType_valueOf_java_lang_String_: - -.. _RealmFieldType_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmFieldType ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _RealmFieldType_values: - -.. _RealmFieldType_values__: - -.. _io_realm_RealmFieldType_values: - -.. _io_realm_RealmFieldType_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmFieldType ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmList.txt b/source/sdk/java/api/io/realm/RealmList.txt deleted file mode 100644 index d02d122db7..0000000000 --- a/source/sdk/java/api/io/realm/RealmList.txt +++ /dev/null @@ -1,4245 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmList -^^^^^^^^^^^^^^^ - -.. _io_realm_RealmList: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ - | io.realm.RealmList - - -**Implemented interfaces:** - - - -- :ref:`io.realm.OrderedRealmCollection ` -- `java.util.List `__ -- :ref:`io.realm.RealmCollection ` -- `java.util.Collection `__ -- `java.lang.Iterable `__ -- `java.util.Collection `__ -- `java.lang.Iterable `__ - - -RealmList is used to model one-to-many relationships in a :ref:`io.realm.RealmObject ` . RealmList has two modes: A managed and unmanaged mode. In managed mode all objects are persisted inside a Realm, in unmanaged mode it works as a normal ArrayList. - -Only Realm can create managed RealmLists. Managed RealmLists will automatically update the content whenever the underlying Realm is updated, and can only be accessed using the getter of a :ref:`io.realm.RealmObject ` . - - - -Unmanaged RealmLists can be created by the user and can contain both managed and unmanaged RealmObjects. This is useful when dealing with JSON deserializers like GSON or other frameworks that inject values into a class. Unmanaged elements in this list can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. - - - -:ref:`RealmList ` can contain more elements than ``Integer.MAX_VALUE`` . In that case, you can access only first ``Integer.MAX_VALUE`` elements in it. - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmList ` () - | - - - Creates a RealmList in unmanaged mode, where the elements are not controlled by a Realm. - - - - - * - | :ref:`RealmList ` ( - | **E[]** objects - | ) - - - Creates a RealmList in unmanaged mode with an initial list of elements. - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public final **BaseRealm** - - - - :ref:`baseRealm ` - - The **BaseRealm** instance in which this list resides. - - Warning: This field is only exposed for internal usage, and should not be used. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`add ` ( - | **E** object - | ) - - - Adds the specified object at the end of this List. - - - - - * - public **void** - - | :ref:`add ` ( - | **int** location, - | **E** element - | ) - - - Inserts the specified object into this List at the specified location. - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmList ` . - - - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`asChangesetObservable ` () - | - - - Returns an Rx Observable that monitors changes to this RealmList. - - - - - * - public **** - - | :ref:`asFlowable ` () - | - - - Returns an Rx Flowable that monitors changes to this RealmList. - - - - - * - public **double** - - | :ref:`average ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public **void** - - | :ref:`clear ` () - | - - - Removes all elements from this list, leaving it empty. - - - - - * - public **boolean** - - | :ref:`contains ` ( - | `Object `__ object - | ) - - - Returns ``true`` if the list contains the specified element when attached to a Realm. - - - - - - - * - public :ref:`OrderedRealmCollectionSnapshot ` - - | :ref:`createSnapshot ` () - | - - - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - * - public **boolean** - - | :ref:`deleteAllFromRealm ` () - | - - - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - * - public **boolean** - - | :ref:`deleteFirstFromRealm ` () - | - - - Deletes the first object from the Realm. - - - - - * - public **void** - - | :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - Deletes the object at the given index from the Realm. - - - - - * - public **boolean** - - | :ref:`deleteLastFromRealm ` () - | - - - Deletes the last object from the Realm. - - - - - * - public **E** - - | :ref:`first ` ( - | **E** defaultValue - | ) - - - Gets the first object from the collection. - - - - - * - public **E** - - | :ref:`first ` () - | - - - Gets the first object from the collection. - - - - - * - public :ref:`RealmList ` - - | :ref:`freeze ` () - | - - - - - - - - - - * - public **E** - - | :ref:`get ` ( - | **int** location - | ) - - - Returns the element at the specified location in this list. - - - - - * - public :ref:`Realm ` - - | :ref:`getRealm ` () - | - - - Returns the :ref:`Realm ` instance to which this collection belongs. - - - - - - - * - public **boolean** - - | :ref:`isFrozen ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - Checks if a collection has finished loading its data yet. - - - - - * - public **boolean** - - | :ref:`isManaged ` () - | - - - Checks if the collection is managed by Realm. - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. - - - - - - - * - public `Iterator `__ - - | :ref:`iterator ` () - | - - - - - - - - - - * - public **E** - - | :ref:`last ` ( - | **E** defaultValue - | ) - - - Gets the last object from the collection. - - - - - * - public **E** - - | :ref:`last ` () - | - - - Gets the last object from the collection. - - - - - * - public `ListIterator `__ - - | :ref:`listIterator ` ( - | **int** location - | ) - - - - - - - - - - * - public `ListIterator `__ - - | :ref:`listIterator ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`load ` () - | - - - Blocks the collection until all data are available. - - - - - * - public `Number `__ - - | :ref:`max ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a field. - - - - - * - public `Date `__ - - | :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - Finds the maximum date. - - - - - * - public `Number `__ - - | :ref:`min ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a field. - - - - - * - public `Date `__ - - | :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - Finds the minimum date. - - - - - * - public **void** - - | :ref:`move ` ( - | **int** oldPos, - | **int** newPos - | ) - - - Moves an object from one position to another, while maintaining a fixed sized list. - - - - - * - public **boolean** - - | :ref:`remove ` ( - | `Object `__ object - | ) - - - Removes one instance of the specified object from this ``Collection`` if one is contained. - - - - - - - * - public **E** - - | :ref:`remove ` ( - | **int** location - | ) - - - Removes the object at the specified location from this list. - - - - - * - public **boolean** - - | :ref:`removeAll ` ( - | `java.util.Collection\ `__ collection - | ) - - - Removes all occurrences in this ``Collection`` of each object in the specified ``Collection`` . - - - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **E** - - | :ref:`set ` ( - | **int** location, - | **E** object - | ) - - - Replaces the element at the specified location in this list with the specified object. - - - - - * - public **int** - - | :ref:`size ` () - | - - - Returns the number of elements in this ``List`` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - Sorts a collection based on the provided fields and sort orders. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - Sorts a collection based on the provided fields and sort orders. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - Sorts a collection based on the provided field and sort order. - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName - | ) - - - Sorts a collection based on the provided field in ascending order. - - - - - * - public `Number `__ - - | :ref:`sum ` ( - | `String `__ fieldName - | ) - - - Calculates the sum of a given field. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` () - | - - - Returns a RealmQuery, which can be used to query for specific objects of this class. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` - - - - -Field Detail -============ - -.. _io_realm_RealmList_baseRealm: - - - -``baseRealm`` --------------- - -The **BaseRealm** instance in which this list resides. - -Warning: This field is only exposed for internal usage, and should not be used. - - - - - - -Constructor Detail -================== - -.. _RealmList: - -.. _RealmList__: - -.. _io_realm_RealmList: - -.. _io_realm_RealmList__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmList ` () - | - - - - - * - Creates a RealmList in unmanaged mode, where the elements are not controlled by a Realm. This effectively makes the RealmList function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. - - Use :ref:`io.realm.Realm.copyToRealm(Iterable, ImportFlag...) ` to properly persist its elements in Realm. - - - - - - - - - - - - - - - -.. _RealmList: - -.. _RealmList__: - -.. _io_realm_RealmList: - -.. _io_realm_RealmList__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmList ` ( - | **E[]** objects - | ) - - - - - * - Creates a RealmList in unmanaged mode with an initial list of elements. A RealmList in unmanaged mode function as a `java.util.ArrayList `__ and it is not possible to query the objects in this state. - - Use :ref:`io.realm.Realm.copyToRealm(Iterable, ImportFlag...) ` to properly persist all unmanaged elements in Realm. - - - - - - - - - **Parameters** - - - ``objects`` - initial objects in the list. - - - - - - - - - - - - - - -Method Detail -============= - -.. _add: - -.. _add__: - -.. _RealmList_add: - -.. _RealmList_add__: - -.. _io_realm_RealmList_add: - -.. _io_realm_RealmList_add__: - - - -add ----- - -.. _io_realm_RealmList_add_E_: - -.. _add_E_: - -.. _RealmList_add_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`add ` ( - | **E** object - | ) - - - - - * - Adds the specified object at the end of this List. - - 1. **Unmanaged RealmLists**: It is possible to add both managed and unmanaged objects. If adding managed objects to an unmanaged RealmList they will not be copied to the Realm again if using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` afterwards. - - - - - #. **Managed RealmLists**: It is possible to add unmanaged objects to a RealmList that is already managed. In that case the object will transparently be copied to Realm using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` or :ref:`Realm.copyToRealmOrUpdate(RealmModel, ImportFlag...) ` if it has a primary key. - - - - - - - - - - - - **Parameters** - - - ``object`` - the object to add. - - - - - - - - **Returns** - - always ``true`` . - - - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - - - - **Overrides** - - ``add`` in class `AbstractList `__ - - - - -.. _io_realm_RealmList_add_int_E_: - -.. _io_realm_RealmList_add_int__E_: - -.. _add_int_E_: - -.. _add_int__E_: - -.. _RealmList_add_int_E_: - -.. _RealmList_add_int__E_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`add ` ( - | **int** location, - | **E** element - | ) - - - - - * - Inserts the specified object into this List at the specified location. The object is inserted before any previous element at the specified location. If the location is equal to the size of this List, the object is added at the end. - - 1. **Unmanaged RealmLists**: It is possible to add both managed and unmanaged objects. If adding managed objects to an unmanaged RealmList they will not be copied to the Realm again if using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` afterwards. - - - - - #. **Managed RealmLists**: It is possible to add unmanaged objects to a RealmList that is already managed. In that case the object will transparently be copied to Realm using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` or :ref:`Realm.copyToRealmOrUpdate(RealmModel, ImportFlag...) ` if it has a primary key. - - - - - - - - - - - - **Parameters** - - - ``location`` - the index at which to insert. - - - - - ``element`` - the element to add. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or container object has been removed. - - - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location > size()`` . - - - - - - - - - - **Overrides** - - ``add`` in class `AbstractList `__ - - - - - - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _RealmList_addChangeListener: - -.. _RealmList_addChangeListener__: - -.. _io_realm_RealmList_addChangeListener: - -.. _io_realm_RealmList_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_RealmList_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmList_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _RealmList_addChangeListener_io_realm_RealmChangeListener_: - -.. _RealmList_addChangeListener_RealmChangeListener_: - -.. _io_realm_RealmList_addChangeListener_RealmChangeListener_RealmList_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmList ` . - - Registering a change listener will not prevent the underlying RealmList from being garbage collected. If the RealmList is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmList dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new RealmChangeListener>() { - @Override - public void onChange(RealmList dogs) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - -.. _io_realm_RealmList_addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmList_addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _RealmList_addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _RealmList_addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmList_addChangeListener_OrderedRealmCollectionChangeListener_RealmList_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmList ` . - - Registering a change listener will not prevent the underlying RealmList from being garbage collected. If the RealmList is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmList dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new OrderedRealmCollectionChangeListener>() { - @Override - public void onChange(RealmList dogs, OrderedCollectionChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - - - -.. _asChangesetObservable: - -.. _asChangesetObservable__: - -.. _RealmList_asChangesetObservable: - -.. _RealmList_asChangesetObservable__: - -.. _io_realm_RealmList_asChangesetObservable: - -.. _io_realm_RealmList_asChangesetObservable__: - - - -asChangesetObservable ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asChangesetObservable ` () - | - - - - - * - Returns an Rx Observable that monitors changes to this RealmList. It will emit the current RealmList when subscribed. For each update to the RealmList a pair consisting of the RealmList and the :ref:`OrderedCollectionChangeSet ` will be sent. The changeset will be ``null`` the first time an RealmList is emitted. - - RealmList will continually be emitted as the RealmList is updated - ``onComplete`` will never be called. - - - - Items emitted from Realm Observables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Observables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - list.asChangesetObservable() - .observeOn(Schedulers.computation()) - .map((rxList, changes) -> doExpensiveWork(rxList, changes)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _asFlowable: - -.. _asFlowable__: - -.. _RealmList_asFlowable: - -.. _RealmList_asFlowable__: - -.. _io_realm_RealmList_asFlowable: - -.. _io_realm_RealmList_asFlowable__: - - - -asFlowable ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asFlowable ` () - | - - - - - * - Returns an Rx Flowable that monitors changes to this RealmList. It will emit the current RealmList when subscribed to. RealmList will continually be emitted as the RealmList is updated - ``onComplete`` will never be called. - - Items emitted from Realm Flowables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live RealmList. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - list.asFlowable() - .observeOn(Schedulers.computation()) - .map(rxResults -> doExpensiveWork(rxResults)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items you can instruct RxJava to only emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - list.asFlowable() - .first() - .subscribe( ... ) // You only get the results once - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _average: - -.. _average__: - -.. _RealmList_average: - -.. _RealmList_average__: - -.. _io_realm_RealmList_average: - -.. _io_realm_RealmList_average__: - - - -average -------- - -.. _io_realm_RealmList_average_java_lang_String_: - -.. _io_realm_RealmList_average_String_: - -.. _average_java_lang_String_: - -.. _average_String_: - -.. _RealmList_average_java_lang_String_: - -.. _RealmList_average_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`average ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _clear: - -.. _clear__: - -.. _RealmList_clear: - -.. _RealmList_clear__: - -.. _io_realm_RealmList_clear: - -.. _io_realm_RealmList_clear__: - - - -clear ------ - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`clear ` () - | - - - - - * - Removes all elements from this list, leaving it empty. This method doesn't remove the objects from the Realm. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - - - - **Overrides** - - ``clear`` in class `AbstractList `__ - - - - .. seealso:: - - - - - `List.isEmpty `__ - - - - - `List.size `__ - - - - - :ref:`deleteAllFromRealm() ` - - - - - - - - - - - - -.. _contains: - -.. _contains__: - -.. _RealmList_contains: - -.. _RealmList_contains__: - -.. _io_realm_RealmList_contains: - -.. _io_realm_RealmList_contains__: - - - -contains --------- - -.. _io_realm_RealmList_contains_java_lang_Object_: - -.. _io_realm_RealmList_contains_Object_: - -.. _contains_java_lang_Object_: - -.. _contains_Object_: - -.. _RealmList_contains_java_lang_Object_: - -.. _RealmList_contains_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`contains ` ( - | `Object `__ object - | ) - - - - - * - Returns ``true`` if the list contains the specified element when attached to a Realm. This method will query the native Realm underlying storage engine to quickly find the specified element. - - If the list is not attached to a Realm, the default `List.contains(Object) `__ implementation will occur. - - - - - - - - - **Parameters** - - - ``object`` - the element whose presence in this list is to be tested. - - - - - - - - **Returns** - - ``true`` if this list contains the specified element otherwise ``false`` . - - - - - - - - - **Overrides** - - ``contains`` in class `AbstractCollection `__ - - - - - - -.. _createSnapshot: - -.. _createSnapshot__: - -.. _RealmList_createSnapshot: - -.. _RealmList_createSnapshot__: - -.. _io_realm_RealmList_createSnapshot: - -.. _io_realm_RealmList_createSnapshot__: - - - -createSnapshot --------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedRealmCollectionSnapshot ` :ref:`createSnapshot ` () - | - - - - - * - Creates a snapshot from this :ref:`OrderedRealmCollection ` . - - - - - - - - - **Returns** - - the snapshot of this collection. - - - - - - - - - - - -.. _deleteAllFromRealm: - -.. _deleteAllFromRealm__: - -.. _RealmList_deleteAllFromRealm: - -.. _RealmList_deleteAllFromRealm__: - -.. _io_realm_RealmList_deleteAllFromRealm: - -.. _io_realm_RealmList_deleteAllFromRealm__: - - - -deleteAllFromRealm ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteAllFromRealm ` () - | - - - - - * - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - - - **Returns** - - ``true`` if objects was deleted, ``false`` otherwise. - - - - - - - - - - - - - -.. _deleteFirstFromRealm: - -.. _deleteFirstFromRealm__: - -.. _RealmList_deleteFirstFromRealm: - -.. _RealmList_deleteFirstFromRealm__: - -.. _io_realm_RealmList_deleteFirstFromRealm: - -.. _io_realm_RealmList_deleteFirstFromRealm__: - - - -deleteFirstFromRealm --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteFirstFromRealm ` () - | - - - - - * - Deletes the first object from the Realm. This also removes it from this collection. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - - - - - - - -.. _deleteFromRealm: - -.. _deleteFromRealm__: - -.. _RealmList_deleteFromRealm: - -.. _RealmList_deleteFromRealm__: - -.. _io_realm_RealmList_deleteFromRealm: - -.. _io_realm_RealmList_deleteFromRealm__: - - - -deleteFromRealm ---------------- - -.. _io_realm_RealmList_deleteFromRealm_int_: - -.. _deleteFromRealm_int_: - -.. _RealmList_deleteFromRealm_int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`deleteFromRealm ` ( - | **int** location - | ) - - - - - * - Deletes the object at the given index from the Realm. This also removes it from the collection. - - - - - - - - - - - - - - - -.. _deleteLastFromRealm: - -.. _deleteLastFromRealm__: - -.. _RealmList_deleteLastFromRealm: - -.. _RealmList_deleteLastFromRealm__: - -.. _io_realm_RealmList_deleteLastFromRealm: - -.. _io_realm_RealmList_deleteLastFromRealm__: - - - -deleteLastFromRealm -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteLastFromRealm ` () - | - - - - - * - Deletes the last object from the Realm. This also removes it from this collection. - - - - - - - **Returns** - - ``true`` if an object was deleted, ``false`` otherwise. - - - - - - - - - - - - - -.. _first: - -.. _first__: - -.. _RealmList_first: - -.. _RealmList_first__: - -.. _io_realm_RealmList_first: - -.. _io_realm_RealmList_first__: - - - -first ------ - -.. _io_realm_RealmList_first_E_: - -.. _first_E_: - -.. _RealmList_first_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`first ` ( - | **E** defaultValue - | ) - - - - - * - Gets the first object from the collection. If the collection is empty, the provided default will be used instead. - - - - - - - **Returns** - - the first object or the provided default. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`first ` () - | - - - - - * - Gets the first object from the collection. - - - - - - - **Returns** - - the first object. - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmList_freeze: - -.. _RealmList_freeze__: - -.. _io_realm_RealmList_freeze: - -.. _io_realm_RealmList_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmList ` :ref:`freeze ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _get: - -.. _get__: - -.. _RealmList_get: - -.. _RealmList_get__: - -.. _io_realm_RealmList_get: - -.. _io_realm_RealmList_get__: - - - -get ----- - -.. _io_realm_RealmList_get_int_: - -.. _get_int_: - -.. _RealmList_get_int_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`get ` ( - | **int** location - | ) - - - - - * - Returns the element at the specified location in this list. - - - - - **Parameters** - - - ``location`` - the index of the element to return. - - - - - - - - **Returns** - - the element at the specified index. - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - - - - - - - - - **Overrides** - - ``get`` in class `AbstractList `__ - - - - - - -.. _getRealm: - -.. _getRealm__: - -.. _RealmList_getRealm: - -.. _RealmList_getRealm__: - -.. _io_realm_RealmList_getRealm: - -.. _io_realm_RealmList_getRealm__: - - - -getRealm --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Realm ` :ref:`getRealm ` () - | - - - - - * - Returns the :ref:`Realm ` instance to which this collection belongs. - - Calling **Realm.close()** on the returned instance is discouraged as it is the same as calling it on the original Realm instance which may cause the Realm to fully close invalidating the list. - - - - - - - - - - - **Returns** - - :ref:`Realm ` instance this collection belongs to or ``null`` if the collection is unmanaged. - - - - - - - **Throws** - - - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _RealmList_isFrozen: - -.. _RealmList_isFrozen__: - -.. _io_realm_RealmList_isFrozen: - -.. _io_realm_RealmList_isFrozen__: - - - -isFrozen --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFrozen ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _RealmList_isLoaded: - -.. _RealmList_isLoaded__: - -.. _io_realm_RealmList_isLoaded: - -.. _io_realm_RealmList_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - Checks if a collection has finished loading its data yet. - - - - - - - **Returns** - - ``true`` if data has been loaded and is available, ``false`` if data is still being loaded. - - - - - - - - - - - - - -.. _isManaged: - -.. _isManaged__: - -.. _RealmList_isManaged: - -.. _RealmList_isManaged__: - -.. _io_realm_RealmList_isManaged: - -.. _io_realm_RealmList_isManaged__: - - - -isManaged ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isManaged ` () - | - - - - - * - Checks if the collection is managed by Realm. A managed collection is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed collection will be live-updated so it always points to the latest data. Managed collections are thread confined so that they cannot be accessed from other threads than the one that created them.If this method returns ``false`` , the collection is unmanaged. An unmanaged collection is just a normal java collection, so it will not be live updated. - - - - - - - - - - - **Returns** - - ``true`` if this is a managed :ref:`RealmCollection ` , ``false`` otherwise. - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmList_isValid: - -.. _RealmList_isValid__: - -.. _io_realm_RealmList_isValid: - -.. _io_realm_RealmList_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. It will always return ``true`` for an unmanaged collection. - - - - - - - - - **Returns** - - ``true`` if it is still valid to use or an unmanaged collection, ``false`` otherwise. - - - - - - - - - - - - - -.. _iterator: - -.. _iterator__: - -.. _RealmList_iterator: - -.. _RealmList_iterator__: - -.. _io_realm_RealmList_iterator: - -.. _io_realm_RealmList_iterator__: - - - -iterator --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Iterator `__ :ref:`iterator ` () - | - - - - - * - - - - - - - - - - - - - - **Overrides** - - ``iterator`` in class `AbstractList `__ - - - - - - -.. _last: - -.. _last__: - -.. _RealmList_last: - -.. _RealmList_last__: - -.. _io_realm_RealmList_last: - -.. _io_realm_RealmList_last__: - - - -last ----- - -.. _io_realm_RealmList_last_E_: - -.. _last_E_: - -.. _RealmList_last_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`last ` ( - | **E** defaultValue - | ) - - - - - * - Gets the last object from the collection. If the collection is empty, the provided default will be used instead. - - - - - - - **Returns** - - the last object or the provided default. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`last ` () - | - - - - - * - Gets the last object from the collection. - - - - - - - **Returns** - - the last object. - - - - - - - - - - - -.. _listIterator: - -.. _listIterator__: - -.. _RealmList_listIterator: - -.. _RealmList_listIterator__: - -.. _io_realm_RealmList_listIterator: - -.. _io_realm_RealmList_listIterator__: - - - -listIterator ------------- - -.. _io_realm_RealmList_listIterator_int_: - -.. _listIterator_int_: - -.. _RealmList_listIterator_int_: - -.. list-table:: - :header-rows: 1 - - * - | public `ListIterator `__ :ref:`listIterator ` ( - | **int** location - | ) - - - - - * - - - - - - - - - - - - - - **Overrides** - - ``listIterator`` in class `AbstractList `__ - - - - -.. list-table:: - :header-rows: 1 - - * - | public `ListIterator `__ :ref:`listIterator ` () - | - - - - - * - - - - - - - - - - - - - - **Overrides** - - ``listIterator`` in class `AbstractList `__ - - - - - - -.. _load: - -.. _load__: - -.. _RealmList_load: - -.. _RealmList_load__: - -.. _io_realm_RealmList_load: - -.. _io_realm_RealmList_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`load ` () - | - - - - - * - Blocks the collection until all data are available. - - - - - - - **Returns** - - ``true`` if the data could be successfully loaded, ``false`` otherwise. - - - - - - - - - - - - - -.. _max: - -.. _max__: - -.. _RealmList_max: - -.. _RealmList_max__: - -.. _io_realm_RealmList_max: - -.. _io_realm_RealmList_max__: - - - -max ----- - -.. _io_realm_RealmList_max_java_lang_String_: - -.. _io_realm_RealmList_max_String_: - -.. _max_java_lang_String_: - -.. _max_String_: - -.. _RealmList_max_java_lang_String_: - -.. _RealmList_max_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a field. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _maxDate: - -.. _maxDate__: - -.. _RealmList_maxDate: - -.. _RealmList_maxDate__: - -.. _io_realm_RealmList_maxDate: - -.. _io_realm_RealmList_maxDate__: - - - -maxDate -------- - -.. _io_realm_RealmList_maxDate_java_lang_String_: - -.. _io_realm_RealmList_maxDate_String_: - -.. _maxDate_java_lang_String_: - -.. _maxDate_String_: - -.. _RealmList_maxDate_java_lang_String_: - -.. _RealmList_maxDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum date. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _min: - -.. _min__: - -.. _RealmList_min: - -.. _RealmList_min__: - -.. _io_realm_RealmList_min: - -.. _io_realm_RealmList_min__: - - - -min ----- - -.. _io_realm_RealmList_min_java_lang_String_: - -.. _io_realm_RealmList_min_String_: - -.. _min_java_lang_String_: - -.. _min_String_: - -.. _RealmList_min_java_lang_String_: - -.. _RealmList_min_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a field. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _minDate: - -.. _minDate__: - -.. _RealmList_minDate: - -.. _RealmList_minDate__: - -.. _io_realm_RealmList_minDate: - -.. _io_realm_RealmList_minDate__: - - - -minDate -------- - -.. _io_realm_RealmList_minDate_java_lang_String_: - -.. _io_realm_RealmList_minDate_String_: - -.. _minDate_java_lang_String_: - -.. _minDate_String_: - -.. _RealmList_minDate_java_lang_String_: - -.. _RealmList_minDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum date. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _move: - -.. _move__: - -.. _RealmList_move: - -.. _RealmList_move__: - -.. _io_realm_RealmList_move: - -.. _io_realm_RealmList_move__: - - - -move ----- - -.. _io_realm_RealmList_move_int_int_: - -.. _io_realm_RealmList_move_int__int_: - -.. _move_int_int_: - -.. _move_int__int_: - -.. _RealmList_move_int_int_: - -.. _RealmList_move_int__int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`move ` ( - | **int** oldPos, - | **int** newPos - | ) - - - - - * - Moves an object from one position to another, while maintaining a fixed sized list. RealmObjects will be shifted so no ``null`` values are introduced. - - - - - - - **Parameters** - - - ``oldPos`` - index of RealmObject to move. - - - - - ``newPos`` - target position. If newPos < oldPos the object at the location will be shifted to the right. If oldPos < newPos, indexes > oldPos will be shifted once to the left. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - `java.lang.IndexOutOfBoundsException `__ - if any position is outside [0, size()]. - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _RealmList_remove: - -.. _RealmList_remove__: - -.. _io_realm_RealmList_remove: - -.. _io_realm_RealmList_remove__: - - - -remove ------- - -.. _io_realm_RealmList_remove_java_lang_Object_: - -.. _io_realm_RealmList_remove_Object_: - -.. _remove_java_lang_Object_: - -.. _remove_Object_: - -.. _RealmList_remove_java_lang_Object_: - -.. _RealmList_remove_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`remove ` ( - | `Object `__ object - | ) - - - - - * - Removes one instance of the specified object from this ``Collection`` if one is contained. This implementation iterates over this ``Collection`` and tests each element ``e`` returned by the iterator, whether ``e`` is equal to the given object. If ``object != null`` then this test is performed using ``object.equals(e)`` , otherwise using ``object == null`` . If an element equal to the given object is found, then the ``remove`` method is called on the iterator and ``true`` is returned, ``false`` otherwise. If the iterator does not support removing elements, an ``UnsupportedOperationException`` is thrown. - - - - - - - **Parameters** - - - ``object`` - the object to remove. - - - - - - - - **Returns** - - ``true`` if this ``Collection`` is modified, ``false`` otherwise. - - - - - - - **Throws** - - - `ClassCastException `__ - if the object passed is not of the correct type. - - - - - `NullPointerException `__ - if ``object`` is ``null`` . - - - - - - - - - - **Overrides** - - ``remove`` in class `AbstractCollection `__ - - - - -.. _io_realm_RealmList_remove_int_: - -.. _remove_int_: - -.. _RealmList_remove_int_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`remove ` ( - | **int** location - | ) - - - - - * - Removes the object at the specified location from this list. - - - - - **Parameters** - - - ``location`` - the index of the object to remove. - - - - - - - - **Returns** - - the removed object. - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - - - - - - - - - **Overrides** - - ``remove`` in class `AbstractList `__ - - - - - - -.. _removeAll: - -.. _removeAll__: - -.. _RealmList_removeAll: - -.. _RealmList_removeAll__: - -.. _io_realm_RealmList_removeAll: - -.. _io_realm_RealmList_removeAll__: - - - -removeAll ---------- - -.. _io_realm_RealmList_removeAll_java_util_Collection_: - -.. _io_realm_RealmList_removeAll_Collection_: - -.. _removeAll_java_util_Collection_: - -.. _removeAll_Collection_: - -.. _RealmList_removeAll_java_util_Collection_: - -.. _RealmList_removeAll_Collection_: - -.. _io_realm_RealmList_removeAll_Collection____: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`removeAll ` ( - | `java.util.Collection\ `__ collection - | ) - - - - - * - Removes all occurrences in this ``Collection`` of each object in the specified ``Collection`` . After this method returns none of the elements in the passed ``Collection`` can be found in this ``Collection`` anymore. - - This implementation iterates over the ``Collection`` and tests each element ``e`` returned by the iterator, whether it is contained in the specified ``Collection`` . If this test is positive, then the ``remove`` method is called on the iterator. - - - - - - - - - **Parameters** - - - ``collection`` - the collection of objects to remove. - - - - - - - - **Returns** - - ``true`` if this ``Collection`` is modified, ``false`` otherwise. - - - - - - - **Throws** - - - `ClassCastException `__ - if one or more elements of ``collection`` isn't of the correct type. - - - - - - - `NullPointerException `__ - if ``collection`` is ``null`` . - - - - - - - - - - **Overrides** - - ``removeAll`` in class `AbstractCollection `__ - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _RealmList_removeAllChangeListeners: - -.. _RealmList_removeAllChangeListeners__: - -.. _io_realm_RealmList_removeAllChangeListeners: - -.. _io_realm_RealmList_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _RealmList_removeChangeListener: - -.. _RealmList_removeChangeListener__: - -.. _io_realm_RealmList_removeChangeListener: - -.. _io_realm_RealmList_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_RealmList_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmList_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _RealmList_removeChangeListener_io_realm_RealmChangeListener_: - -.. _RealmList_removeChangeListener_RealmChangeListener_: - -.. _io_realm_RealmList_removeChangeListener_RealmChangeListener_RealmList_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - -.. _io_realm_RealmList_removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmList_removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _RealmList_removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _RealmList_removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmList_removeChangeListener_OrderedRealmCollectionChangeListener_RealmList_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _set: - -.. _set__: - -.. _RealmList_set: - -.. _RealmList_set__: - -.. _io_realm_RealmList_set: - -.. _io_realm_RealmList_set__: - - - -set ----- - -.. _io_realm_RealmList_set_int_E_: - -.. _io_realm_RealmList_set_int__E_: - -.. _set_int_E_: - -.. _set_int__E_: - -.. _RealmList_set_int_E_: - -.. _RealmList_set_int__E_: - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`set ` ( - | **int** location, - | **E** object - | ) - - - - - * - Replaces the element at the specified location in this list with the specified object. - - 1. **Unmanaged RealmLists**: It is possible to add both managed and unmanaged objects. If adding managed objects to an unmanaged RealmList they will not be copied to the Realm again if using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` afterwards. - - - - - #. **Managed RealmLists**: It is possible to add unmanaged objects to a RealmList that is already managed. In that case the object will transparently be copied to Realm using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` or :ref:`Realm.copyToRealmOrUpdate(RealmModel, ImportFlag...) ` if it has a primary key. - - - - - - - - - - - - **Parameters** - - - ``location`` - the index at which to put the specified object. - - - - - ``object`` - the object to add. - - - - - - - - **Returns** - - the previous element at the index. - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - `IndexOutOfBoundsException `__ - if ``location < 0 || location >= size()`` . - - - - - - - - - - **Overrides** - - ``set`` in class `AbstractList `__ - - - - - - -.. _size: - -.. _size__: - -.. _RealmList_size: - -.. _RealmList_size__: - -.. _io_realm_RealmList_size: - -.. _io_realm_RealmList_size__: - - - -size ----- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`size ` () - | - - - - - * - Returns the number of elements in this ``List`` . - - - - - - - - - **Returns** - - the number of elements in this ``List`` . - - - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - - - - **Overrides** - - ``size`` in class `AbstractCollection `__ - - - - - - -.. _sort: - -.. _sort__: - -.. _RealmList_sort: - -.. _RealmList_sort__: - -.. _io_realm_RealmList_sort: - -.. _io_realm_RealmList_sort__: - - - -sort ----- - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort____: - -.. _io_realm_RealmList_sort_java_lang_String__Sort____: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_Sort_: - -.. _io_realm_RealmList_sort_String__Sort_: - -.. _io_realm_RealmList_sort_String_Sort____: - -.. _io_realm_RealmList_sort_String__Sort____: - -.. _io_realm_RealmList_sort_String____io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_____io_realm_Sort_: - -.. _io_realm_RealmList_sort_String____Sort_: - -.. _io_realm_RealmList_sort_String_____Sort_: - -.. _io_realm_RealmList_sort_String____Sort____: - -.. _io_realm_RealmList_sort_String_____Sort____: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort____: - -.. _sort_java_lang_String__Sort____: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _sort_String_Sort____: - -.. _sort_String__Sort____: - -.. _sort_String____io_realm_Sort_: - -.. _sort_String_____io_realm_Sort_: - -.. _sort_String____Sort_: - -.. _sort_String_____Sort_: - -.. _sort_String____Sort____: - -.. _sort_String_____Sort____: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_Sort_: - -.. _RealmList_sort_java_lang_String__Sort_: - -.. _RealmList_sort_java_lang_String_Sort____: - -.. _RealmList_sort_java_lang_String__Sort____: - -.. _RealmList_sort_String_io_realm_Sort_: - -.. _RealmList_sort_String__io_realm_Sort_: - -.. _RealmList_sort_String_Sort_: - -.. _RealmList_sort_String__Sort_: - -.. _RealmList_sort_String_Sort____: - -.. _RealmList_sort_String__Sort____: - -.. _RealmList_sort_String____io_realm_Sort_: - -.. _RealmList_sort_String_____io_realm_Sort_: - -.. _RealmList_sort_String____Sort_: - -.. _RealmList_sort_String_____Sort_: - -.. _RealmList_sort_String____Sort____: - -.. _RealmList_sort_String_____Sort____: - -.. _io_realm_RealmList_sort_String[]__Sort[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - - - * - Sorts a collection based on the provided fields and sort orders. - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - - - - - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort__String__Sort_: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmList_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_Sort_String_Sort_: - -.. _io_realm_RealmList_sort_String__Sort__String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_String_Sort_: - -.. _sort_java_lang_String__Sort__String__Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_String_Sort_: - -.. _sort_String__io_realm_Sort__String__Sort_: - -.. _sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_Sort_java_lang_String_Sort_: - -.. _sort_String__Sort__java_lang_String__Sort_: - -.. _sort_String_Sort_String_io_realm_Sort_: - -.. _sort_String__Sort__String__io_realm_Sort_: - -.. _sort_String_Sort_String_Sort_: - -.. _sort_String__Sort__String__Sort_: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _RealmList_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _RealmList_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _RealmList_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_Sort_String_Sort_: - -.. _RealmList_sort_java_lang_String__Sort__String__Sort_: - -.. _RealmList_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmList_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmList_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmList_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmList_sort_String_io_realm_Sort_String_Sort_: - -.. _RealmList_sort_String__io_realm_Sort__String__Sort_: - -.. _RealmList_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_String_Sort_java_lang_String_Sort_: - -.. _RealmList_sort_String__Sort__java_lang_String__Sort_: - -.. _RealmList_sort_String_Sort_String_io_realm_Sort_: - -.. _RealmList_sort_String__Sort__String__io_realm_Sort_: - -.. _RealmList_sort_String_Sort_String_Sort_: - -.. _RealmList_sort_String__Sort__String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - - - * - Sorts a collection based on the provided fields and sort orders. - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - - - - - -.. _io_realm_RealmList_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String_Sort_: - -.. _io_realm_RealmList_sort_java_lang_String__Sort_: - -.. _io_realm_RealmList_sort_String_io_realm_Sort_: - -.. _io_realm_RealmList_sort_String__io_realm_Sort_: - -.. _io_realm_RealmList_sort_String_Sort_: - -.. _io_realm_RealmList_sort_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _RealmList_sort_java_lang_String_io_realm_Sort_: - -.. _RealmList_sort_java_lang_String__io_realm_Sort_: - -.. _RealmList_sort_java_lang_String_Sort_: - -.. _RealmList_sort_java_lang_String__Sort_: - -.. _RealmList_sort_String_io_realm_Sort_: - -.. _RealmList_sort_String__io_realm_Sort_: - -.. _RealmList_sort_String_Sort_: - -.. _RealmList_sort_String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - - - * - Sorts a collection based on the provided field and sort order. - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - - - - - -.. _io_realm_RealmList_sort_java_lang_String_: - -.. _io_realm_RealmList_sort_String_: - -.. _sort_java_lang_String_: - -.. _sort_String_: - -.. _RealmList_sort_java_lang_String_: - -.. _RealmList_sort_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName - | ) - - - - - * - Sorts a collection based on the provided field in ascending order. - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - - - - - - - -.. _sum: - -.. _sum__: - -.. _RealmList_sum: - -.. _RealmList_sum__: - -.. _io_realm_RealmList_sum: - -.. _io_realm_RealmList_sum__: - - - -sum ----- - -.. _io_realm_RealmList_sum_java_lang_String_: - -.. _io_realm_RealmList_sum_String_: - -.. _sum_java_lang_String_: - -.. _sum_String_: - -.. _RealmList_sum_java_lang_String_: - -.. _RealmList_sum_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName - | ) - - - - - * - Calculates the sum of a given field. - - - - - - - **Returns** - - the sum. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the sum, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _RealmList_toString: - -.. _RealmList_toString__: - -.. _io_realm_RealmList_toString: - -.. _io_realm_RealmList_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `AbstractCollection `__ - - - - - - -.. _where: - -.. _where__: - -.. _RealmList_where: - -.. _RealmList_where__: - -.. _io_realm_RealmList_where: - -.. _io_realm_RealmList_where__: - - - -where ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` () - | - - - - - * - Returns a RealmQuery, which can be used to query for specific objects of this class. - - - - - - - **Returns** - - a RealmQuery object. - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmQuery ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmMap.txt b/source/sdk/java/api/io/realm/RealmMap.txt deleted file mode 100644 index 7f2c4eac37..0000000000 --- a/source/sdk/java/api/io/realm/RealmMap.txt +++ /dev/null @@ -1,1505 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmMap -^^^^^^^^^^^^^^ - -.. _io_realm_RealmMap: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmMap - - -**Implemented interfaces:** - - - -- `java.util.Map `__ - - -RealmMap is used to map keys to values. A RealmMap cannot contain duplicate keys and each key can map to at most one value. A RealmMap cannot have ``null`` keys but can have ``null`` values. - -Similarly to :ref:`RealmList ` s, a RealmDictionary can operate in managed and unmanaged modes. In managed mode a RealmDictionary persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashMap `__ . - - - -Managed RealmDictionaries can only be created by Realm and will automatically update its content whenever the underlying Realm is updated. Managed RealmDictionaries can only be accessed using the getter that points to a RealmDictionary field of a :ref:`RealmObject ` . - - - -Unmanaged RealmDictionaries can be created by the user and can contain both managed and unmanaged RealmObjects. This is useful when dealing with JSON deserializers like GSON or other frameworks that inject values into a class. Unmanaged RealmMaps can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmMap ` . - - - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.MapChangeListener\ ` listener - | ) - - - Adds a change listener to this :ref:`RealmMap ` . - - - - - - - * - public **void** - - | :ref:`clear ` () - | - - - - - - - - * - public **boolean** - - | :ref:`containsKey ` ( - | `Object `__ key - | ) - - - - - - - - * - public **boolean** - - | :ref:`containsValue ` ( - | `Object `__ value - | ) - - - - - - - - * - public `Set `__ - - | :ref:`entrySet ` () - | - - - - - - - - * - public :ref:`RealmMap ` - - | :ref:`freeze ` () - | - - - - - - - - * - public **V** - - | :ref:`get ` ( - | `Object `__ key - | ) - - - - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isFrozen ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isManaged ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - - - - - - - - * - public `Set `__ - - | :ref:`keySet ` () - | - - - - - - - - * - public **V** - - | :ref:`put ` ( - | **K** key, - | **V** value - | ) - - - - - - - - * - public **void** - - | :ref:`putAll ` ( - | `java.util.Map\ `__ m - | ) - - - - - - - - * - public **V** - - | :ref:`remove ` ( - | `Object `__ key - | ) - - - - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.MapChangeListener\ ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **int** - - | :ref:`size ` () - | - - - - - - - - * - public `Collection `__ - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _RealmMap_addChangeListener: - -.. _RealmMap_addChangeListener__: - -.. _io_realm_RealmMap_addChangeListener: - -.. _io_realm_RealmMap_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_RealmMap_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmMap_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _RealmMap_addChangeListener_io_realm_RealmChangeListener_: - -.. _RealmMap_addChangeListener_RealmChangeListener_: - -.. _io_realm_RealmMap_addChangeListener_RealmChangeListener_RealmMap_K__V___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmMap ` . - - Registering a change listener will not prevent the underlying RealmMap from being garbage collected. If the RealmMap is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmMap dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new RealmChangeListener>() { - @Override - public void onChange(RealmMap map) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - -.. _io_realm_RealmMap_addChangeListener_io_realm_MapChangeListener_: - -.. _io_realm_RealmMap_addChangeListener_MapChangeListener_: - -.. _addChangeListener_io_realm_MapChangeListener_: - -.. _addChangeListener_MapChangeListener_: - -.. _RealmMap_addChangeListener_io_realm_MapChangeListener_: - -.. _RealmMap_addChangeListener_MapChangeListener_: - -.. _io_realm_RealmMap_addChangeListener_MapChangeListener_K__V__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.MapChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmMap ` . - - Registering a change listener will not prevent the underlying RealmMap from being garbage collected. If the RealmMap is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmMap dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new MapChangeListener() { - @Override - public void onChange(RealmMap map, MapChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - - - -.. _clear: - -.. _clear__: - -.. _RealmMap_clear: - -.. _RealmMap_clear__: - -.. _io_realm_RealmMap_clear: - -.. _io_realm_RealmMap_clear__: - - - -clear ------ - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`clear ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _containsKey: - -.. _containsKey__: - -.. _RealmMap_containsKey: - -.. _RealmMap_containsKey__: - -.. _io_realm_RealmMap_containsKey: - -.. _io_realm_RealmMap_containsKey__: - - - -containsKey ------------ - -.. _io_realm_RealmMap_containsKey_java_lang_Object_: - -.. _io_realm_RealmMap_containsKey_Object_: - -.. _containsKey_java_lang_Object_: - -.. _containsKey_Object_: - -.. _RealmMap_containsKey_java_lang_Object_: - -.. _RealmMap_containsKey_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`containsKey ` ( - | `Object `__ key - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _containsValue: - -.. _containsValue__: - -.. _RealmMap_containsValue: - -.. _RealmMap_containsValue__: - -.. _io_realm_RealmMap_containsValue: - -.. _io_realm_RealmMap_containsValue__: - - - -containsValue -------------- - -.. _io_realm_RealmMap_containsValue_java_lang_Object_: - -.. _io_realm_RealmMap_containsValue_Object_: - -.. _containsValue_java_lang_Object_: - -.. _containsValue_Object_: - -.. _RealmMap_containsValue_java_lang_Object_: - -.. _RealmMap_containsValue_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`containsValue ` ( - | `Object `__ value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _entrySet: - -.. _entrySet__: - -.. _RealmMap_entrySet: - -.. _RealmMap_entrySet__: - -.. _io_realm_RealmMap_entrySet: - -.. _io_realm_RealmMap_entrySet__: - - - -entrySet --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Set `__ :ref:`entrySet ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmMap_freeze: - -.. _RealmMap_freeze__: - -.. _io_realm_RealmMap_freeze: - -.. _io_realm_RealmMap_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmMap ` :ref:`freeze ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _get: - -.. _get__: - -.. _RealmMap_get: - -.. _RealmMap_get__: - -.. _io_realm_RealmMap_get: - -.. _io_realm_RealmMap_get__: - - - -get ----- - -.. _io_realm_RealmMap_get_java_lang_Object_: - -.. _io_realm_RealmMap_get_Object_: - -.. _get_java_lang_Object_: - -.. _get_Object_: - -.. _RealmMap_get_java_lang_Object_: - -.. _RealmMap_get_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **V** :ref:`get ` ( - | `Object `__ key - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _RealmMap_isEmpty: - -.. _RealmMap_isEmpty__: - -.. _io_realm_RealmMap_isEmpty: - -.. _io_realm_RealmMap_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _RealmMap_isFrozen: - -.. _RealmMap_isFrozen__: - -.. _io_realm_RealmMap_isFrozen: - -.. _io_realm_RealmMap_isFrozen__: - - - -isFrozen --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFrozen ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isManaged: - -.. _isManaged__: - -.. _RealmMap_isManaged: - -.. _RealmMap_isManaged__: - -.. _io_realm_RealmMap_isManaged: - -.. _io_realm_RealmMap_isManaged__: - - - -isManaged ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isManaged ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmMap_isValid: - -.. _RealmMap_isValid__: - -.. _io_realm_RealmMap_isValid: - -.. _io_realm_RealmMap_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _keySet: - -.. _keySet__: - -.. _RealmMap_keySet: - -.. _RealmMap_keySet__: - -.. _io_realm_RealmMap_keySet: - -.. _io_realm_RealmMap_keySet__: - - - -keySet ------- - -.. list-table:: - :header-rows: 1 - - * - | public `Set `__ :ref:`keySet ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _put: - -.. _put__: - -.. _RealmMap_put: - -.. _RealmMap_put__: - -.. _io_realm_RealmMap_put: - -.. _io_realm_RealmMap_put__: - - - -put ----- - -.. _io_realm_RealmMap_put_K_V_: - -.. _io_realm_RealmMap_put_K__V_: - -.. _put_K_V_: - -.. _put_K__V_: - -.. _RealmMap_put_K_V_: - -.. _RealmMap_put_K__V_: - -.. list-table:: - :header-rows: 1 - - * - | public **V** :ref:`put ` ( - | **K** key, - | **V** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _putAll: - -.. _putAll__: - -.. _RealmMap_putAll: - -.. _RealmMap_putAll__: - -.. _io_realm_RealmMap_putAll: - -.. _io_realm_RealmMap_putAll__: - - - -putAll ------- - -.. _io_realm_RealmMap_putAll_java_util_Map_: - -.. _io_realm_RealmMap_putAll_Map_: - -.. _io_realm_RealmMap_putAll_Map___extends_K____extends_V__: - -.. _putAll_java_util_Map_: - -.. _putAll_Map_: - -.. _putAll_Map___extends_K____extends_V__: - -.. _RealmMap_putAll_java_util_Map_: - -.. _RealmMap_putAll_Map_: - -.. _RealmMap_putAll_Map___extends_K____extends_V__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`putAll ` ( - | `java.util.Map\ `__ m - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _RealmMap_remove: - -.. _RealmMap_remove__: - -.. _io_realm_RealmMap_remove: - -.. _io_realm_RealmMap_remove__: - - - -remove ------- - -.. _io_realm_RealmMap_remove_java_lang_Object_: - -.. _io_realm_RealmMap_remove_Object_: - -.. _remove_java_lang_Object_: - -.. _remove_Object_: - -.. _RealmMap_remove_java_lang_Object_: - -.. _RealmMap_remove_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **V** :ref:`remove ` ( - | `Object `__ key - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _RealmMap_removeAllChangeListeners: - -.. _RealmMap_removeAllChangeListeners__: - -.. _io_realm_RealmMap_removeAllChangeListeners: - -.. _io_realm_RealmMap_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _RealmMap_removeChangeListener: - -.. _RealmMap_removeChangeListener__: - -.. _io_realm_RealmMap_removeChangeListener: - -.. _io_realm_RealmMap_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_RealmMap_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmMap_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _RealmMap_removeChangeListener_io_realm_RealmChangeListener_: - -.. _RealmMap_removeChangeListener_RealmChangeListener_: - -.. _io_realm_RealmMap_removeChangeListener_RealmChangeListener_RealmMap_K__V___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - -.. _io_realm_RealmMap_removeChangeListener_io_realm_MapChangeListener_: - -.. _io_realm_RealmMap_removeChangeListener_MapChangeListener_: - -.. _removeChangeListener_io_realm_MapChangeListener_: - -.. _removeChangeListener_MapChangeListener_: - -.. _RealmMap_removeChangeListener_io_realm_MapChangeListener_: - -.. _RealmMap_removeChangeListener_MapChangeListener_: - -.. _io_realm_RealmMap_removeChangeListener_MapChangeListener_K__V__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.MapChangeListener\ ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - - - -.. _size: - -.. _size__: - -.. _RealmMap_size: - -.. _RealmMap_size__: - -.. _io_realm_RealmMap_size: - -.. _io_realm_RealmMap_size__: - - - -size ----- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`size ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _RealmMap_values: - -.. _RealmMap_values__: - -.. _io_realm_RealmMap_values: - -.. _io_realm_RealmMap_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public `Collection `__ :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmMigration.txt b/source/sdk/java/api/io/realm/RealmMigration.txt deleted file mode 100644 index b96a4f08ee..0000000000 --- a/source/sdk/java/api/io/realm/RealmMigration.txt +++ /dev/null @@ -1,199 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmMigration -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmMigration: - - - -io.realm -======== - -The RealmMigration class is used to perform the migration of one Realm schema to another. The schema for a Realm is defined by all classes in a project that extend :ref:`io.realm.RealmObject ` or implement :ref:`io.realm.RealmModel ` , so any changes to these classes will require a migration. - -To support migrations from any previous schemaVersion to the newest, the following pattern is recommended when writing a migration: - - - -.. code-block:: java - - - public class CustomMigration implements RealmMigration { - @Override - public long migrate(DynamicRealm realm, long oldVersion, long newVersion) { - RealmSchema schema = realm.getSchema(); - - if (oldVersion == 0) { - // Migrate from v0 to v1 - oldVersion++; - } - - if (oldVersion == 1) { - // Migrate from v1 to v2 - oldVersion++; - } - - if (oldVersion < newVersion) { - throw new IllegalStateException(String.format(Locale.US, "Migration missing from v%d to v%d", oldVersion, newVersion)); - } - } - } - - - - - -During development when RealmObject classes can change frequently, it is possible to use :ref:`io.realm.Realm.deleteRealm(RealmConfiguration) ` . This will delete the database file and eliminate the need for any migrations. - - - - - - -.. seealso:: - - - - - :ref:`io.realm.RealmConfiguration.Builder.schemaVersion(long) ` - - - - - :ref:`io.realm.RealmConfiguration.Builder.migration(RealmMigration) ` - - - - - :ref:`io.realm.RealmConfiguration.Builder.deleteRealmIfMigrationNeeded() ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`migrate ` ( - | :ref:`DynamicRealm ` realm, - | **long** oldVersion, - | **long** newVersion - | ) - - - This method will be called if a migration is needed. - - - - - - - -Method Detail -============= - -.. _migrate: - -.. _migrate__: - -.. _RealmMigration_migrate: - -.. _RealmMigration_migrate__: - -.. _io_realm_RealmMigration_migrate: - -.. _io_realm_RealmMigration_migrate__: - - - -migrate -------- - -.. _io_realm_RealmMigration_migrate_io_realm_DynamicRealm_long_long_: - -.. _io_realm_RealmMigration_migrate_io_realm_DynamicRealm__long__long_: - -.. _io_realm_RealmMigration_migrate_DynamicRealm_long_long_: - -.. _io_realm_RealmMigration_migrate_DynamicRealm__long__long_: - -.. _migrate_io_realm_DynamicRealm_long_long_: - -.. _migrate_io_realm_DynamicRealm__long__long_: - -.. _migrate_DynamicRealm_long_long_: - -.. _migrate_DynamicRealm__long__long_: - -.. _RealmMigration_migrate_io_realm_DynamicRealm_long_long_: - -.. _RealmMigration_migrate_io_realm_DynamicRealm__long__long_: - -.. _RealmMigration_migrate_DynamicRealm_long_long_: - -.. _RealmMigration_migrate_DynamicRealm__long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`migrate ` ( - | :ref:`DynamicRealm ` realm, - | **long** oldVersion, - | **long** newVersion - | ) - - - - - * - This method will be called if a migration is needed. The entire method is wrapped in a write transaction so it is possible to create, update or delete any existing objects without wrapping it in your own transaction. - - - - - **Parameters** - - - ``realm`` - the Realm schema on which to perform the migration. - - - - - ``oldVersion`` - the schema version of the Realm at the start of the migration. - - - - - ``newVersion`` - the schema version of the Realm after executing the migration. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmModel.txt b/source/sdk/java/api/io/realm/RealmModel.txt deleted file mode 100644 index 756dc6aacf..0000000000 --- a/source/sdk/java/api/io/realm/RealmModel.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmModel -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmModel: - - - -io.realm -======== - -Interface for marking classes as RealmObjects, it can be used instead of extending :ref:`RealmObject ` . - -All helper methods available to classes that extend RealmObject are instead available as static methods: - - - -.. code-block:: java - - - Person p = realm.createObject(Person.class); - - // With the RealmModel interface - RealmObject.isValid(p); - - // With the RealmObject base class - p.isValid(); - - - - - -Note: Object implementing this interface needs also to be annotated with :ref:`RealmClass ` , so the annotation processor can generate the underlining proxy class. - - - - - - -.. seealso:: - - - - - :ref:`RealmObject ` - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmObject.txt b/source/sdk/java/api/io/realm/RealmObject.txt deleted file mode 100644 index 1a883450a0..0000000000 --- a/source/sdk/java/api/io/realm/RealmObject.txt +++ /dev/null @@ -1,2981 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmObject -^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmObject: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmObject - - -**Implemented interfaces:** - - - -- :ref:`io.realm.RealmModel ` - - -In Realm you define your RealmObject classes by sub-classing RealmObject and adding fields to be persisted. You then create your objects within a Realm, and use your custom subclasses instead of using the RealmObject class directly.An annotation processor will create a proxy class for your RealmObject subclass. - -The following field data types are supported: - - - -- boolean/Boolean - - -- short/Short - - -- int/Integer - - -- long/Long - - -- float/Float - - -- double/Double - - -- byte[] - - -- String - - -- Date - - -- UUID - - -- org.bson.types.Decimal128 - - -- org.bson.types.ObjectId - - -- Any RealmObject subclass - - -- RealmList - - -- RealmDictionary - - - - -The types ``short`` , ``int`` , and ``long`` are mapped to ``long`` when storing within a Realm. - -The only restriction a RealmObject has is that fields are not allowed to be final or volatile. Any method as well as public fields are allowed. When providing custom constructors, a public constructor with no arguments must be declared. - -Fields annotated with :ref:`io.realm.annotations.Ignore ` don't have these restrictions and don't require either a getter or setter. - - - -Realm will create indexes for fields annotated with :ref:`io.realm.annotations.Index ` . This will speedup queries but will have a negative impact on inserts and updates. - - - -A RealmObject cannot be passed between different threads. - - - - -.. seealso:: - - - - - :ref:`Realm.createObject(Class) ` - - - - - :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmObject ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static **void** - - | :ref:`addChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Adds a change listener to a RealmObject that will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed. - - - - - * - public static **void** - - | :ref:`addChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - Adds a change listener to a RealmObject to get detailed information about the changes. - - - - - * - public final **void** - - | :ref:`addChangeListener ` <**E** >( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Adds a change listener to this RealmObject that will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed. - - - - - * - public final **void** - - | :ref:`addChangeListener ` <**E** >( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - Adds a change listener to this RealmObject to get detailed information about changes. - - - - - * - public static **** - - | :ref:`asChangesetObservable ` <**E** >( - | **E** object - | ) - - - Returns an Rx Observable that monitors changes to this RealmObject. - - - - - * - public final **** - - | :ref:`asChangesetObservable ` <**E** >() - | - - - Returns an Rx Observable that monitors changes to this RealmObject. - - - - - * - public static **** - - | :ref:`asFlowable ` <**E** >( - | **E** object - | ) - - - Returns an RxJava Flowable that monitors changes to this RealmObject. - - - - - * - public final **** - - | :ref:`asFlowable ` <**E** >() - | - - - Returns an RxJava Flowable that monitors changes to this RealmObject. - - - - - * - public static **void** - - | :ref:`deleteFromRealm ` <**E** >( - | **E** object - | ) - - - Deletes the object from the Realm it is currently associated with. - - - - - * - public final **void** - - | :ref:`deleteFromRealm ` () - | - - - Deletes the object from the Realm it is currently associated to. - - - - - * - public static **E** - - | :ref:`freeze ` <**E** >( - | **E** object - | ) - - - Returns a frozen snapshot of this object. - - - - - * - public final **E** - - | :ref:`freeze ` <**E** >() - | - - - Returns a frozen snapshot of this object. - - - - - * - public static :ref:`Realm ` - - | :ref:`getRealm ` ( - | :ref:`RealmModel ` model - | ) - - - returns :ref:`Realm ` instance where the ``model`` belongs. - - - - - - - * - public :ref:`Realm ` - - | :ref:`getRealm ` () - | - - - Returns :ref:`Realm ` instance where this :ref:`RealmObject ` belongs. - - - - - - - * - public static **boolean** - - | :ref:`isFrozen ` <**E** >( - | **E** object - | ) - - - Returns whether or not this RealmObject is frozen. - - - - - * - public final **boolean** - - | :ref:`isFrozen ` () - | - - - Returns whether or not this RealmObject is frozen. - - - - - * - public static **boolean** - - | :ref:`isLoaded ` <**E** >( - | **E** object - | ) - - - Checks if the query used to find this RealmObject has completed. - - - - - * - public final **boolean** - - | :ref:`isLoaded ` () - | - - - Checks if the query used to find this RealmObject has completed. - - - - - * - public static **boolean** - - | :ref:`isManaged ` <**E** >( - | **E** object - | ) - - - Checks if this object is managed by Realm. - - - - - * - public **boolean** - - | :ref:`isManaged ` () - | - - - Checks if this object is managed by Realm. - - - - - * - public static **boolean** - - | :ref:`isValid ` <**E** >( - | **E** object - | ) - - - Checks if the RealmObject is still valid to use i.e., the RealmObject hasn't been deleted nor has the :ref:`io.realm.Realm ` been closed. - - - - - - - * - public final **boolean** - - | :ref:`isValid ` () - | - - - Checks if the RealmObject is still valid to use i.e., the RealmObject hasn't been deleted nor has the :ref:`io.realm.Realm ` been closed. - - - - - - - * - public static **boolean** - - | :ref:`load ` <**E** >( - | **E** object - | ) - - - Makes an asynchronous query blocking. - - - - - * - public final **boolean** - - | :ref:`load ` () - | - - - Makes an asynchronous query blocking. - - - - - * - public static **void** - - | :ref:`removeAllChangeListeners ` <**E** >( - | **E** object - | ) - - - Removes all registered listeners from the given RealmObject. - - - - - * - public final **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all registered listeners. - - - - - * - public static **void** - - | :ref:`removeChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - Removes a previously registered listener on the given RealmObject. - - - - - * - public static **void** - - | :ref:`removeChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmObjectChangeListener ` listener - | ) - - - Removes a previously registered listener on the given RealmObject. - - - - - * - public final **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener ` listener - | ) - - - Removes a previously registered listener. - - - - - * - public final **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener ` listener - | ) - - - Removes a previously registered listener. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmObject: - -.. _RealmObject__: - -.. _io_realm_RealmObject: - -.. _io_realm_RealmObject__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmObject ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _RealmObject_addChangeListener: - -.. _RealmObject_addChangeListener__: - -.. _io_realm_RealmObject_addChangeListener: - -.. _io_realm_RealmObject_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_RealmObject_addChangeListener_E_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel__RealmChangeListener_: - -.. _addChangeListener_E_io_realm_RealmChangeListener_: - -.. _addChangeListener_E__io_realm_RealmChangeListener_: - -.. _addChangeListener_E_RealmChangeListener_: - -.. _addChangeListener_E__RealmChangeListener_: - -.. _addChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmModel_RealmChangeListener_: - -.. _addChangeListener_RealmModel__RealmChangeListener_: - -.. _RealmObject_addChangeListener_E_io_realm_RealmChangeListener_: - -.. _RealmObject_addChangeListener_E__io_realm_RealmChangeListener_: - -.. _RealmObject_addChangeListener_E_RealmChangeListener_: - -.. _RealmObject_addChangeListener_E__RealmChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel_RealmChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel__RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__RealmChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`addChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to a RealmObject that will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed.Registering a change listener will not prevent the underlying RealmObject from being garbage collected. If the RealmObject is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private Person person; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - person = realm.where(Person.class).findFirst(); - person.addChangeListener(new RealmChangeListener() { - @Override - public void onChange(Person person) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``object`` - RealmObject to add listener to. - - - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - - - - - - `IllegalStateException `__ - if you try to add a listener inside a transaction. - - - - - - - - - - -.. _io_realm_RealmObject_addChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmModel__RealmObjectChangeListener_: - -.. _addChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_E_RealmObjectChangeListener_: - -.. _addChangeListener_E__RealmObjectChangeListener_: - -.. _addChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _addChangeListener_RealmModel__RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_E_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_E__RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_RealmModel__RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_E__RealmObjectChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`addChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to a RealmObject to get detailed information about the changes. The listener will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed.Registering a change listener will not prevent the underlying RealmObject from being garbage collected. If the RealmObject is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private Person person; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - person = realm.where(Person.class).findFirst(); - person.addChangeListener(new RealmObjectChangeListener() { - @Override - public void onChange(Person person, ObjectChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``object`` - RealmObject to add listener to. - - - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``object`` is ``null`` or an unmanaged object, or the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - - - - - - `IllegalStateException `__ - if you try to add a listener inside a transaction. - - - - - - - - - - -.. _io_realm_RealmObject_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _RealmObject_addChangeListener_io_realm_RealmChangeListener_: - -.. _RealmObject_addChangeListener_RealmChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`addChangeListener ` <**E** >( - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to this RealmObject that will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed.Registering a change listener will not prevent the underlying RealmObject from being garbage collected. If the RealmObject is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private Person person; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - person = realm.where(Person.class).findFirst(); - person.addChangeListener(new RealmChangeListener() { - @Override - public void onChange(Person person) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - - - - - - `IllegalStateException `__ - if you try to add a listener inside a transaction. - - - - - - - - - - -.. _io_realm_RealmObject_addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmObjectChangeListener_: - -.. _addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _addChangeListener_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_addChangeListener_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_addChangeListener_RealmObjectChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`addChangeListener ` <**E** >( - | :ref:`io.realm.RealmObjectChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to this RealmObject to get detailed information about changes. The listener will be triggered if any value field or referenced RealmObject field is changed, or the RealmList field itself is changed.Registering a change listener will not prevent the underlying RealmObject from being garbage collected. If the RealmObject is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private Person person; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - person = realm.where(Person.class).findFirst(); - person.addChangeListener(new RealmObjectChangeListener() { - @Override - public void onChange(Person person, ObjectChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or **IntentService** thread. - - - - - - - `IllegalStateException `__ - if you try to add a listener inside a transaction. - - - - - - - - - - - - -.. _asChangesetObservable: - -.. _asChangesetObservable__: - -.. _RealmObject_asChangesetObservable: - -.. _RealmObject_asChangesetObservable__: - -.. _io_realm_RealmObject_asChangesetObservable: - -.. _io_realm_RealmObject_asChangesetObservable__: - - - -asChangesetObservable ---------------------- - -.. _io_realm_RealmObject_asChangesetObservable_E_: - -.. _io_realm_RealmObject_asChangesetObservable_RealmModel_: - -.. _asChangesetObservable_E_: - -.. _asChangesetObservable_RealmModel_: - -.. _RealmObject_asChangesetObservable_E_: - -.. _RealmObject_asChangesetObservable_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **** :ref:`asChangesetObservable ` <**E** >( - | **E** object - | ) - - - - - * - Returns an Rx Observable that monitors changes to this RealmObject. It will emit the current RealmObject when subscribed to. For each update to the RealmObject a pair consisting of the RealmObject and the :ref:`ObjectChangeSet ` will be sent. The changeset will be ``null`` the first time the RealmObject is emitted. - - The RealmObject will continually be emitted as it is updated - ``onComplete`` will never be called. - - - - Items emitted from Realm Observables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Observables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - obj.asChangesetObservable() - .observeOn(Schedulers.computation()) - .map((rxObj, changes) -> doExpensiveWork(rxObj, changeså)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - - - - - - **Parameters** - - - ``object`` - RealmObject class that is being observed. Must be this class or its super types. - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **** :ref:`asChangesetObservable ` <**E** >() - | - - - - - * - Returns an Rx Observable that monitors changes to this RealmObject. It will emit the current RealmObject when subscribed to. For each update to the RealmObject a pair consisting of the RealmObject and the :ref:`ObjectChangeSet ` will be sent. The changeset will be ``null`` the first time the RealmObject is emitted. - - The RealmObject will continually be emitted as it is updated - ``onComplete`` will never be called. - - - - Items emitted from Realm Observables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Observables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - obj.asChangesetObservable() - .observeOn(Schedulers.computation()) - .map((rxObj, changes) -> doExpensiveWork(rxObj, changeså)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _asFlowable: - -.. _asFlowable__: - -.. _RealmObject_asFlowable: - -.. _RealmObject_asFlowable__: - -.. _io_realm_RealmObject_asFlowable: - -.. _io_realm_RealmObject_asFlowable__: - - - -asFlowable ----------- - -.. _io_realm_RealmObject_asFlowable_E_: - -.. _io_realm_RealmObject_asFlowable_RealmModel_: - -.. _asFlowable_E_: - -.. _asFlowable_RealmModel_: - -.. _RealmObject_asFlowable_E_: - -.. _RealmObject_asFlowable_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **** :ref:`asFlowable ` <**E** >( - | **E** object - | ) - - - - - * - Returns an RxJava Flowable that monitors changes to this RealmObject. It will emit the current object when subscribed to. Object updates will continuously be emitted as the RealmObject is updated - ``onComplete`` will never be called. - - When chaining a RealmObject observable use ``obj.asFlowable()`` to pass on type information, otherwise the type of the following observables will be ``RealmObject`` . - - - - Items emitted from Realm Flowables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - obj.asFlowable() - .observeOn(Schedulers.computation()) - .map((rxObj) -> doExpensiveWork(rxObj)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items you can instruct RxJava to emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - obj.asFlowable() - .filter(obj -> obj.isLoaded()) - .first() - .subscribe( ... ) // You only get the object once - - - - - - - - - - - **Parameters** - - - ``object`` - RealmObject class that is being observed. Must be this class or its super types. - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **** :ref:`asFlowable ` <**E** >() - | - - - - - * - Returns an RxJava Flowable that monitors changes to this RealmObject. It will emit the current object when subscribed to. Object updates will continually be emitted as the RealmObject is updated - ``onComplete`` will never be called. - - When chaining a RealmObject flowable use ``obj.asFlowable()`` to pass on type information, otherwise the type of the following observables will be ``RealmObject`` . - - - - Items emitted from Realm Flowables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - obj.asFlowable() - .observeOn(Schedulers.computation()) - .map((rxObj) -> doExpensiveWork(rxObj)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items you can instruct RxJava to only emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - obj.asFlowable() - .filter(obj -> obj.isLoaded()) - .first() - .subscribe( ... ) // You only get the object once - - - - - - - - - **Type Parameters** - - - ``E`` - RealmObject class that is being observed. Must be this class or its super types. - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _deleteFromRealm: - -.. _deleteFromRealm__: - -.. _RealmObject_deleteFromRealm: - -.. _RealmObject_deleteFromRealm__: - -.. _io_realm_RealmObject_deleteFromRealm: - -.. _io_realm_RealmObject_deleteFromRealm__: - - - -deleteFromRealm ---------------- - -.. _io_realm_RealmObject_deleteFromRealm_E_: - -.. _io_realm_RealmObject_deleteFromRealm_RealmModel_: - -.. _deleteFromRealm_E_: - -.. _deleteFromRealm_RealmModel_: - -.. _RealmObject_deleteFromRealm_E_: - -.. _RealmObject_deleteFromRealm_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`deleteFromRealm ` <**E** >( - | **E** object - | ) - - - - - * - Deletes the object from the Realm it is currently associated with.After this method is called the object will be invalid and any operation (read or write) performed on it will fail with an IllegalStateException. - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`isValid() ` - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`deleteFromRealm ` () - | - - - - - * - Deletes the object from the Realm it is currently associated to.After this method is called the object will be invalid and any operation (read or write) performed on it will fail with an IllegalStateException. - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the corresponding Realm is closed or in an incorrect thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`isValid() ` - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmObject_freeze: - -.. _RealmObject_freeze__: - -.. _io_realm_RealmObject_freeze: - -.. _io_realm_RealmObject_freeze__: - - - -freeze ------- - -.. _io_realm_RealmObject_freeze_E_: - -.. _io_realm_RealmObject_freeze_RealmModel_: - -.. _freeze_E_: - -.. _freeze_RealmModel_: - -.. _RealmObject_freeze_E_: - -.. _RealmObject_freeze_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **E** :ref:`freeze ` <**E** >( - | **E** object - | ) - - - - - * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a RealmObject also creates a frozen Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and object will be closed as well. - - Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of frozen objects with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - - - - - - - **Returns** - - a frozen copy of this object. - - - - - **Throws** - - - `IllegalStateException `__ - if this method is called from inside a write transaction. - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **E** :ref:`freeze ` <**E** >() - | - - - - - * - Returns a frozen snapshot of this object. The frozen copy can be read and queried from any thread without throwing an `IllegalStateException `__ . - - Freezing a RealmObject also creates a frozen Realm which has its own lifecycle, but if the live Realm that spawned the original collection is fully closed (i.e. all instances across all threads are closed), the frozen Realm and object will be closed as well. - - Frozen objects can be queried as normal, but trying to mutate it in any way or attempting to register a listener will throw an `IllegalStateException `__ . - - - - Note: Keeping a large number of frozen objects with different versions alive can have a negative impact on the filesize of the Realm. In order to avoid such a situation it is possible to set :ref:`RealmConfiguration.Builder.maxNumberOfActiveVersions(long) ` . - - - - - - - - - - - **Returns** - - a frozen copy of this object. - - - - - **Throws** - - - `IllegalStateException `__ - if this method is called from inside a write transaction. - - - - - - - - - - - - -.. _getRealm: - -.. _getRealm__: - -.. _RealmObject_getRealm: - -.. _RealmObject_getRealm__: - -.. _io_realm_RealmObject_getRealm: - -.. _io_realm_RealmObject_getRealm__: - - - -getRealm --------- - -.. _io_realm_RealmObject_getRealm_io_realm_RealmModel_: - -.. _io_realm_RealmObject_getRealm_RealmModel_: - -.. _getRealm_io_realm_RealmModel_: - -.. _getRealm_RealmModel_: - -.. _RealmObject_getRealm_io_realm_RealmModel_: - -.. _RealmObject_getRealm_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Realm ` :ref:`getRealm ` ( - | :ref:`RealmModel ` model - | ) - - - - - * - returns :ref:`Realm ` instance where the ``model`` belongs. - - You **must not** call **Realm.close()** against returned instance. - - - - - - - - - **Parameters** - - - ``model`` - an :ref:`RealmModel ` instance other than :ref:`DynamicRealmObject ` . - - - - - - - - - - **Returns** - - :ref:`Realm ` instance where the ``model`` belongs or ``null`` if the ``model`` is unmanaged. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``model`` is ``null`` . - - - - - - - `IllegalStateException `__ - if the ``model`` is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Realm ` :ref:`getRealm ` () - | - - - - - * - Returns :ref:`Realm ` instance where this :ref:`RealmObject ` belongs. - - You **must not** call **Realm.close()** against returned instance. - - - - - - - - - - - **Returns** - - :ref:`Realm ` instance where this object belongs to or ``null`` if this object is unmanaged. - - - - - - - **Throws** - - - `IllegalStateException `__ - if this object is an instance of :ref:`DynamicRealmObject ` or this object was already deleted or the corresponding :ref:`Realm ` was already closed. - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _RealmObject_isFrozen: - -.. _RealmObject_isFrozen__: - -.. _io_realm_RealmObject_isFrozen: - -.. _io_realm_RealmObject_isFrozen__: - - - -isFrozen --------- - -.. _io_realm_RealmObject_isFrozen_E_: - -.. _io_realm_RealmObject_isFrozen_RealmModel_: - -.. _isFrozen_E_: - -.. _isFrozen_RealmModel_: - -.. _RealmObject_isFrozen_E_: - -.. _RealmObject_isFrozen_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`isFrozen ` <**E** >( - | **E** object - | ) - - - - - * - Returns whether or not this RealmObject is frozen. - - - - - - - **Returns** - - ``true`` if the RealmObject is frozen, ``false`` if it is not. - - - - - - - - - - - .. seealso:: - - - - - :ref:`freeze() ` - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`isFrozen ` () - | - - - - - * - Returns whether or not this RealmObject is frozen. - - - - - - - **Returns** - - ``true`` if the RealmObject is frozen, ``false`` if it is not. - - - - - - - - - - - .. seealso:: - - - - - :ref:`freeze() ` - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _RealmObject_isLoaded: - -.. _RealmObject_isLoaded__: - -.. _io_realm_RealmObject_isLoaded: - -.. _io_realm_RealmObject_isLoaded__: - - - -isLoaded --------- - -.. _io_realm_RealmObject_isLoaded_E_: - -.. _io_realm_RealmObject_isLoaded_RealmModel_: - -.. _isLoaded_E_: - -.. _isLoaded_RealmModel_: - -.. _RealmObject_isLoaded_E_: - -.. _RealmObject_isLoaded_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`isLoaded ` <**E** >( - | **E** object - | ) - - - - - * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return an :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. - - - - Once ``isLoaded()`` returns ``true`` , the object represents the query result even if the query didn't find any object matching the query parameters. In this case the :ref:`RealmObject ` will become a "null" object. - - - - "Null" objects represents ``null`` . An exception is throw if any accessor is called, so it is important to also check :ref:`isValid() ` before calling any methods. A common pattern is: - - - - - - .. code-block:: java - - - Person person = realm.where(Person.class).findFirstAsync(); - RealmObject.isLoaded(person); // == false - RealmObject.addChangeListener(person, new RealmChangeListener() { - @Override - public void onChange(Person person) { - RealmObject.isLoaded(person); // always true here - if (RealmObject.isValid(person)) { - // It is safe to access the person. - } - } - }); - - - - - - Synchronous RealmObjects are by definition blocking hence this method will always return ``true`` for them. This method will return ``true`` if called on an unmanaged object (created outside of Realm). - - - - - - - - - **Parameters** - - - ``object`` - RealmObject to check. - - - - - - - - **Returns** - - ``true`` if the query has completed, ``false`` if the query is in progress. - - - - - - - - - - - .. seealso:: - - - - - :ref:`isValid(RealmModel) ` - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`isLoaded ` () - | - - - - - * - Checks if the query used to find this RealmObject has completed.Async methods like :ref:`RealmQuery.findFirstAsync() ` return a :ref:`RealmObject ` that represents the future result of the :ref:`RealmQuery ` . It can be considered similar to a `java.util.concurrent.Future `__ in this regard. - - - - Once ``isLoaded()`` returns ``true`` , the object represents the query result even if the query didn't find any object matching the query parameters. In this case the :ref:`RealmObject ` will become a "null" object. - - - - "Null" objects represents ``null`` . An exception is throw if any accessor is called, so it is important to also check :ref:`isValid() ` before calling any methods. A common pattern is: - - - - - - .. code-block:: java - - - Person person = realm.where(Person.class).findFirstAsync(); - person.isLoaded(); // == false - person.addChangeListener(new RealmChangeListener() { - @Override - public void onChange(Person person) { - person.isLoaded(); // Always true here - if (person.isValid()) { - // It is safe to access the person. - } - } - }); - - - - - - Synchronous RealmObjects are by definition blocking hence this method will always return ``true`` for them. This method will return ``true`` if called on an unmanaged object (created outside of Realm). - - - - - - - - - - - **Returns** - - ``true`` if the query has completed, ``false`` if the query is in progress. - - - - - - - - - - - .. seealso:: - - - - - :ref:`isValid() ` - - - - - - - - - - - - -.. _isManaged: - -.. _isManaged__: - -.. _RealmObject_isManaged: - -.. _RealmObject_isManaged__: - -.. _io_realm_RealmObject_isManaged: - -.. _io_realm_RealmObject_isManaged__: - - - -isManaged ---------- - -.. _io_realm_RealmObject_isManaged_E_: - -.. _io_realm_RealmObject_isManaged_RealmModel_: - -.. _isManaged_E_: - -.. _isManaged_RealmModel_: - -.. _RealmObject_isManaged_E_: - -.. _RealmObject_isManaged_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`isManaged ` <**E** >( - | **E** object - | ) - - - - - * - Checks if this object is managed by Realm. A managed object is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed object will be live-updated so it always points to the latest data. It is possible to register a change listener using :ref:`addChangeListener(RealmModel, RealmChangeListener) ` to be notified when changes happen. Managed objects are thread confined so that they cannot be accessed from other threads than the one that created them. - - If this method returns ``false`` , the object is unmanaged. An unmanaged object is just a normal Java object, so it can be parsed freely across threads, but the data in the object is not connected to the underlying Realm, so it will not be live updated. - - - - It is possible to create a managed object from an unmanaged object by using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` . An unmanaged object can be created from a managed object by using :ref:`Realm.copyFromRealm(RealmModel) ` . - - - - - - - - - - - **Returns** - - ``true`` if the object is managed, ``false`` if it is unmanaged. - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isManaged ` () - | - - - - - * - Checks if this object is managed by Realm. A managed object is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed object will be live-updated so it always points to the latest data. It is possible to register a change listener using :ref:`addChangeListener(RealmChangeListener) ` to be notified when changes happen. Managed objects are thread confined so that they cannot be accessed from other threads than the one that created them. - - If this method returns ``false`` , the object is unmanaged. An unmanaged object is just a normal Java object, so it can be parsed freely across threads, but the data in the object is not connected to the underlying Realm, so it will not be live updated. - - - - It is possible to create a managed object from an unmanaged object by using :ref:`Realm.copyToRealm(RealmModel, ImportFlag...) ` . An unmanaged object can be created from a managed object by using :ref:`Realm.copyFromRealm(RealmModel) ` . - - - - - - - - - - - **Returns** - - ``true`` if the object is managed, ``false`` if it is unmanaged. - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmObject_isValid: - -.. _RealmObject_isValid__: - -.. _io_realm_RealmObject_isValid: - -.. _io_realm_RealmObject_isValid__: - - - -isValid -------- - -.. _io_realm_RealmObject_isValid_E_: - -.. _io_realm_RealmObject_isValid_RealmModel_: - -.. _isValid_E_: - -.. _isValid_RealmModel_: - -.. _RealmObject_isValid_E_: - -.. _RealmObject_isValid_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`isValid ` <**E** >( - | **E** object - | ) - - - - - * - Checks if the RealmObject is still valid to use i.e., the RealmObject hasn't been deleted nor has the :ref:`io.realm.Realm ` been closed. It will always return ``true`` for unmanaged objects. - - - - - - - **Parameters** - - - ``object`` - RealmObject to check validity for. - - - - - - - - **Returns** - - ``true`` if the object is still accessible or an unmanaged object, ``false`` otherwise. - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`isValid ` () - | - - - - - * - Checks if the RealmObject is still valid to use i.e., the RealmObject hasn't been deleted nor has the :ref:`io.realm.Realm ` been closed. It will always return ``true`` for unmanaged objects. - - Note that this can be used to check the validity of certain conditions such as being ``null`` when observed. - - - - - - .. code-block:: java - - - realm.where(BannerRealm.class).equalTo("type", type).findFirstAsync().asFlowable() - .filter(result.isLoaded() && result.isValid()) - .first() - - - - - - - - - - - - - **Returns** - - ``true`` if the object is still accessible or an unmanaged object, ``false`` otherwise. - - - - - - - - - - - .. seealso:: - - - - - `Examples using Realm with RxJava `__ - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _RealmObject_load: - -.. _RealmObject_load__: - -.. _io_realm_RealmObject_load: - -.. _io_realm_RealmObject_load__: - - - -load ----- - -.. _io_realm_RealmObject_load_E_: - -.. _io_realm_RealmObject_load_RealmModel_: - -.. _load_E_: - -.. _load_RealmModel_: - -.. _RealmObject_load_E_: - -.. _RealmObject_load_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`load ` <**E** >( - | **E** object - | ) - - - - - * - Makes an asynchronous query blocking. This will also trigger any registered listeners.Note: This will return ``true`` if called for an unmanaged object (created outside of Realm). - - - - - - - - - **Parameters** - - - ``object`` - RealmObject to force load. - - - - - - - - **Returns** - - ``true`` if it successfully completed the query, ``false`` otherwise. - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **boolean** :ref:`load ` () - | - - - - - * - Makes an asynchronous query blocking. This will also trigger any registered listeners.Note: This will return ``true`` if called for an unmanaged object (created outside of Realm). - - - - - - - - - - - **Returns** - - ``true`` if it successfully completed the query, ``false`` otherwise. - - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _RealmObject_removeAllChangeListeners: - -.. _RealmObject_removeAllChangeListeners__: - -.. _io_realm_RealmObject_removeAllChangeListeners: - -.. _io_realm_RealmObject_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. _io_realm_RealmObject_removeAllChangeListeners_E_: - -.. _io_realm_RealmObject_removeAllChangeListeners_RealmModel_: - -.. _removeAllChangeListeners_E_: - -.. _removeAllChangeListeners_RealmModel_: - -.. _RealmObject_removeAllChangeListeners_E_: - -.. _RealmObject_removeAllChangeListeners_RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`removeAllChangeListeners ` <**E** >( - | **E** object - | ) - - - - - * - Removes all registered listeners from the given RealmObject. - - - - - **Parameters** - - - ``object`` - RealmObject to remove all listeners from. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if object is ``null`` or isn't managed by Realm. - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all registered listeners. - - - - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _RealmObject_removeChangeListener: - -.. _RealmObject_removeChangeListener__: - -.. _io_realm_RealmObject_removeChangeListener: - -.. _io_realm_RealmObject_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_RealmObject_removeChangeListener_E_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E__io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E__RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel__RealmChangeListener_: - -.. _removeChangeListener_E_io_realm_RealmChangeListener_: - -.. _removeChangeListener_E__io_realm_RealmChangeListener_: - -.. _removeChangeListener_E_RealmChangeListener_: - -.. _removeChangeListener_E__RealmChangeListener_: - -.. _removeChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmModel_RealmChangeListener_: - -.. _removeChangeListener_RealmModel__RealmChangeListener_: - -.. _RealmObject_removeChangeListener_E_io_realm_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_E__io_realm_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_E_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_E__RealmChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel_io_realm_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel__io_realm_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel__RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E__RealmChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`removeChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmChangeListener\ ` listener - | ) - - - - - * - Removes a previously registered listener on the given RealmObject. - - - - - **Parameters** - - - ``object`` - RealmObject to remove listener from. - - - - - ``listener`` - the instance to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . - - - - - - - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - -.. _io_realm_RealmObject_removeChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_E__RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmModel__RealmObjectChangeListener_: - -.. _removeChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_E_RealmObjectChangeListener_: - -.. _removeChangeListener_E__RealmObjectChangeListener_: - -.. _removeChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _removeChangeListener_RealmModel__RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_E_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_E__io_realm_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_E_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_E__RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel__io_realm_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_RealmModel__RealmObjectChangeListener_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`removeChangeListener ` <**E** >( - | **E** object, - | :ref:`io.realm.RealmObjectChangeListener ` listener - | ) - - - - - * - Removes a previously registered listener on the given RealmObject. - - - - - **Parameters** - - - ``object`` - RealmObject to remove listener from. - - - - - ``listener`` - the instance to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the ``object`` or the change listener is ``null`` . - - - - - - - `IllegalArgumentException `__ - if object is an unmanaged RealmObject. - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - -.. _io_realm_RealmObject_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_io_realm_RealmChangeListener_: - -.. _RealmObject_removeChangeListener_RealmChangeListener_: - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener ` listener - | ) - - - - - * - Removes a previously registered listener. - - - - - **Parameters** - - - ``listener`` - the instance to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - -.. _io_realm_RealmObject_removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _io_realm_RealmObject_removeChangeListener_RealmObjectChangeListener_: - -.. _removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _removeChangeListener_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_io_realm_RealmObjectChangeListener_: - -.. _RealmObject_removeChangeListener_RealmObjectChangeListener_: - -.. list-table:: - :header-rows: 1 - - * - | public final **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmObjectChangeListener ` listener - | ) - - - - - * - Removes a previously registered listener. - - - - - **Parameters** - - - ``listener`` - the instance to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` or the object is an unmanaged object. - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmObjectChangeListener.txt b/source/sdk/java/api/io/realm/RealmObjectChangeListener.txt deleted file mode 100644 index e0f7a2f777..0000000000 --- a/source/sdk/java/api/io/realm/RealmObjectChangeListener.txt +++ /dev/null @@ -1,209 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmObjectChangeListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmObjectChangeListener: - - - -io.realm -======== - -``RealmObjectChangeListener`` can be registered on a :ref:`RealmModel ` or :ref:`RealmObject ` to receive detailed notifications when an object changes. - -Realm instances on a thread without an `android.os.Looper `__ cannot register a ``RealmObjectChangeListener`` . - - - -Listener cannot be registered inside a transaction. - - - - -.. seealso:: - - - - - :ref:`Realm.addChangeListener(RealmChangeListener) ` - - - - - :ref:`Realm.removeAllChangeListeners() ` - - - - - :ref:`Realm.removeChangeListener(RealmChangeListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | **T** t, - | :ref:`ObjectChangeSet ` changeSet - | ) - - - When this gets called to return the results of an asynchronous query made by :ref:`RealmQuery.findFirstAsync() ` , ``changeSet`` will be ``null`` . - - - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _RealmObjectChangeListener_onChange: - -.. _RealmObjectChangeListener_onChange__: - -.. _io_realm_RealmObjectChangeListener_onChange: - -.. _io_realm_RealmObjectChangeListener_onChange__: - - - -onChange --------- - -.. _io_realm_RealmObjectChangeListener_onChange_T_io_realm_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_T__io_realm_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_T_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_T__ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_RealmModel_io_realm_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_RealmModel__io_realm_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_RealmModel_ObjectChangeSet_: - -.. _io_realm_RealmObjectChangeListener_onChange_RealmModel__ObjectChangeSet_: - -.. _onChange_T_io_realm_ObjectChangeSet_: - -.. _onChange_T__io_realm_ObjectChangeSet_: - -.. _onChange_T_ObjectChangeSet_: - -.. _onChange_T__ObjectChangeSet_: - -.. _onChange_RealmModel_io_realm_ObjectChangeSet_: - -.. _onChange_RealmModel__io_realm_ObjectChangeSet_: - -.. _onChange_RealmModel_ObjectChangeSet_: - -.. _onChange_RealmModel__ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_T_io_realm_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_T__io_realm_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_T_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_T__ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_RealmModel_io_realm_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_RealmModel__io_realm_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_RealmModel_ObjectChangeSet_: - -.. _RealmObjectChangeListener_onChange_RealmModel__ObjectChangeSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | **T** t, - | :ref:`ObjectChangeSet ` changeSet - | ) - - - - - * - When this gets called to return the results of an asynchronous query made by :ref:`RealmQuery.findFirstAsync() ` , ``changeSet`` will be ``null`` . - - When this gets called because the object was deleted, ``changeSet.isDeleted()`` will return ``true`` and ``changeSet.getFieldChanges()`` will return ``null`` . - - - - When this gets called because the object was modified, ``changeSet.isDeleted()`` will return ``false`` and ``changeSet.getFieldChanges()`` will return the detailed information about the fields' changes. - - - - If a field points to another RealmObject this listener will only be triggered if the field is set to a new object or null. Updating the referenced RealmObject will not trigger this listener. - - If a field points to a RealmList, this listener will only be triggered if one or multiple objects are inserted, removed or moved within the List. Updating the objects in the RealmList will not trigger this listener. - - Changes to :ref:`LinkingObjects ` annotated :ref:`RealmResults ` fields will not be monitored, nor reported through this change listener. - - - - - - - - - **Parameters** - - - ``t`` - the ``RealmObject`` this listener is registered to. - - - - - - - ``changeSet`` - the detailed information about the changes. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmObjectSchema.txt b/source/sdk/java/api/io/realm/RealmObjectSchema.txt deleted file mode 100644 index ba2c018a0e..0000000000 --- a/source/sdk/java/api/io/realm/RealmObjectSchema.txt +++ /dev/null @@ -1,3397 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmObjectSchema -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmObjectSchema: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmObjectSchema - - -Class for interacting with the schema for a given RealmObject class. This makes it possible to inspect, add, delete or change the fields for given class.If this :ref:`RealmObjectSchema ` is retrieved from an immutable :ref:`RealmSchema ` , this :ref:`RealmObjectSchema ` will be immutable as well. - - - - - - -.. seealso:: - - - - - :ref:`io.realm.RealmMigration ` - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static interface`` - - :ref:`RealmObjectSchema.Function ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ fieldType, - | :ref:`io.realm.FieldAttribute[] ` attributes - | ) - - - Adds a new simple field to the RealmObject class. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addIndex ` ( - | `String `__ fieldName - | ) - - - Adds an index to a given field. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addPrimaryKey ` ( - | `String `__ fieldName - | ) - - - Adds a primary key to a given field. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmDictionaryField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Adds a new field that references a :ref:`RealmDictionary ` with primitive values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmDictionaryField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - Adds a new field that contains a :ref:`RealmDictionary ` with references to other Realm model classes. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmListField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Adds a new field that references a :ref:`RealmList ` with primitive values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmListField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - Adds a new field that contains a :ref:`RealmList ` with references to other Realm model classes. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmObjectField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - Adds a new field that references another :ref:`RealmObject ` . - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmSetField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - Adds a new field that references a :ref:`RealmSet ` with primitive values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`addRealmSetField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - Adds a new field that contains a :ref:`RealmSet ` with references to other Realm model classes. - - - - - - - * - public `String `__ - - | :ref:`getClassName ` () - | - - - Returns the name of the RealmObject class being represented by this schema. - - - - - * - public `Set `__ - - | :ref:`getFieldNames ` () - | - - - Returns all fields in this class. - - - - - * - public :ref:`RealmFieldType ` - - | :ref:`getFieldType ` ( - | `String `__ fieldName - | ) - - - Returns the type used by the underlying storage engine to represent this field. - - - - - * - public `String `__ - - | :ref:`getPrimaryKey ` () - | - - - Returns the name of the primary key field. - - - - - * - public **boolean** - - | :ref:`hasField ` ( - | `String `__ fieldName - | ) - - - Tests if the class has field defined with the given name. - - - - - * - public **boolean** - - | :ref:`hasIndex ` ( - | `String `__ fieldName - | ) - - - Checks if a given field has an index defined. - - - - - * - public **boolean** - - | :ref:`hasPrimaryKey ` () - | - - - Checks if the class has a primary key defined. - - - - - * - public **boolean** - - | :ref:`isEmbedded ` () - | - - - Returns ``true`` if objects of this type are considered "embedded". - - - - - - - * - public **boolean** - - | :ref:`isNullable ` ( - | `String `__ fieldName - | ) - - - Checks if a given field is nullable i.e., it is allowed to contain ``null`` values. - - - - - - - * - public **boolean** - - | :ref:`isPrimaryKey ` ( - | `String `__ fieldName - | ) - - - Checks if a given field is the primary key field. - - - - - * - public **boolean** - - | :ref:`isRequired ` ( - | `String `__ fieldName - | ) - - - Checks if a given field is required i.e., it is not allowed to contain ``null`` values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`removeField ` ( - | `String `__ fieldName - | ) - - - Removes a field from the class. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`removeIndex ` ( - | `String `__ fieldName - | ) - - - Removes an index from a given field. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`removePrimaryKey ` () - | - - - Removes the primary key from this class. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`renameField ` ( - | `String `__ currentFieldName, - | `String `__ newFieldName - | ) - - - Renames a field from one name to another. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`setClassName ` ( - | `String `__ className - | ) - - - Sets a new name for this RealmObject class. - - - - - * - public **void** - - | :ref:`setEmbedded ` ( - | **boolean** embedded - | ) - - - Converts the class to be embedded or not. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`setNullable ` ( - | `String `__ fieldName, - | **boolean** nullable - | ) - - - Sets a field to be nullable i.e., it should be able to hold ``null`` values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`setRequired ` ( - | `String `__ fieldName, - | **boolean** required - | ) - - - Sets a field to be required i.e., it is not allowed to hold ``null`` values. - - - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`transform ` ( - | :ref:`RealmObjectSchema.Function ` function - | ) - - - Runs a transformation function on each RealmObject instance of the current class. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _addField: - -.. _addField__: - -.. _RealmObjectSchema_addField: - -.. _RealmObjectSchema_addField__: - -.. _io_realm_RealmObjectSchema_addField: - -.. _io_realm_RealmObjectSchema_addField__: - - - -addField --------- - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_Class_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__Class__FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String_Class_FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_java_lang_String__Class__FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String_Class_FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String__Class__FieldAttribute_: - -.. _io_realm_RealmObjectSchema_addField_String_Class_FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_String__Class__FieldAttribute____: - -.. _addField_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _addField_java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _addField_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _addField_java_lang_String__java_lang_Class__FieldAttribute_: - -.. _addField_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _addField_java_lang_String__java_lang_Class__FieldAttribute____: - -.. _addField_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _addField_java_lang_String__Class__io_realm_FieldAttribute_: - -.. _addField_java_lang_String_Class_FieldAttribute_: - -.. _addField_java_lang_String__Class__FieldAttribute_: - -.. _addField_java_lang_String_Class_FieldAttribute____: - -.. _addField_java_lang_String__Class__FieldAttribute____: - -.. _addField_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _addField_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _addField_String_java_lang_Class_FieldAttribute_: - -.. _addField_String__java_lang_Class__FieldAttribute_: - -.. _addField_String_java_lang_Class_FieldAttribute____: - -.. _addField_String__java_lang_Class__FieldAttribute____: - -.. _addField_String_Class_io_realm_FieldAttribute_: - -.. _addField_String__Class__io_realm_FieldAttribute_: - -.. _addField_String_Class_FieldAttribute_: - -.. _addField_String__Class__FieldAttribute_: - -.. _addField_String_Class_FieldAttribute____: - -.. _addField_String__Class__FieldAttribute____: - -.. _RealmObjectSchema_addField_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String__java_lang_Class__FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _RealmObjectSchema_addField_java_lang_String__java_lang_Class__FieldAttribute____: - -.. _RealmObjectSchema_addField_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String__Class__io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String_Class_FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String__Class__FieldAttribute_: - -.. _RealmObjectSchema_addField_java_lang_String_Class_FieldAttribute____: - -.. _RealmObjectSchema_addField_java_lang_String__Class__FieldAttribute____: - -.. _RealmObjectSchema_addField_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_String_java_lang_Class_FieldAttribute_: - -.. _RealmObjectSchema_addField_String__java_lang_Class__FieldAttribute_: - -.. _RealmObjectSchema_addField_String_java_lang_Class_FieldAttribute____: - -.. _RealmObjectSchema_addField_String__java_lang_Class__FieldAttribute____: - -.. _RealmObjectSchema_addField_String_Class_io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_String__Class__io_realm_FieldAttribute_: - -.. _RealmObjectSchema_addField_String_Class_FieldAttribute_: - -.. _RealmObjectSchema_addField_String__Class__FieldAttribute_: - -.. _RealmObjectSchema_addField_String_Class_FieldAttribute____: - -.. _RealmObjectSchema_addField_String__Class__FieldAttribute____: - -.. _io_realm_RealmObjectSchema_addField_String__Class_____FieldAttribute____: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ fieldType, - | :ref:`io.realm.FieldAttribute[] ` attributes - | ) - - - - - * - Adds a new simple field to the RealmObject class. The type must be one supported by Realm. See :ref:`RealmObject ` for the list of supported types. If the field should allow ``null`` values use the boxed type instead e.g., ``Integer.class`` instead of ``int.class`` . - - To add fields that reference other RealmObjects or RealmLists use :ref:`addRealmObjectField(String, RealmObjectSchema) ` or :ref:`addRealmListField(String, RealmObjectSchema) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``fieldType`` - type of field to add. See :ref:`RealmObject ` for the full list. - - - - - - - ``attributes`` - set of attributes for this field. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the type isn't supported, field name is illegal or a field with that name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or if adding a a field with :ref:`FieldAttribute.PRIMARY_KEY ` attribute to a schema of a synced Realm. - - - - - - - - - - - - - - -.. _addIndex: - -.. _addIndex__: - -.. _RealmObjectSchema_addIndex: - -.. _RealmObjectSchema_addIndex__: - -.. _io_realm_RealmObjectSchema_addIndex: - -.. _io_realm_RealmObjectSchema_addIndex__: - - - -addIndex --------- - -.. _io_realm_RealmObjectSchema_addIndex_java_lang_String_: - -.. _io_realm_RealmObjectSchema_addIndex_String_: - -.. _addIndex_java_lang_String_: - -.. _addIndex_String_: - -.. _RealmObjectSchema_addIndex_java_lang_String_: - -.. _RealmObjectSchema_addIndex_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addIndex ` ( - | `String `__ fieldName - | ) - - - - - * - Adds an index to a given field. This is the equivalent of adding the :ref:`io.realm.annotations.Index ` annotation on the field. - - - - - - - **Parameters** - - - ``fieldName`` - field to add index to. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be indexed or it already has a index defined. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _addPrimaryKey: - -.. _addPrimaryKey__: - -.. _RealmObjectSchema_addPrimaryKey: - -.. _RealmObjectSchema_addPrimaryKey__: - -.. _io_realm_RealmObjectSchema_addPrimaryKey: - -.. _io_realm_RealmObjectSchema_addPrimaryKey__: - - - -addPrimaryKey -------------- - -.. _io_realm_RealmObjectSchema_addPrimaryKey_java_lang_String_: - -.. _io_realm_RealmObjectSchema_addPrimaryKey_String_: - -.. _addPrimaryKey_java_lang_String_: - -.. _addPrimaryKey_String_: - -.. _RealmObjectSchema_addPrimaryKey_java_lang_String_: - -.. _RealmObjectSchema_addPrimaryKey_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addPrimaryKey ` ( - | `String `__ fieldName - | ) - - - - - * - Adds a primary key to a given field. This is the same as adding the :ref:`io.realm.annotations.PrimaryKey ` annotation on the field. Further, this implicitly adds :ref:`io.realm.annotations.Index ` annotation to the field as well. - - - - - - - **Parameters** - - - ``fieldName`` - field to set as primary key. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, the field cannot be a primary key or it already has a primary key defined. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. - - - - - - - - - - - - - - -.. _addRealmDictionaryField: - -.. _addRealmDictionaryField__: - -.. _RealmObjectSchema_addRealmDictionaryField: - -.. _RealmObjectSchema_addRealmDictionaryField__: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField__: - - - -addRealmDictionaryField ------------------------ - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__Class_: - -.. _addRealmDictionaryField_java_lang_String_java_lang_Class_: - -.. _addRealmDictionaryField_java_lang_String__java_lang_Class_: - -.. _addRealmDictionaryField_java_lang_String_Class_: - -.. _addRealmDictionaryField_java_lang_String__Class_: - -.. _addRealmDictionaryField_String_java_lang_Class_: - -.. _addRealmDictionaryField_String__java_lang_Class_: - -.. _addRealmDictionaryField_String_Class_: - -.. _addRealmDictionaryField_String__Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_String_Class_: - -.. _RealmObjectSchema_addRealmDictionaryField_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__Class____: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmDictionaryField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Adds a new field that references a :ref:`RealmDictionary ` with primitive values. See :ref:`RealmObject ` for the list of supported types. - - Nullability of elements are defined by using the correct class e.g., ``Integer.class`` instead of ``int.class`` . Alternatively :ref:`setRequired(String, boolean) ` can be used. - - - - Example: - - - - .. code-block:: java - - - // Defines the dictionary of Strings as being non null. - RealmObjectSchema schema = schema.create("Person") - .addRealmDictionaryField("parentAndChild", String.class) - .setRequired("parentAndChild", true) - - - - - - If the list contains references to other Realm classes, use :ref:`addRealmDictionaryField(String, RealmObjectSchema) ` instead. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``primitiveType`` - simple type of elements in the array. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_java_lang_String__RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmDictionaryField_String__RealmObjectSchema_: - -.. _addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _addRealmDictionaryField_java_lang_String_RealmObjectSchema_: - -.. _addRealmDictionaryField_java_lang_String__RealmObjectSchema_: - -.. _addRealmDictionaryField_String_io_realm_RealmObjectSchema_: - -.. _addRealmDictionaryField_String__io_realm_RealmObjectSchema_: - -.. _addRealmDictionaryField_String_RealmObjectSchema_: - -.. _addRealmDictionaryField_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_java_lang_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmDictionaryField_String__RealmObjectSchema_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmDictionaryField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - - - * - Adds a new field that contains a :ref:`RealmDictionary ` with references to other Realm model classes. - - If the dictionary contains primitive types, use :ref:`addRealmDictionaryField(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``objectSchema`` - schema for the Realm type being referenced. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _addRealmListField: - -.. _addRealmListField__: - -.. _RealmObjectSchema_addRealmListField: - -.. _RealmObjectSchema_addRealmListField__: - -.. _io_realm_RealmObjectSchema_addRealmListField: - -.. _io_realm_RealmObjectSchema_addRealmListField__: - - - -addRealmListField ------------------ - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String__Class_: - -.. _addRealmListField_java_lang_String_java_lang_Class_: - -.. _addRealmListField_java_lang_String__java_lang_Class_: - -.. _addRealmListField_java_lang_String_Class_: - -.. _addRealmListField_java_lang_String__Class_: - -.. _addRealmListField_String_java_lang_Class_: - -.. _addRealmListField_String__java_lang_Class_: - -.. _addRealmListField_String_Class_: - -.. _addRealmListField_String__Class_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String_Class_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String__Class_: - -.. _RealmObjectSchema_addRealmListField_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmListField_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmListField_String_Class_: - -.. _RealmObjectSchema_addRealmListField_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String__Class____: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmListField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Adds a new field that references a :ref:`RealmList ` with primitive values. See :ref:`RealmObject ` for the list of supported types. - - Nullability of elements are defined by using the correct class e.g., ``Integer.class`` instead of ``int.class`` . Alternatively :ref:`setRequired(String, boolean) ` can be used. - - - - Example: - - - - .. code-block:: java - - - // Defines the list of Strings as being non null. - RealmObjectSchema schema = schema.create("Person") - .addRealmListField("children", String.class) - .setRequired("children", true) - - - - - - If the list contains references to other Realm classes, use :ref:`addRealmListField(String, RealmObjectSchema) ` instead. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``primitiveType`` - simple type of elements in the array. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_java_lang_String__RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmListField_String__RealmObjectSchema_: - -.. _addRealmListField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _addRealmListField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _addRealmListField_java_lang_String_RealmObjectSchema_: - -.. _addRealmListField_java_lang_String__RealmObjectSchema_: - -.. _addRealmListField_String_io_realm_RealmObjectSchema_: - -.. _addRealmListField_String__io_realm_RealmObjectSchema_: - -.. _addRealmListField_String_RealmObjectSchema_: - -.. _addRealmListField_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_java_lang_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmListField_String__RealmObjectSchema_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmListField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - - - * - Adds a new field that contains a :ref:`RealmList ` with references to other Realm model classes. - - If the list contains primitive types, use :ref:`addRealmListField(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``objectSchema`` - schema for the Realm type being referenced. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _addRealmObjectField: - -.. _addRealmObjectField__: - -.. _RealmObjectSchema_addRealmObjectField: - -.. _RealmObjectSchema_addRealmObjectField__: - -.. _io_realm_RealmObjectSchema_addRealmObjectField: - -.. _io_realm_RealmObjectSchema_addRealmObjectField__: - - - -addRealmObjectField -------------------- - -.. _io_realm_RealmObjectSchema_addRealmObjectField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_java_lang_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_java_lang_String__RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmObjectField_String__RealmObjectSchema_: - -.. _addRealmObjectField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _addRealmObjectField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _addRealmObjectField_java_lang_String_RealmObjectSchema_: - -.. _addRealmObjectField_java_lang_String__RealmObjectSchema_: - -.. _addRealmObjectField_String_io_realm_RealmObjectSchema_: - -.. _addRealmObjectField_String__io_realm_RealmObjectSchema_: - -.. _addRealmObjectField_String_RealmObjectSchema_: - -.. _addRealmObjectField_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_java_lang_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_java_lang_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmObjectField_String__RealmObjectSchema_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmObjectField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - - - * - Adds a new field that references another :ref:`RealmObject ` . - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``objectSchema`` - schema for the Realm type being referenced. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name is illegal or a field with that name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _addRealmSetField: - -.. _addRealmSetField__: - -.. _RealmObjectSchema_addRealmSetField: - -.. _RealmObjectSchema_addRealmSetField__: - -.. _io_realm_RealmObjectSchema_addRealmSetField: - -.. _io_realm_RealmObjectSchema_addRealmSetField__: - - - -addRealmSetField ----------------- - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String_java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String__java_lang_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String_Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String__Class_: - -.. _addRealmSetField_java_lang_String_java_lang_Class_: - -.. _addRealmSetField_java_lang_String__java_lang_Class_: - -.. _addRealmSetField_java_lang_String_Class_: - -.. _addRealmSetField_java_lang_String__Class_: - -.. _addRealmSetField_String_java_lang_Class_: - -.. _addRealmSetField_String__java_lang_Class_: - -.. _addRealmSetField_String_Class_: - -.. _addRealmSetField_String__Class_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String_Class_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String__Class_: - -.. _RealmObjectSchema_addRealmSetField_String_java_lang_Class_: - -.. _RealmObjectSchema_addRealmSetField_String__java_lang_Class_: - -.. _RealmObjectSchema_addRealmSetField_String_Class_: - -.. _RealmObjectSchema_addRealmSetField_String__Class_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String__Class____: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmSetField ` ( - | `String `__ fieldName, - | `java.lang.Class\ `__ primitiveType - | ) - - - - - * - Adds a new field that references a :ref:`RealmSet ` with primitive values. See :ref:`RealmObject ` for the list of supported types. - - Nullability of elements are defined by using the correct class e.g., ``Integer.class`` instead of ``int.class`` . Alternatively :ref:`setRequired(String, boolean) ` can be used. - - - - Example: - - - - .. code-block:: java - - - // Defines the set of Strings as being non null. - RealmObjectSchema schema = schema.create("Person") - .addRealmSetField("children", String.class) - .setRequired("children", true) - - - - - - If the list contains references to other Realm classes, use :ref:`addRealmSetField(String, RealmObjectSchema) ` instead. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``primitiveType`` - simple type of elements in the array. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal, a field with that name already exists or the element type isn't supported. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_java_lang_String__RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String_io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String__io_realm_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String_RealmObjectSchema_: - -.. _io_realm_RealmObjectSchema_addRealmSetField_String__RealmObjectSchema_: - -.. _addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _addRealmSetField_java_lang_String_RealmObjectSchema_: - -.. _addRealmSetField_java_lang_String__RealmObjectSchema_: - -.. _addRealmSetField_String_io_realm_RealmObjectSchema_: - -.. _addRealmSetField_String__io_realm_RealmObjectSchema_: - -.. _addRealmSetField_String_RealmObjectSchema_: - -.. _addRealmSetField_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_java_lang_String__RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_String_io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_String__io_realm_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_String_RealmObjectSchema_: - -.. _RealmObjectSchema_addRealmSetField_String__RealmObjectSchema_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`addRealmSetField ` ( - | `String `__ fieldName, - | :ref:`RealmObjectSchema ` objectSchema - | ) - - - - - * - Adds a new field that contains a :ref:`RealmSet ` with references to other Realm model classes. - - If the set contains primitive types, use :ref:`addRealmSetField(String, Class) ` instead. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to add. - - - - - ``objectSchema`` - schema for the Realm type being referenced. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name is illegal or a field with that name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _getClassName: - -.. _getClassName__: - -.. _RealmObjectSchema_getClassName: - -.. _RealmObjectSchema_getClassName__: - -.. _io_realm_RealmObjectSchema_getClassName: - -.. _io_realm_RealmObjectSchema_getClassName__: - - - -getClassName ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getClassName ` () - | - - - - - * - Returns the name of the RealmObject class being represented by this schema. - - - When using a normal :ref:`Realm ` this name is the same as the :ref:`RealmObject ` class. - - - - - - When using a :ref:`DynamicRealm ` this is the name used in all API methods requiring a class name. - - - - - - - - - - - - - - **Returns** - - the name of the RealmObject class represented by this schema. - - - - - **Throws** - - - `IllegalStateException `__ - if this schema defintion is no longer part of the Realm. - - - - - - - - - - - - -.. _getFieldNames: - -.. _getFieldNames__: - -.. _RealmObjectSchema_getFieldNames: - -.. _RealmObjectSchema_getFieldNames__: - -.. _io_realm_RealmObjectSchema_getFieldNames: - -.. _io_realm_RealmObjectSchema_getFieldNames__: - - - -getFieldNames -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Set `__ :ref:`getFieldNames ` () - | - - - - - * - Returns all fields in this class. - - - - - - - **Returns** - - a list of all the fields in this class. - - - - - - - - - - - -.. _getFieldType: - -.. _getFieldType__: - -.. _RealmObjectSchema_getFieldType: - -.. _RealmObjectSchema_getFieldType__: - -.. _io_realm_RealmObjectSchema_getFieldType: - -.. _io_realm_RealmObjectSchema_getFieldType__: - - - -getFieldType ------------- - -.. _io_realm_RealmObjectSchema_getFieldType_java_lang_String_: - -.. _io_realm_RealmObjectSchema_getFieldType_String_: - -.. _getFieldType_java_lang_String_: - -.. _getFieldType_String_: - -.. _RealmObjectSchema_getFieldType_java_lang_String_: - -.. _RealmObjectSchema_getFieldType_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFieldType ` :ref:`getFieldType ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the type used by the underlying storage engine to represent this field. - - - - - **Parameters** - - - ``fieldName`` - name of the target field. - - - - - - - - **Returns** - - the underlying type used by Realm to represent this field. - - - - - - - - - - - -.. _getPrimaryKey: - -.. _getPrimaryKey__: - -.. _RealmObjectSchema_getPrimaryKey: - -.. _RealmObjectSchema_getPrimaryKey__: - -.. _io_realm_RealmObjectSchema_getPrimaryKey: - -.. _io_realm_RealmObjectSchema_getPrimaryKey__: - - - -getPrimaryKey -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getPrimaryKey ` () - | - - - - - * - Returns the name of the primary key field. - - - - - - - **Returns** - - the name of the primary key field. - - - - - **Throws** - - - `IllegalStateException `__ - if the class doesn't have a primary key defined. - - - - - - - - - - - - -.. _hasField: - -.. _hasField__: - -.. _RealmObjectSchema_hasField: - -.. _RealmObjectSchema_hasField__: - -.. _io_realm_RealmObjectSchema_hasField: - -.. _io_realm_RealmObjectSchema_hasField__: - - - -hasField --------- - -.. _io_realm_RealmObjectSchema_hasField_java_lang_String_: - -.. _io_realm_RealmObjectSchema_hasField_String_: - -.. _hasField_java_lang_String_: - -.. _hasField_String_: - -.. _RealmObjectSchema_hasField_java_lang_String_: - -.. _RealmObjectSchema_hasField_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasField ` ( - | `String `__ fieldName - | ) - - - - - * - Tests if the class has field defined with the given name. - - - - - **Parameters** - - - ``fieldName`` - field name to test. - - - - - - - - **Returns** - - ``true`` if the field exists, ``false`` otherwise. - - - - - - - - - - - - - -.. _hasIndex: - -.. _hasIndex__: - -.. _RealmObjectSchema_hasIndex: - -.. _RealmObjectSchema_hasIndex__: - -.. _io_realm_RealmObjectSchema_hasIndex: - -.. _io_realm_RealmObjectSchema_hasIndex__: - - - -hasIndex --------- - -.. _io_realm_RealmObjectSchema_hasIndex_java_lang_String_: - -.. _io_realm_RealmObjectSchema_hasIndex_String_: - -.. _hasIndex_java_lang_String_: - -.. _hasIndex_String_: - -.. _RealmObjectSchema_hasIndex_java_lang_String_: - -.. _RealmObjectSchema_hasIndex_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasIndex ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if a given field has an index defined. - - - - - **Parameters** - - - ``fieldName`` - existing field name to check. - - - - - - - - **Returns** - - ``true`` if field is indexed, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.Index ` - - - - - - - - - - - - -.. _hasPrimaryKey: - -.. _hasPrimaryKey__: - -.. _RealmObjectSchema_hasPrimaryKey: - -.. _RealmObjectSchema_hasPrimaryKey__: - -.. _io_realm_RealmObjectSchema_hasPrimaryKey: - -.. _io_realm_RealmObjectSchema_hasPrimaryKey__: - - - -hasPrimaryKey -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasPrimaryKey ` () - | - - - - - * - Checks if the class has a primary key defined. - - - - - - - **Returns** - - ``true`` if a primary key is defined, ``false`` otherwise. - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.PrimaryKey ` - - - - - - - - - - - - -.. _isEmbedded: - -.. _isEmbedded__: - -.. _RealmObjectSchema_isEmbedded: - -.. _RealmObjectSchema_isEmbedded__: - -.. _io_realm_RealmObjectSchema_isEmbedded: - -.. _io_realm_RealmObjectSchema_isEmbedded__: - - - -isEmbedded ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmbedded ` () - | - - - - - * - Returns ``true`` if objects of this type are considered "embedded". See :ref:`RealmClass.embedded() ` for further details. - - - - - - - - - **Returns** - - ``true`` if objects of this type are embedded. ``false`` if not. - - - - - - - - - - - - - -.. _isNullable: - -.. _isNullable__: - -.. _RealmObjectSchema_isNullable: - -.. _RealmObjectSchema_isNullable__: - -.. _io_realm_RealmObjectSchema_isNullable: - -.. _io_realm_RealmObjectSchema_isNullable__: - - - -isNullable ----------- - -.. _io_realm_RealmObjectSchema_isNullable_java_lang_String_: - -.. _io_realm_RealmObjectSchema_isNullable_String_: - -.. _isNullable_java_lang_String_: - -.. _isNullable_String_: - -.. _RealmObjectSchema_isNullable_java_lang_String_: - -.. _RealmObjectSchema_isNullable_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isNullable ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if a given field is nullable i.e., it is allowed to contain ``null`` values. - - - - - - - **Parameters** - - - ``fieldName`` - field to check. - - - - - - - - **Returns** - - ``true`` if it is required, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - - - - - - .. seealso:: - - - - - :ref:`setNullable(String, boolean) ` - - - - - - - - - - - - -.. _isPrimaryKey: - -.. _isPrimaryKey__: - -.. _RealmObjectSchema_isPrimaryKey: - -.. _RealmObjectSchema_isPrimaryKey__: - -.. _io_realm_RealmObjectSchema_isPrimaryKey: - -.. _io_realm_RealmObjectSchema_isPrimaryKey__: - - - -isPrimaryKey ------------- - -.. _io_realm_RealmObjectSchema_isPrimaryKey_java_lang_String_: - -.. _io_realm_RealmObjectSchema_isPrimaryKey_String_: - -.. _isPrimaryKey_java_lang_String_: - -.. _isPrimaryKey_String_: - -.. _RealmObjectSchema_isPrimaryKey_java_lang_String_: - -.. _RealmObjectSchema_isPrimaryKey_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isPrimaryKey ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if a given field is the primary key field. - - - - - **Parameters** - - - ``fieldName`` - field to check. - - - - - - - - **Returns** - - ``true`` if it is the primary key field, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - - - - - - .. seealso:: - - - - - :ref:`addPrimaryKey(String) ` - - - - - - - - - - - - -.. _isRequired: - -.. _isRequired__: - -.. _RealmObjectSchema_isRequired: - -.. _RealmObjectSchema_isRequired__: - -.. _io_realm_RealmObjectSchema_isRequired: - -.. _io_realm_RealmObjectSchema_isRequired__: - - - -isRequired ----------- - -.. _io_realm_RealmObjectSchema_isRequired_java_lang_String_: - -.. _io_realm_RealmObjectSchema_isRequired_String_: - -.. _isRequired_java_lang_String_: - -.. _isRequired_String_: - -.. _RealmObjectSchema_isRequired_java_lang_String_: - -.. _RealmObjectSchema_isRequired_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isRequired ` ( - | `String `__ fieldName - | ) - - - - - * - Checks if a given field is required i.e., it is not allowed to contain ``null`` values. - - - - - - - **Parameters** - - - ``fieldName`` - field to check. - - - - - - - - **Returns** - - ``true`` if it is required, ``false`` otherwise. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - - - - - - .. seealso:: - - - - - :ref:`setRequired(String, boolean) ` - - - - - - - - - - - - -.. _removeField: - -.. _removeField__: - -.. _RealmObjectSchema_removeField: - -.. _RealmObjectSchema_removeField__: - -.. _io_realm_RealmObjectSchema_removeField: - -.. _io_realm_RealmObjectSchema_removeField__: - - - -removeField ------------ - -.. _io_realm_RealmObjectSchema_removeField_java_lang_String_: - -.. _io_realm_RealmObjectSchema_removeField_String_: - -.. _removeField_java_lang_String_: - -.. _removeField_String_: - -.. _RealmObjectSchema_removeField_java_lang_String_: - -.. _RealmObjectSchema_removeField_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`removeField ` ( - | `String `__ fieldName - | ) - - - - - * - Removes a field from the class. - - - - - **Parameters** - - - ``fieldName`` - field name to remove. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. - - - - - - - - - - - - - - -.. _removeIndex: - -.. _removeIndex__: - -.. _RealmObjectSchema_removeIndex: - -.. _RealmObjectSchema_removeIndex__: - -.. _io_realm_RealmObjectSchema_removeIndex: - -.. _io_realm_RealmObjectSchema_removeIndex__: - - - -removeIndex ------------ - -.. _io_realm_RealmObjectSchema_removeIndex_java_lang_String_: - -.. _io_realm_RealmObjectSchema_removeIndex_String_: - -.. _removeIndex_java_lang_String_: - -.. _removeIndex_String_: - -.. _RealmObjectSchema_removeIndex_java_lang_String_: - -.. _RealmObjectSchema_removeIndex_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`removeIndex ` ( - | `String `__ fieldName - | ) - - - - - * - Removes an index from a given field. This is the same as removing the ``@Index`` annotation on the field. - - - - - - - **Parameters** - - - ``fieldName`` - field to remove index from. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or the field doesn't have an index. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. - - - - - - - - - - - - - - -.. _removePrimaryKey: - -.. _removePrimaryKey__: - -.. _RealmObjectSchema_removePrimaryKey: - -.. _RealmObjectSchema_removePrimaryKey__: - -.. _io_realm_RealmObjectSchema_removePrimaryKey: - -.. _io_realm_RealmObjectSchema_removePrimaryKey__: - - - -removePrimaryKey ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`removePrimaryKey ` () - | - - - - - * - Removes the primary key from this class. This is the same as removing the :ref:`io.realm.annotations.PrimaryKey ` annotation from the class. Further, this implicitly removes :ref:`io.realm.annotations.Index ` annotation from the field as well. - - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the class doesn't have a primary key defined. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or of a synced Realm. - - - - - - - - - - - - - - -.. _renameField: - -.. _renameField__: - -.. _RealmObjectSchema_renameField: - -.. _RealmObjectSchema_renameField__: - -.. _io_realm_RealmObjectSchema_renameField: - -.. _io_realm_RealmObjectSchema_renameField__: - - - -renameField ------------ - -.. _io_realm_RealmObjectSchema_renameField_java_lang_String_java_lang_String_: - -.. _io_realm_RealmObjectSchema_renameField_java_lang_String__java_lang_String_: - -.. _io_realm_RealmObjectSchema_renameField_java_lang_String_String_: - -.. _io_realm_RealmObjectSchema_renameField_java_lang_String__String_: - -.. _io_realm_RealmObjectSchema_renameField_String_java_lang_String_: - -.. _io_realm_RealmObjectSchema_renameField_String__java_lang_String_: - -.. _io_realm_RealmObjectSchema_renameField_String_String_: - -.. _io_realm_RealmObjectSchema_renameField_String__String_: - -.. _renameField_java_lang_String_java_lang_String_: - -.. _renameField_java_lang_String__java_lang_String_: - -.. _renameField_java_lang_String_String_: - -.. _renameField_java_lang_String__String_: - -.. _renameField_String_java_lang_String_: - -.. _renameField_String__java_lang_String_: - -.. _renameField_String_String_: - -.. _renameField_String__String_: - -.. _RealmObjectSchema_renameField_java_lang_String_java_lang_String_: - -.. _RealmObjectSchema_renameField_java_lang_String__java_lang_String_: - -.. _RealmObjectSchema_renameField_java_lang_String_String_: - -.. _RealmObjectSchema_renameField_java_lang_String__String_: - -.. _RealmObjectSchema_renameField_String_java_lang_String_: - -.. _RealmObjectSchema_renameField_String__java_lang_String_: - -.. _RealmObjectSchema_renameField_String_String_: - -.. _RealmObjectSchema_renameField_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`renameField ` ( - | `String `__ currentFieldName, - | `String `__ newFieldName - | ) - - - - - * - Renames a field from one name to another. - - - - - **Parameters** - - - ``currentFieldName`` - field name to rename. - - - - - ``newFieldName`` - the new field name. - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or if the new field name already exists. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or for a synced Realm. - - - - - - - - - - - - - - -.. _setClassName: - -.. _setClassName__: - -.. _RealmObjectSchema_setClassName: - -.. _RealmObjectSchema_setClassName__: - -.. _io_realm_RealmObjectSchema_setClassName: - -.. _io_realm_RealmObjectSchema_setClassName__: - - - -setClassName ------------- - -.. _io_realm_RealmObjectSchema_setClassName_java_lang_String_: - -.. _io_realm_RealmObjectSchema_setClassName_String_: - -.. _setClassName_java_lang_String_: - -.. _setClassName_String_: - -.. _RealmObjectSchema_setClassName_java_lang_String_: - -.. _RealmObjectSchema_setClassName_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`setClassName ` ( - | `String `__ className - | ) - - - - - * - Sets a new name for this RealmObject class. This is equivalent to renaming it. - - - - - **Parameters** - - - ``className`` - the new name for this class. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if className is ``null`` or an empty string, or its length exceeds 56 characters. - - - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable or from a synced Realm. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmSchema.rename(String, String) ` - - - - - - - - - - - - -.. _setEmbedded: - -.. _setEmbedded__: - -.. _RealmObjectSchema_setEmbedded: - -.. _RealmObjectSchema_setEmbedded__: - -.. _io_realm_RealmObjectSchema_setEmbedded: - -.. _io_realm_RealmObjectSchema_setEmbedded__: - - - -setEmbedded ------------ - -.. _io_realm_RealmObjectSchema_setEmbedded_boolean_: - -.. _setEmbedded_boolean_: - -.. _RealmObjectSchema_setEmbedded_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setEmbedded ` ( - | **boolean** embedded - | ) - - - - - * - Converts the class to be embedded or not.A class can only be marked as embedded if the following invariants are satisfied: - - - - - The class is not allowed to have a primary key defined. - - - - All existing objects of this type, must have one and exactly one parent object already pointing to it. If 0 or more than 1 object has a reference to an object about to be marked embedded an `IllegalStateException `__ will be thrown. - - - - - - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the class could not be converted because it broke some of the Embedded Objects invariants. - - - - - - - - - - .. seealso:: - - - - - :ref:`RealmClass.embedded() ` - - - - - - - - - - - - -.. _setNullable: - -.. _setNullable__: - -.. _RealmObjectSchema_setNullable: - -.. _RealmObjectSchema_setNullable__: - -.. _io_realm_RealmObjectSchema_setNullable: - -.. _io_realm_RealmObjectSchema_setNullable__: - - - -setNullable ------------ - -.. _io_realm_RealmObjectSchema_setNullable_java_lang_String_boolean_: - -.. _io_realm_RealmObjectSchema_setNullable_java_lang_String__boolean_: - -.. _io_realm_RealmObjectSchema_setNullable_String_boolean_: - -.. _io_realm_RealmObjectSchema_setNullable_String__boolean_: - -.. _setNullable_java_lang_String_boolean_: - -.. _setNullable_java_lang_String__boolean_: - -.. _setNullable_String_boolean_: - -.. _setNullable_String__boolean_: - -.. _RealmObjectSchema_setNullable_java_lang_String_boolean_: - -.. _RealmObjectSchema_setNullable_java_lang_String__boolean_: - -.. _RealmObjectSchema_setNullable_String_boolean_: - -.. _RealmObjectSchema_setNullable_String__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`setNullable ` ( - | `String `__ fieldName, - | **boolean** nullable - | ) - - - - - * - Sets a field to be nullable i.e., it should be able to hold ``null`` values. This is equivalent to switching between primitive types and their boxed variant e.g., ``int`` to ``Integer`` . - - If the type of designated field is a list of values (not :ref:`RealmObject ` s , specified nullability only affects its elements, not the field itself. Value list itself is always non-nullable. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of field in the class. - - - - - ``nullable`` - ``true`` if field should be nullable, ``false`` otherwise. - - - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name doesn't exist, or cannot be set as nullable. - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - -.. _setRequired: - -.. _setRequired__: - -.. _RealmObjectSchema_setRequired: - -.. _RealmObjectSchema_setRequired__: - -.. _io_realm_RealmObjectSchema_setRequired: - -.. _io_realm_RealmObjectSchema_setRequired__: - - - -setRequired ------------ - -.. _io_realm_RealmObjectSchema_setRequired_java_lang_String_boolean_: - -.. _io_realm_RealmObjectSchema_setRequired_java_lang_String__boolean_: - -.. _io_realm_RealmObjectSchema_setRequired_String_boolean_: - -.. _io_realm_RealmObjectSchema_setRequired_String__boolean_: - -.. _setRequired_java_lang_String_boolean_: - -.. _setRequired_java_lang_String__boolean_: - -.. _setRequired_String_boolean_: - -.. _setRequired_String__boolean_: - -.. _RealmObjectSchema_setRequired_java_lang_String_boolean_: - -.. _RealmObjectSchema_setRequired_java_lang_String__boolean_: - -.. _RealmObjectSchema_setRequired_String_boolean_: - -.. _RealmObjectSchema_setRequired_String__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`setRequired ` ( - | `String `__ fieldName, - | **boolean** required - | ) - - - - - * - Sets a field to be required i.e., it is not allowed to hold ``null`` values. This is equivalent to switching between boxed types and their primitive variant e.g., ``Integer`` to ``int`` . - - If the type of designated field is a list of values (not :ref:`RealmObject ` s , specified nullability only affects its elements, not the field itself. Value list itself is always non-nullable. - - - - - - - - - **Parameters** - - - ``fieldName`` - name of field in the class. - - - - - ``required`` - ``true`` if field should be required, ``false`` otherwise. - - - - - - - - - - **Returns** - - the updated schema. - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name doesn't exist, cannot have the :ref:`Required ` annotation or the field already have been set as required. - - - - - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Required ` - - - - - - - - - - - - -.. _transform: - -.. _transform__: - -.. _RealmObjectSchema_transform: - -.. _RealmObjectSchema_transform__: - -.. _io_realm_RealmObjectSchema_transform: - -.. _io_realm_RealmObjectSchema_transform__: - - - -transform ---------- - -.. _io_realm_RealmObjectSchema_transform_io_realm_RealmObjectSchema_Function_: - -.. _io_realm_RealmObjectSchema_transform_Function_: - -.. _io_realm_RealmObjectSchema_transform_RealmObjectSchema_Function_: - -.. _transform_io_realm_RealmObjectSchema_Function_: - -.. _transform_Function_: - -.. _transform_RealmObjectSchema_Function_: - -.. _RealmObjectSchema_transform_io_realm_RealmObjectSchema_Function_: - -.. _RealmObjectSchema_transform_Function_: - -.. _RealmObjectSchema_transform_RealmObjectSchema_Function_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`transform ` ( - | :ref:`RealmObjectSchema.Function ` function - | ) - - - - - * - Runs a transformation function on each RealmObject instance of the current class. The object will be represented as a :ref:`DynamicRealmObject ` . - - There is no guarantees in which order the objects are returned. - - - - - - - **Parameters** - - - ``function`` - transformation function. - - - - - - - - **Returns** - - this schema. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if this :ref:`RealmObjectSchema ` is immutable. - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmObjectSchema/Function.txt b/source/sdk/java/api/io/realm/RealmObjectSchema/Function.txt deleted file mode 100644 index 4b99ee3689..0000000000 --- a/source/sdk/java/api/io/realm/RealmObjectSchema/Function.txt +++ /dev/null @@ -1,133 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmObjectSchema.Function -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmObjectSchema_Function: - - - -io.realm -======== - - - -**Enclosing class:** - -:ref:`RealmObjectSchema ` - - - -Function interface, used when traversing all objects of the current class and apply a function on each. - - -.. seealso:: - - - - - **transform(Function)** - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`apply ` ( - | :ref:`DynamicRealmObject ` obj - | ) - - - - - - - - - - -Method Detail -============= - -.. _apply: - -.. _apply__: - -.. _Function_apply: - -.. _Function_apply__: - -.. _RealmObjectSchema_Function_apply: - -.. _RealmObjectSchema_Function_apply__: - -.. _io_realm_RealmObjectSchema_Function_apply: - -.. _io_realm_RealmObjectSchema_Function_apply__: - - - -apply ------ - -.. _io_realm_RealmObjectSchema_Function_apply_io_realm_DynamicRealmObject_: - -.. _io_realm_RealmObjectSchema_Function_apply_DynamicRealmObject_: - -.. _apply_io_realm_DynamicRealmObject_: - -.. _apply_DynamicRealmObject_: - -.. _RealmObjectSchema_Function_apply_io_realm_DynamicRealmObject_: - -.. _RealmObjectSchema_Function_apply_DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`apply ` ( - | :ref:`DynamicRealmObject ` obj - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmQuery.txt b/source/sdk/java/api/io/realm/RealmQuery.txt deleted file mode 100644 index 04878b0218..0000000000 --- a/source/sdk/java/api/io/realm/RealmQuery.txt +++ /dev/null @@ -1,13378 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmQuery -^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmQuery: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmQuery - - -A RealmQuery encapsulates a query on a :ref:`io.realm.Realm ` or a :ref:`io.realm.RealmResults ` using the Builder pattern. The query is executed using either :ref:`findAll() ` or :ref:`findFirst() ` . - -The input to many of the query functions take a field name as String. Note that this is not type safe. If a RealmObject class is refactored care has to be taken to not break any queries. - -A :ref:`io.realm.Realm ` is unordered, which means that there is no guarantee that querying a Realm will return the objects in the order they where inserted. Use :ref:`sort(String) ` (String)} and similar methods if a specific order is required. - - - -A RealmQuery cannot be passed between different threads. - -Results are obtained quickly most of the times. However, launching heavy queries from the UI thread may result in a drop of frames or even ANRs. If you want to prevent these behaviors, you can instantiate a Realm using a :ref:`RealmConfiguration ` that explicitly sets :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` to ``false`` . This way queries will be forced to be launched from a non-UI thread. Alternatively, you can also use :ref:`findAllAsync() ` or :ref:`findFirstAsync() ` . - - - - - - -.. seealso:: - - - - - `Builder pattern `__ - - - - - - :ref:`Realm.where(Class) ` - - - - - :ref:`RealmResults.where() ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`RealmQuery ` - - | :ref:`alwaysFalse ` () - | - - - This predicate will never match, resulting in the query always returning 0 results. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`alwaysTrue ` () - | - - - This predicate will always match. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`and ` () - | - - - Logical-and two conditions Realm automatically applies logical-and between all query statements, so this is intended only as a mean to increase readability. - - - - - * - public **double** - - | :ref:`average ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public **Decimal128** - - | :ref:`averageDecimal128 ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public **Decimal128** - - | :ref:`averageRealmAny ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`beginGroup ` () - | - - - Begin grouping of conditions ("left parenthesis"). - - - - - * - public :ref:`RealmQuery ` - - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field begins with the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field begins with the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Condition that the value of field begins with the specified string. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Condition that the value of field begins with the specified string. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | **Decimal128** from, - | **Decimal128** to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` from, - | :ref:`RealmAny ` to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | `Date `__ from, - | `Date `__ to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | **float** from, - | **float** to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | **double** from, - | **double** to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | **long** from, - | **long** to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`between ` ( - | `String `__ fieldName, - | **int** from, - | **int** to - | ) - - - Between condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`contains ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Condition that value of field contains the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Condition that value of field contains the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`contains ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Condition that value of field contains the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Condition that value of field contains the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsEntry ` ( - | `String `__ fieldName, - | `java.util.Map.Entry\ `__ entry - | ) - - - Condition that value, if a dictionary field, contains the specified entry. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsKey ` ( - | `String `__ fieldName, - | `String `__ key - | ) - - - Condition that value, if a dictionary field, contains the specified key. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Float `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Double `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Long `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Integer `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Short `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Byte `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`containsValue ` ( - | `String `__ fieldName, - | `Boolean `__ value - | ) - - - Condition that value, if a dictionary field, contains the specified value. - - - - - * - public **long** - - | :ref:`count ` () - | - - - Counts the number of objects that fulfill the query conditions. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`distinct ` ( - | `String `__ firstFieldName, - | `java.lang.String[] `__ remainingFieldNames - | ) - - - Selects a distinct set of objects of a specific class. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`endGroup ` () - | - - - End grouping of conditions ("right parenthesis") which was opened by a call to ``beginGroup()`` . - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`endsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field ends with the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field ends with the specified substring. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`endsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Condition that the value of field ends with the specified string. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Condition that the value of field ends with the specified string. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`equalTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`equalTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`equalTo ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Equal-to comparison. - - - - - * - public :ref:`RealmResults ` - - | :ref:`findAll ` () - | - - - Finds all objects that fulfill the query conditions. - - - - - * - public :ref:`RealmResults ` - - | :ref:`findAllAsync ` () - | - - - Finds all objects that fulfill the query conditions. - - - - - * - public **E** - - | :ref:`findFirst ` () - | - - - Finds the first object that fulfills the query conditions. - - - - - * - public **E** - - | :ref:`findFirstAsync ` () - | - - - Similar to :ref:`findFirst() ` but runs asynchronously on a worker thread. - - - - - - - * - public `String `__ - - | :ref:`getDescription ` () - | - - - Returns a textual description of this query. - - - - - * - public **long** - - | :ref:`getQueryPointer ` () - | - - - Returns the pointer to the underlying C++ query. - - - - - * - public :ref:`Realm ` - - | :ref:`getRealm ` () - | - - - Returns the :ref:`Realm ` instance to which this query belongs. - - - - - - - * - public `String `__ - - | :ref:`getTypeQueried ` () - | - - - Returns the internal Realm name of the type being queried. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **float** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **double** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThan ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Greater-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **float** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **double** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Greater-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | :ref:`io.realm.RealmAny[] ` values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.util.Date[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Boolean[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Float[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Double[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Long[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Integer[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Short[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Byte[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values, - | :ref:`Case ` casing - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values - | ) - - - In comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`isEmpty ` ( - | `String `__ fieldName - | ) - - - Condition that finds values that are considered "empty" i.e., an empty list, the 0-length string or byte array. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`isNotEmpty ` ( - | `String `__ fieldName - | ) - - - Condition that finds values that are considered "Not-empty" i.e., a list, a string or a byte array with not-empty values. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`isNotNull ` ( - | `String `__ fieldName - | ) - - - Tests if a field is not ``null`` . - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`isNull ` ( - | `String `__ fieldName - | ) - - - Tests if a field is ``null`` . - - - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - Checks if :ref:`io.realm.RealmQuery ` is still valid to use i.e., the :ref:`io.realm.Realm ` instance hasn't been closed and any parent :ref:`io.realm.RealmResults ` is still valid. - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThan ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Less-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThan ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Less-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThan ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Less-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThan ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Less-than comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Less-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Less-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Less-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Less-than-or-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`like ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`like ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`limit ` ( - | **long** limit - | ) - - - Limits the number of objects returned in case the query matched more objects. - - - - - * - public `Number `__ - - | :ref:`max ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a field. - - - - - * - public :ref:`RealmAny ` - - | :ref:`maxRealmAny ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a :ref:`RealmAny ` field. - - - - - - - * - public `Date `__ - - | :ref:`maximumDate ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a field. - - - - - * - public `Number `__ - - | :ref:`min ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a field. - - - - - * - public :ref:`RealmAny ` - - | :ref:`minRealmAny ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a :ref:`RealmAny ` field. - - - - - - - * - public `Date `__ - - | :ref:`minimumDate ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a field. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`not ` () - | - - - Negate condition. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Not-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Not-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - Not-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - Not-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Not-equal-to comparison. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`or ` () - | - - - Logical-or two conditions. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`rawPredicate ` ( - | `String `__ predicate, - | `java.lang.Object[] `__ arguments - | ) - - - Create a text-based predicate using the Realm Query Language. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - Sorts the query result by the specific field names in the provided orders. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - Sorts the query result by the specific field names in the provided orders. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - Sorts the query result by the specified field name and order. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`sort ` ( - | `String `__ fieldName - | ) - - - Sorts the query result by the specific field name in ascending order. - - - - - * - public `Number `__ - - | :ref:`sum ` ( - | `String `__ fieldName - | ) - - - Calculates the sum of a given field. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _alwaysFalse: - -.. _alwaysFalse__: - -.. _RealmQuery_alwaysFalse: - -.. _RealmQuery_alwaysFalse__: - -.. _io_realm_RealmQuery_alwaysFalse: - -.. _io_realm_RealmQuery_alwaysFalse__: - - - -alwaysFalse ------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`alwaysFalse ` () - | - - - - - * - This predicate will never match, resulting in the query always returning 0 results. - - - - - - - - - - - - - - - -.. _alwaysTrue: - -.. _alwaysTrue__: - -.. _RealmQuery_alwaysTrue: - -.. _RealmQuery_alwaysTrue__: - -.. _io_realm_RealmQuery_alwaysTrue: - -.. _io_realm_RealmQuery_alwaysTrue__: - - - -alwaysTrue ----------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`alwaysTrue ` () - | - - - - - * - This predicate will always match. - - - - - - - - - - - - - - - -.. _and: - -.. _and__: - -.. _RealmQuery_and: - -.. _RealmQuery_and__: - -.. _io_realm_RealmQuery_and: - -.. _io_realm_RealmQuery_and__: - - - -and ----- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`and ` () - | - - - - - * - Logical-and two conditions Realm automatically applies logical-and between all query statements, so this is intended only as a mean to increase readability. - - - - - - - **Returns** - - the query object - - - - - - - - - - - -.. _average: - -.. _average__: - -.. _RealmQuery_average: - -.. _RealmQuery_average__: - -.. _io_realm_RealmQuery_average: - -.. _io_realm_RealmQuery_average__: - - - -average -------- - -.. _io_realm_RealmQuery_average_java_lang_String_: - -.. _io_realm_RealmQuery_average_String_: - -.. _average_java_lang_String_: - -.. _average_String_: - -.. _RealmQuery_average_java_lang_String_: - -.. _RealmQuery_average_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`average ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. Does not support dotted field notation. - - - - - **Parameters** - - - ``fieldName`` - the field to calculate average on. Only number fields are supported. - - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _averageDecimal128: - -.. _averageDecimal128__: - -.. _RealmQuery_averageDecimal128: - -.. _RealmQuery_averageDecimal128__: - -.. _io_realm_RealmQuery_averageDecimal128: - -.. _io_realm_RealmQuery_averageDecimal128__: - - - -averageDecimal128 ------------------ - -.. _io_realm_RealmQuery_averageDecimal128_java_lang_String_: - -.. _io_realm_RealmQuery_averageDecimal128_String_: - -.. _averageDecimal128_java_lang_String_: - -.. _averageDecimal128_String_: - -.. _RealmQuery_averageDecimal128_java_lang_String_: - -.. _RealmQuery_averageDecimal128_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **Decimal128** :ref:`averageDecimal128 ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. Does not support dotted field notation. - - - - - **Parameters** - - - ``fieldName`` - the field to calculate average on. Only Decimal128 fields is supported. For other number types consider using :ref:`average(String) ` . - - - - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type Decimal128. If no objects exist or they all have ``null`` as the value for the given field ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a Decimal128 type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _averageRealmAny: - -.. _averageRealmAny__: - -.. _RealmQuery_averageRealmAny: - -.. _RealmQuery_averageRealmAny__: - -.. _io_realm_RealmQuery_averageRealmAny: - -.. _io_realm_RealmQuery_averageRealmAny__: - - - -averageRealmAny ---------------- - -.. _io_realm_RealmQuery_averageRealmAny_java_lang_String_: - -.. _io_realm_RealmQuery_averageRealmAny_String_: - -.. _averageRealmAny_java_lang_String_: - -.. _averageRealmAny_String_: - -.. _RealmQuery_averageRealmAny_java_lang_String_: - -.. _RealmQuery_averageRealmAny_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **Decimal128** :ref:`averageRealmAny ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. Does not support dotted field notation. - - - - - **Parameters** - - - ``fieldName`` - the field to calculate average on. Only RealmAny fields are supported. For other types consider using :ref:`average(String) ` . - - - - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type Decimal128. If no objects exist or they all have ``null`` as the value for the given field ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a RealmAny type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _beginGroup: - -.. _beginGroup__: - -.. _RealmQuery_beginGroup: - -.. _RealmQuery_beginGroup__: - -.. _io_realm_RealmQuery_beginGroup: - -.. _io_realm_RealmQuery_beginGroup__: - - - -beginGroup ----------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`beginGroup ` () - | - - - - - * - Begin grouping of conditions ("left parenthesis"). A group must be closed with a call to ``endGroup()`` . - - - - - - - - - **Returns** - - the query object. - - - - - - - - - .. seealso:: - - - - - :ref:`endGroup() ` - - - - - - - - - - - - -.. _beginsWith: - -.. _beginsWith__: - -.. _RealmQuery_beginsWith: - -.. _RealmQuery_beginsWith__: - -.. _io_realm_RealmQuery_beginsWith: - -.. _io_realm_RealmQuery_beginsWith__: - - - -beginsWith ----------- - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_beginsWith_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__RealmAny__Case_: - -.. _beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _beginsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _beginsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _beginsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _beginsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _beginsWith_java_lang_String_RealmAny_Case_: - -.. _beginsWith_java_lang_String__RealmAny__Case_: - -.. _beginsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _beginsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _beginsWith_String_io_realm_RealmAny_Case_: - -.. _beginsWith_String__io_realm_RealmAny__Case_: - -.. _beginsWith_String_RealmAny_io_realm_Case_: - -.. _beginsWith_String__RealmAny__io_realm_Case_: - -.. _beginsWith_String_RealmAny_Case_: - -.. _beginsWith_String__RealmAny__Case_: - -.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_beginsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_beginsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_beginsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_beginsWith_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_beginsWith_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_beginsWith_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_beginsWith_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_beginsWith_String_RealmAny_Case_: - -.. _RealmQuery_beginsWith_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field begins with the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_beginsWith_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_beginsWith_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_beginsWith_String_String_Case_: - -.. _io_realm_RealmQuery_beginsWith_String__String__Case_: - -.. _beginsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _beginsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _beginsWith_java_lang_String_java_lang_String_Case_: - -.. _beginsWith_java_lang_String__java_lang_String__Case_: - -.. _beginsWith_java_lang_String_String_io_realm_Case_: - -.. _beginsWith_java_lang_String__String__io_realm_Case_: - -.. _beginsWith_java_lang_String_String_Case_: - -.. _beginsWith_java_lang_String__String__Case_: - -.. _beginsWith_String_java_lang_String_io_realm_Case_: - -.. _beginsWith_String__java_lang_String__io_realm_Case_: - -.. _beginsWith_String_java_lang_String_Case_: - -.. _beginsWith_String__java_lang_String__Case_: - -.. _beginsWith_String_String_io_realm_Case_: - -.. _beginsWith_String__String__io_realm_Case_: - -.. _beginsWith_String_String_Case_: - -.. _beginsWith_String__String__Case_: - -.. _RealmQuery_beginsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_beginsWith_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_beginsWith_java_lang_String_String_Case_: - -.. _RealmQuery_beginsWith_java_lang_String__String__Case_: - -.. _RealmQuery_beginsWith_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_beginsWith_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_beginsWith_String_java_lang_String_Case_: - -.. _RealmQuery_beginsWith_String__java_lang_String__Case_: - -.. _RealmQuery_beginsWith_String_String_io_realm_Case_: - -.. _RealmQuery_beginsWith_String__String__io_realm_Case_: - -.. _RealmQuery_beginsWith_String_String_Case_: - -.. _RealmQuery_beginsWith_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field begins with the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_String_RealmAny_: - -.. _io_realm_RealmQuery_beginsWith_String__RealmAny_: - -.. _beginsWith_java_lang_String_io_realm_RealmAny_: - -.. _beginsWith_java_lang_String__io_realm_RealmAny_: - -.. _beginsWith_java_lang_String_RealmAny_: - -.. _beginsWith_java_lang_String__RealmAny_: - -.. _beginsWith_String_io_realm_RealmAny_: - -.. _beginsWith_String__io_realm_RealmAny_: - -.. _beginsWith_String_RealmAny_: - -.. _beginsWith_String__RealmAny_: - -.. _RealmQuery_beginsWith_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_beginsWith_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_beginsWith_java_lang_String_RealmAny_: - -.. _RealmQuery_beginsWith_java_lang_String__RealmAny_: - -.. _RealmQuery_beginsWith_String_io_realm_RealmAny_: - -.. _RealmQuery_beginsWith_String__io_realm_RealmAny_: - -.. _RealmQuery_beginsWith_String_RealmAny_: - -.. _RealmQuery_beginsWith_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Condition that the value of field begins with the specified string. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String_String_: - -.. _io_realm_RealmQuery_beginsWith_java_lang_String__String_: - -.. _io_realm_RealmQuery_beginsWith_String_java_lang_String_: - -.. _io_realm_RealmQuery_beginsWith_String__java_lang_String_: - -.. _io_realm_RealmQuery_beginsWith_String_String_: - -.. _io_realm_RealmQuery_beginsWith_String__String_: - -.. _beginsWith_java_lang_String_java_lang_String_: - -.. _beginsWith_java_lang_String__java_lang_String_: - -.. _beginsWith_java_lang_String_String_: - -.. _beginsWith_java_lang_String__String_: - -.. _beginsWith_String_java_lang_String_: - -.. _beginsWith_String__java_lang_String_: - -.. _beginsWith_String_String_: - -.. _beginsWith_String__String_: - -.. _RealmQuery_beginsWith_java_lang_String_java_lang_String_: - -.. _RealmQuery_beginsWith_java_lang_String__java_lang_String_: - -.. _RealmQuery_beginsWith_java_lang_String_String_: - -.. _RealmQuery_beginsWith_java_lang_String__String_: - -.. _RealmQuery_beginsWith_String_java_lang_String_: - -.. _RealmQuery_beginsWith_String__java_lang_String_: - -.. _RealmQuery_beginsWith_String_String_: - -.. _RealmQuery_beginsWith_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`beginsWith ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Condition that the value of field begins with the specified string. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _between: - -.. _between__: - -.. _RealmQuery_between: - -.. _RealmQuery_between__: - -.. _io_realm_RealmQuery_between: - -.. _io_realm_RealmQuery_between__: - - - -between -------- - -.. _io_realm_RealmQuery_between_java_lang_String_Decimal128_Decimal128_: - -.. _io_realm_RealmQuery_between_java_lang_String__Decimal128__Decimal128_: - -.. _io_realm_RealmQuery_between_String_Decimal128_Decimal128_: - -.. _io_realm_RealmQuery_between_String__Decimal128__Decimal128_: - -.. _between_java_lang_String_Decimal128_Decimal128_: - -.. _between_java_lang_String__Decimal128__Decimal128_: - -.. _between_String_Decimal128_Decimal128_: - -.. _between_String__Decimal128__Decimal128_: - -.. _RealmQuery_between_java_lang_String_Decimal128_Decimal128_: - -.. _RealmQuery_between_java_lang_String__Decimal128__Decimal128_: - -.. _RealmQuery_between_String_Decimal128_Decimal128_: - -.. _RealmQuery_between_String__Decimal128__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | **Decimal128** from, - | **Decimal128** to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String_io_realm_RealmAny_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String__io_realm_RealmAny__RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String_RealmAny_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String__RealmAny__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String_RealmAny_RealmAny_: - -.. _io_realm_RealmQuery_between_java_lang_String__RealmAny__RealmAny_: - -.. _io_realm_RealmQuery_between_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_String_io_realm_RealmAny_RealmAny_: - -.. _io_realm_RealmQuery_between_String__io_realm_RealmAny__RealmAny_: - -.. _io_realm_RealmQuery_between_String_RealmAny_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_String__RealmAny__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_between_String_RealmAny_RealmAny_: - -.. _io_realm_RealmQuery_between_String__RealmAny__RealmAny_: - -.. _between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _between_java_lang_String_io_realm_RealmAny_RealmAny_: - -.. _between_java_lang_String__io_realm_RealmAny__RealmAny_: - -.. _between_java_lang_String_RealmAny_io_realm_RealmAny_: - -.. _between_java_lang_String__RealmAny__io_realm_RealmAny_: - -.. _between_java_lang_String_RealmAny_RealmAny_: - -.. _between_java_lang_String__RealmAny__RealmAny_: - -.. _between_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _between_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _between_String_io_realm_RealmAny_RealmAny_: - -.. _between_String__io_realm_RealmAny__RealmAny_: - -.. _between_String_RealmAny_io_realm_RealmAny_: - -.. _between_String__RealmAny__io_realm_RealmAny_: - -.. _between_String_RealmAny_RealmAny_: - -.. _between_String__RealmAny__RealmAny_: - -.. _RealmQuery_between_java_lang_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _RealmQuery_between_java_lang_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _RealmQuery_between_java_lang_String_io_realm_RealmAny_RealmAny_: - -.. _RealmQuery_between_java_lang_String__io_realm_RealmAny__RealmAny_: - -.. _RealmQuery_between_java_lang_String_RealmAny_io_realm_RealmAny_: - -.. _RealmQuery_between_java_lang_String__RealmAny__io_realm_RealmAny_: - -.. _RealmQuery_between_java_lang_String_RealmAny_RealmAny_: - -.. _RealmQuery_between_java_lang_String__RealmAny__RealmAny_: - -.. _RealmQuery_between_String_io_realm_RealmAny_io_realm_RealmAny_: - -.. _RealmQuery_between_String__io_realm_RealmAny__io_realm_RealmAny_: - -.. _RealmQuery_between_String_io_realm_RealmAny_RealmAny_: - -.. _RealmQuery_between_String__io_realm_RealmAny__RealmAny_: - -.. _RealmQuery_between_String_RealmAny_io_realm_RealmAny_: - -.. _RealmQuery_between_String__RealmAny__io_realm_RealmAny_: - -.. _RealmQuery_between_String_RealmAny_RealmAny_: - -.. _RealmQuery_between_String__RealmAny__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` from, - | :ref:`RealmAny ` to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_java_util_Date_java_util_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String__java_util_Date__java_util_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String_java_util_Date_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String__java_util_Date__Date_: - -.. _io_realm_RealmQuery_between_java_lang_String_Date_java_util_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String__Date__java_util_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String_Date_Date_: - -.. _io_realm_RealmQuery_between_java_lang_String__Date__Date_: - -.. _io_realm_RealmQuery_between_String_java_util_Date_java_util_Date_: - -.. _io_realm_RealmQuery_between_String__java_util_Date__java_util_Date_: - -.. _io_realm_RealmQuery_between_String_java_util_Date_Date_: - -.. _io_realm_RealmQuery_between_String__java_util_Date__Date_: - -.. _io_realm_RealmQuery_between_String_Date_java_util_Date_: - -.. _io_realm_RealmQuery_between_String__Date__java_util_Date_: - -.. _io_realm_RealmQuery_between_String_Date_Date_: - -.. _io_realm_RealmQuery_between_String__Date__Date_: - -.. _between_java_lang_String_java_util_Date_java_util_Date_: - -.. _between_java_lang_String__java_util_Date__java_util_Date_: - -.. _between_java_lang_String_java_util_Date_Date_: - -.. _between_java_lang_String__java_util_Date__Date_: - -.. _between_java_lang_String_Date_java_util_Date_: - -.. _between_java_lang_String__Date__java_util_Date_: - -.. _between_java_lang_String_Date_Date_: - -.. _between_java_lang_String__Date__Date_: - -.. _between_String_java_util_Date_java_util_Date_: - -.. _between_String__java_util_Date__java_util_Date_: - -.. _between_String_java_util_Date_Date_: - -.. _between_String__java_util_Date__Date_: - -.. _between_String_Date_java_util_Date_: - -.. _between_String__Date__java_util_Date_: - -.. _between_String_Date_Date_: - -.. _between_String__Date__Date_: - -.. _RealmQuery_between_java_lang_String_java_util_Date_java_util_Date_: - -.. _RealmQuery_between_java_lang_String__java_util_Date__java_util_Date_: - -.. _RealmQuery_between_java_lang_String_java_util_Date_Date_: - -.. _RealmQuery_between_java_lang_String__java_util_Date__Date_: - -.. _RealmQuery_between_java_lang_String_Date_java_util_Date_: - -.. _RealmQuery_between_java_lang_String__Date__java_util_Date_: - -.. _RealmQuery_between_java_lang_String_Date_Date_: - -.. _RealmQuery_between_java_lang_String__Date__Date_: - -.. _RealmQuery_between_String_java_util_Date_java_util_Date_: - -.. _RealmQuery_between_String__java_util_Date__java_util_Date_: - -.. _RealmQuery_between_String_java_util_Date_Date_: - -.. _RealmQuery_between_String__java_util_Date__Date_: - -.. _RealmQuery_between_String_Date_java_util_Date_: - -.. _RealmQuery_between_String__Date__java_util_Date_: - -.. _RealmQuery_between_String_Date_Date_: - -.. _RealmQuery_between_String__Date__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | `Date `__ from, - | `Date `__ to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_float_float_: - -.. _io_realm_RealmQuery_between_java_lang_String__float__float_: - -.. _io_realm_RealmQuery_between_String_float_float_: - -.. _io_realm_RealmQuery_between_String__float__float_: - -.. _between_java_lang_String_float_float_: - -.. _between_java_lang_String__float__float_: - -.. _between_String_float_float_: - -.. _between_String__float__float_: - -.. _RealmQuery_between_java_lang_String_float_float_: - -.. _RealmQuery_between_java_lang_String__float__float_: - -.. _RealmQuery_between_String_float_float_: - -.. _RealmQuery_between_String__float__float_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | **float** from, - | **float** to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_double_double_: - -.. _io_realm_RealmQuery_between_java_lang_String__double__double_: - -.. _io_realm_RealmQuery_between_String_double_double_: - -.. _io_realm_RealmQuery_between_String__double__double_: - -.. _between_java_lang_String_double_double_: - -.. _between_java_lang_String__double__double_: - -.. _between_String_double_double_: - -.. _between_String__double__double_: - -.. _RealmQuery_between_java_lang_String_double_double_: - -.. _RealmQuery_between_java_lang_String__double__double_: - -.. _RealmQuery_between_String_double_double_: - -.. _RealmQuery_between_String__double__double_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | **double** from, - | **double** to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_long_long_: - -.. _io_realm_RealmQuery_between_java_lang_String__long__long_: - -.. _io_realm_RealmQuery_between_String_long_long_: - -.. _io_realm_RealmQuery_between_String__long__long_: - -.. _between_java_lang_String_long_long_: - -.. _between_java_lang_String__long__long_: - -.. _between_String_long_long_: - -.. _between_String__long__long_: - -.. _RealmQuery_between_java_lang_String_long_long_: - -.. _RealmQuery_between_java_lang_String__long__long_: - -.. _RealmQuery_between_String_long_long_: - -.. _RealmQuery_between_String__long__long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | **long** from, - | **long** to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_between_java_lang_String_int_int_: - -.. _io_realm_RealmQuery_between_java_lang_String__int__int_: - -.. _io_realm_RealmQuery_between_String_int_int_: - -.. _io_realm_RealmQuery_between_String__int__int_: - -.. _between_java_lang_String_int_int_: - -.. _between_java_lang_String__int__int_: - -.. _between_String_int_int_: - -.. _between_String__int__int_: - -.. _RealmQuery_between_java_lang_String_int_int_: - -.. _RealmQuery_between_java_lang_String__int__int_: - -.. _RealmQuery_between_String_int_int_: - -.. _RealmQuery_between_String__int__int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`between ` ( - | `String `__ fieldName, - | **int** from, - | **int** to - | ) - - - - - * - Between condition. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``from`` - lowest value (inclusive). - - - - - ``to`` - highest value (inclusive). - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _contains: - -.. _contains__: - -.. _RealmQuery_contains: - -.. _RealmQuery_contains__: - -.. _io_realm_RealmQuery_contains: - -.. _io_realm_RealmQuery_contains__: - - - -contains --------- - -.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_contains_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_contains_String__RealmAny__Case_: - -.. _contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _contains_java_lang_String_io_realm_RealmAny_Case_: - -.. _contains_java_lang_String__io_realm_RealmAny__Case_: - -.. _contains_java_lang_String_RealmAny_io_realm_Case_: - -.. _contains_java_lang_String__RealmAny__io_realm_Case_: - -.. _contains_java_lang_String_RealmAny_Case_: - -.. _contains_java_lang_String__RealmAny__Case_: - -.. _contains_String_io_realm_RealmAny_io_realm_Case_: - -.. _contains_String__io_realm_RealmAny__io_realm_Case_: - -.. _contains_String_io_realm_RealmAny_Case_: - -.. _contains_String__io_realm_RealmAny__Case_: - -.. _contains_String_RealmAny_io_realm_Case_: - -.. _contains_String__RealmAny__io_realm_Case_: - -.. _contains_String_RealmAny_Case_: - -.. _contains_String__RealmAny__Case_: - -.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_contains_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_contains_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_contains_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_contains_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_contains_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_contains_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_contains_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_contains_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_contains_String_RealmAny_Case_: - -.. _RealmQuery_contains_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that value of field contains the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - The query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_contains_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_contains_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_contains_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_contains_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_contains_String_String_Case_: - -.. _io_realm_RealmQuery_contains_String__String__Case_: - -.. _contains_java_lang_String_java_lang_String_io_realm_Case_: - -.. _contains_java_lang_String__java_lang_String__io_realm_Case_: - -.. _contains_java_lang_String_java_lang_String_Case_: - -.. _contains_java_lang_String__java_lang_String__Case_: - -.. _contains_java_lang_String_String_io_realm_Case_: - -.. _contains_java_lang_String__String__io_realm_Case_: - -.. _contains_java_lang_String_String_Case_: - -.. _contains_java_lang_String__String__Case_: - -.. _contains_String_java_lang_String_io_realm_Case_: - -.. _contains_String__java_lang_String__io_realm_Case_: - -.. _contains_String_java_lang_String_Case_: - -.. _contains_String__java_lang_String__Case_: - -.. _contains_String_String_io_realm_Case_: - -.. _contains_String__String__io_realm_Case_: - -.. _contains_String_String_Case_: - -.. _contains_String__String__Case_: - -.. _RealmQuery_contains_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_contains_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_contains_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_contains_java_lang_String_String_Case_: - -.. _RealmQuery_contains_java_lang_String__String__Case_: - -.. _RealmQuery_contains_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_contains_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_contains_String_java_lang_String_Case_: - -.. _RealmQuery_contains_String__java_lang_String__Case_: - -.. _RealmQuery_contains_String_String_io_realm_Case_: - -.. _RealmQuery_contains_String__String__io_realm_Case_: - -.. _RealmQuery_contains_String_String_Case_: - -.. _RealmQuery_contains_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that value of field contains the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - The query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_contains_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_contains_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_contains_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_contains_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_contains_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_contains_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_contains_String_RealmAny_: - -.. _io_realm_RealmQuery_contains_String__RealmAny_: - -.. _contains_java_lang_String_io_realm_RealmAny_: - -.. _contains_java_lang_String__io_realm_RealmAny_: - -.. _contains_java_lang_String_RealmAny_: - -.. _contains_java_lang_String__RealmAny_: - -.. _contains_String_io_realm_RealmAny_: - -.. _contains_String__io_realm_RealmAny_: - -.. _contains_String_RealmAny_: - -.. _contains_String__RealmAny_: - -.. _RealmQuery_contains_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_contains_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_contains_java_lang_String_RealmAny_: - -.. _RealmQuery_contains_java_lang_String__RealmAny_: - -.. _RealmQuery_contains_String_io_realm_RealmAny_: - -.. _RealmQuery_contains_String__io_realm_RealmAny_: - -.. _RealmQuery_contains_String_RealmAny_: - -.. _RealmQuery_contains_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Condition that value of field contains the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_contains_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_contains_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_contains_java_lang_String_String_: - -.. _io_realm_RealmQuery_contains_java_lang_String__String_: - -.. _io_realm_RealmQuery_contains_String_java_lang_String_: - -.. _io_realm_RealmQuery_contains_String__java_lang_String_: - -.. _io_realm_RealmQuery_contains_String_String_: - -.. _io_realm_RealmQuery_contains_String__String_: - -.. _contains_java_lang_String_java_lang_String_: - -.. _contains_java_lang_String__java_lang_String_: - -.. _contains_java_lang_String_String_: - -.. _contains_java_lang_String__String_: - -.. _contains_String_java_lang_String_: - -.. _contains_String__java_lang_String_: - -.. _contains_String_String_: - -.. _contains_String__String_: - -.. _RealmQuery_contains_java_lang_String_java_lang_String_: - -.. _RealmQuery_contains_java_lang_String__java_lang_String_: - -.. _RealmQuery_contains_java_lang_String_String_: - -.. _RealmQuery_contains_java_lang_String__String_: - -.. _RealmQuery_contains_String_java_lang_String_: - -.. _RealmQuery_contains_String__java_lang_String_: - -.. _RealmQuery_contains_String_String_: - -.. _RealmQuery_contains_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`contains ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Condition that value of field contains the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _containsEntry: - -.. _containsEntry__: - -.. _RealmQuery_containsEntry: - -.. _RealmQuery_containsEntry__: - -.. _io_realm_RealmQuery_containsEntry: - -.. _io_realm_RealmQuery_containsEntry__: - - - -containsEntry -------------- - -.. _io_realm_RealmQuery_containsEntry_java_lang_String_java_util_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_java_lang_String__java_util_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_java_lang_String_Entry_: - -.. _io_realm_RealmQuery_containsEntry_java_lang_String__Entry_: - -.. _io_realm_RealmQuery_containsEntry_java_lang_String_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_java_lang_String__Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String_java_util_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String__java_util_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String__Entry_: - -.. _io_realm_RealmQuery_containsEntry_String_Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String__Map_Entry_: - -.. _containsEntry_java_lang_String_java_util_Map_Entry_: - -.. _containsEntry_java_lang_String__java_util_Map_Entry_: - -.. _containsEntry_java_lang_String_Entry_: - -.. _containsEntry_java_lang_String__Entry_: - -.. _containsEntry_java_lang_String_Map_Entry_: - -.. _containsEntry_java_lang_String__Map_Entry_: - -.. _containsEntry_String_java_util_Map_Entry_: - -.. _containsEntry_String__java_util_Map_Entry_: - -.. _containsEntry_String_Entry_: - -.. _containsEntry_String__Entry_: - -.. _containsEntry_String_Map_Entry_: - -.. _containsEntry_String__Map_Entry_: - -.. _RealmQuery_containsEntry_java_lang_String_java_util_Map_Entry_: - -.. _RealmQuery_containsEntry_java_lang_String__java_util_Map_Entry_: - -.. _RealmQuery_containsEntry_java_lang_String_Entry_: - -.. _RealmQuery_containsEntry_java_lang_String__Entry_: - -.. _RealmQuery_containsEntry_java_lang_String_Map_Entry_: - -.. _RealmQuery_containsEntry_java_lang_String__Map_Entry_: - -.. _RealmQuery_containsEntry_String_java_util_Map_Entry_: - -.. _RealmQuery_containsEntry_String__java_util_Map_Entry_: - -.. _RealmQuery_containsEntry_String_Entry_: - -.. _RealmQuery_containsEntry_String__Entry_: - -.. _RealmQuery_containsEntry_String_Map_Entry_: - -.. _RealmQuery_containsEntry_String__Map_Entry_: - -.. _io_realm_RealmQuery_containsEntry_String__Map_Entry_String_____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsEntry ` ( - | `String `__ fieldName, - | `java.util.Map.Entry\ `__ entry - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified entry. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``entry`` - the entry to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - - - -.. _containsKey: - -.. _containsKey__: - -.. _RealmQuery_containsKey: - -.. _RealmQuery_containsKey__: - -.. _io_realm_RealmQuery_containsKey: - -.. _io_realm_RealmQuery_containsKey__: - - - -containsKey ------------ - -.. _io_realm_RealmQuery_containsKey_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_containsKey_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_containsKey_java_lang_String_String_: - -.. _io_realm_RealmQuery_containsKey_java_lang_String__String_: - -.. _io_realm_RealmQuery_containsKey_String_java_lang_String_: - -.. _io_realm_RealmQuery_containsKey_String__java_lang_String_: - -.. _io_realm_RealmQuery_containsKey_String_String_: - -.. _io_realm_RealmQuery_containsKey_String__String_: - -.. _containsKey_java_lang_String_java_lang_String_: - -.. _containsKey_java_lang_String__java_lang_String_: - -.. _containsKey_java_lang_String_String_: - -.. _containsKey_java_lang_String__String_: - -.. _containsKey_String_java_lang_String_: - -.. _containsKey_String__java_lang_String_: - -.. _containsKey_String_String_: - -.. _containsKey_String__String_: - -.. _RealmQuery_containsKey_java_lang_String_java_lang_String_: - -.. _RealmQuery_containsKey_java_lang_String__java_lang_String_: - -.. _RealmQuery_containsKey_java_lang_String_String_: - -.. _RealmQuery_containsKey_java_lang_String__String_: - -.. _RealmQuery_containsKey_String_java_lang_String_: - -.. _RealmQuery_containsKey_String__java_lang_String_: - -.. _RealmQuery_containsKey_String_String_: - -.. _RealmQuery_containsKey_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsKey ` ( - | `String `__ fieldName, - | `String `__ key - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified key. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``key`` - the key to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - - - -.. _containsValue: - -.. _containsValue__: - -.. _RealmQuery_containsValue: - -.. _RealmQuery_containsValue__: - -.. _io_realm_RealmQuery_containsValue: - -.. _io_realm_RealmQuery_containsValue__: - - - -containsValue -------------- - -.. _io_realm_RealmQuery_containsValue_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_containsValue_String_ObjectId_: - -.. _io_realm_RealmQuery_containsValue_String__ObjectId_: - -.. _containsValue_java_lang_String_ObjectId_: - -.. _containsValue_java_lang_String__ObjectId_: - -.. _containsValue_String_ObjectId_: - -.. _containsValue_String__ObjectId_: - -.. _RealmQuery_containsValue_java_lang_String_ObjectId_: - -.. _RealmQuery_containsValue_java_lang_String__ObjectId_: - -.. _RealmQuery_containsValue_String_ObjectId_: - -.. _RealmQuery_containsValue_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_containsValue_String_Decimal128_: - -.. _io_realm_RealmQuery_containsValue_String__Decimal128_: - -.. _containsValue_java_lang_String_Decimal128_: - -.. _containsValue_java_lang_String__Decimal128_: - -.. _containsValue_String_Decimal128_: - -.. _containsValue_String__Decimal128_: - -.. _RealmQuery_containsValue_java_lang_String_Decimal128_: - -.. _RealmQuery_containsValue_java_lang_String__Decimal128_: - -.. _RealmQuery_containsValue_String_Decimal128_: - -.. _RealmQuery_containsValue_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_util_Date_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_util_Date_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Date_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Date_: - -.. _io_realm_RealmQuery_containsValue_String_java_util_Date_: - -.. _io_realm_RealmQuery_containsValue_String__java_util_Date_: - -.. _io_realm_RealmQuery_containsValue_String_Date_: - -.. _io_realm_RealmQuery_containsValue_String__Date_: - -.. _containsValue_java_lang_String_java_util_Date_: - -.. _containsValue_java_lang_String__java_util_Date_: - -.. _containsValue_java_lang_String_Date_: - -.. _containsValue_java_lang_String__Date_: - -.. _containsValue_String_java_util_Date_: - -.. _containsValue_String__java_util_Date_: - -.. _containsValue_String_Date_: - -.. _containsValue_String__Date_: - -.. _RealmQuery_containsValue_java_lang_String_java_util_Date_: - -.. _RealmQuery_containsValue_java_lang_String__java_util_Date_: - -.. _RealmQuery_containsValue_java_lang_String_Date_: - -.. _RealmQuery_containsValue_java_lang_String__Date_: - -.. _RealmQuery_containsValue_String_java_util_Date_: - -.. _RealmQuery_containsValue_String__java_util_Date_: - -.. _RealmQuery_containsValue_String_Date_: - -.. _RealmQuery_containsValue_String__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_byte_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__byte_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_byte____: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__byte____: - -.. _io_realm_RealmQuery_containsValue_String_byte_: - -.. _io_realm_RealmQuery_containsValue_String__byte_: - -.. _io_realm_RealmQuery_containsValue_String_byte____: - -.. _io_realm_RealmQuery_containsValue_String__byte____: - -.. _containsValue_java_lang_String_byte_: - -.. _containsValue_java_lang_String__byte_: - -.. _containsValue_java_lang_String_byte____: - -.. _containsValue_java_lang_String__byte____: - -.. _containsValue_String_byte_: - -.. _containsValue_String__byte_: - -.. _containsValue_String_byte____: - -.. _containsValue_String__byte____: - -.. _RealmQuery_containsValue_java_lang_String_byte_: - -.. _RealmQuery_containsValue_java_lang_String__byte_: - -.. _RealmQuery_containsValue_java_lang_String_byte____: - -.. _RealmQuery_containsValue_java_lang_String__byte____: - -.. _RealmQuery_containsValue_String_byte_: - -.. _RealmQuery_containsValue_String__byte_: - -.. _RealmQuery_containsValue_String_byte____: - -.. _RealmQuery_containsValue_String__byte____: - -.. _io_realm_RealmQuery_containsValue_String__byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_String_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__String_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_String_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_String_: - -.. _io_realm_RealmQuery_containsValue_String_String_: - -.. _io_realm_RealmQuery_containsValue_String__String_: - -.. _containsValue_java_lang_String_java_lang_String_: - -.. _containsValue_java_lang_String__java_lang_String_: - -.. _containsValue_java_lang_String_String_: - -.. _containsValue_java_lang_String__String_: - -.. _containsValue_String_java_lang_String_: - -.. _containsValue_String__java_lang_String_: - -.. _containsValue_String_String_: - -.. _containsValue_String__String_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_String_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_String_: - -.. _RealmQuery_containsValue_java_lang_String_String_: - -.. _RealmQuery_containsValue_java_lang_String__String_: - -.. _RealmQuery_containsValue_String_java_lang_String_: - -.. _RealmQuery_containsValue_String__java_lang_String_: - -.. _RealmQuery_containsValue_String_String_: - -.. _RealmQuery_containsValue_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Float_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Float_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Float_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Float_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Float_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Float_: - -.. _io_realm_RealmQuery_containsValue_String_Float_: - -.. _io_realm_RealmQuery_containsValue_String__Float_: - -.. _containsValue_java_lang_String_java_lang_Float_: - -.. _containsValue_java_lang_String__java_lang_Float_: - -.. _containsValue_java_lang_String_Float_: - -.. _containsValue_java_lang_String__Float_: - -.. _containsValue_String_java_lang_Float_: - -.. _containsValue_String__java_lang_Float_: - -.. _containsValue_String_Float_: - -.. _containsValue_String__Float_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Float_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Float_: - -.. _RealmQuery_containsValue_java_lang_String_Float_: - -.. _RealmQuery_containsValue_java_lang_String__Float_: - -.. _RealmQuery_containsValue_String_java_lang_Float_: - -.. _RealmQuery_containsValue_String__java_lang_Float_: - -.. _RealmQuery_containsValue_String_Float_: - -.. _RealmQuery_containsValue_String__Float_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Float `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Double_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Double_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Double_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Double_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Double_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Double_: - -.. _io_realm_RealmQuery_containsValue_String_Double_: - -.. _io_realm_RealmQuery_containsValue_String__Double_: - -.. _containsValue_java_lang_String_java_lang_Double_: - -.. _containsValue_java_lang_String__java_lang_Double_: - -.. _containsValue_java_lang_String_Double_: - -.. _containsValue_java_lang_String__Double_: - -.. _containsValue_String_java_lang_Double_: - -.. _containsValue_String__java_lang_Double_: - -.. _containsValue_String_Double_: - -.. _containsValue_String__Double_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Double_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Double_: - -.. _RealmQuery_containsValue_java_lang_String_Double_: - -.. _RealmQuery_containsValue_java_lang_String__Double_: - -.. _RealmQuery_containsValue_String_java_lang_Double_: - -.. _RealmQuery_containsValue_String__java_lang_Double_: - -.. _RealmQuery_containsValue_String_Double_: - -.. _RealmQuery_containsValue_String__Double_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Double `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Long_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Long_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Long_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Long_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Long_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Long_: - -.. _io_realm_RealmQuery_containsValue_String_Long_: - -.. _io_realm_RealmQuery_containsValue_String__Long_: - -.. _containsValue_java_lang_String_java_lang_Long_: - -.. _containsValue_java_lang_String__java_lang_Long_: - -.. _containsValue_java_lang_String_Long_: - -.. _containsValue_java_lang_String__Long_: - -.. _containsValue_String_java_lang_Long_: - -.. _containsValue_String__java_lang_Long_: - -.. _containsValue_String_Long_: - -.. _containsValue_String__Long_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Long_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Long_: - -.. _RealmQuery_containsValue_java_lang_String_Long_: - -.. _RealmQuery_containsValue_java_lang_String__Long_: - -.. _RealmQuery_containsValue_String_java_lang_Long_: - -.. _RealmQuery_containsValue_String__java_lang_Long_: - -.. _RealmQuery_containsValue_String_Long_: - -.. _RealmQuery_containsValue_String__Long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Long `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Integer_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Integer_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Integer_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Integer_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Integer_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Integer_: - -.. _io_realm_RealmQuery_containsValue_String_Integer_: - -.. _io_realm_RealmQuery_containsValue_String__Integer_: - -.. _containsValue_java_lang_String_java_lang_Integer_: - -.. _containsValue_java_lang_String__java_lang_Integer_: - -.. _containsValue_java_lang_String_Integer_: - -.. _containsValue_java_lang_String__Integer_: - -.. _containsValue_String_java_lang_Integer_: - -.. _containsValue_String__java_lang_Integer_: - -.. _containsValue_String_Integer_: - -.. _containsValue_String__Integer_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Integer_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Integer_: - -.. _RealmQuery_containsValue_java_lang_String_Integer_: - -.. _RealmQuery_containsValue_java_lang_String__Integer_: - -.. _RealmQuery_containsValue_String_java_lang_Integer_: - -.. _RealmQuery_containsValue_String__java_lang_Integer_: - -.. _RealmQuery_containsValue_String_Integer_: - -.. _RealmQuery_containsValue_String__Integer_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Integer `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Short_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Short_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Short_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Short_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Short_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Short_: - -.. _io_realm_RealmQuery_containsValue_String_Short_: - -.. _io_realm_RealmQuery_containsValue_String__Short_: - -.. _containsValue_java_lang_String_java_lang_Short_: - -.. _containsValue_java_lang_String__java_lang_Short_: - -.. _containsValue_java_lang_String_Short_: - -.. _containsValue_java_lang_String__Short_: - -.. _containsValue_String_java_lang_Short_: - -.. _containsValue_String__java_lang_Short_: - -.. _containsValue_String_Short_: - -.. _containsValue_String__Short_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Short_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Short_: - -.. _RealmQuery_containsValue_java_lang_String_Short_: - -.. _RealmQuery_containsValue_java_lang_String__Short_: - -.. _RealmQuery_containsValue_String_java_lang_Short_: - -.. _RealmQuery_containsValue_String__java_lang_Short_: - -.. _RealmQuery_containsValue_String_Short_: - -.. _RealmQuery_containsValue_String__Short_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Short `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Byte_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Byte_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Byte_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Byte_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Byte_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Byte_: - -.. _io_realm_RealmQuery_containsValue_String_Byte_: - -.. _io_realm_RealmQuery_containsValue_String__Byte_: - -.. _containsValue_java_lang_String_java_lang_Byte_: - -.. _containsValue_java_lang_String__java_lang_Byte_: - -.. _containsValue_java_lang_String_Byte_: - -.. _containsValue_java_lang_String__Byte_: - -.. _containsValue_String_java_lang_Byte_: - -.. _containsValue_String__java_lang_Byte_: - -.. _containsValue_String_Byte_: - -.. _containsValue_String__Byte_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Byte_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Byte_: - -.. _RealmQuery_containsValue_java_lang_String_Byte_: - -.. _RealmQuery_containsValue_java_lang_String__Byte_: - -.. _RealmQuery_containsValue_String_java_lang_Byte_: - -.. _RealmQuery_containsValue_String__java_lang_Byte_: - -.. _RealmQuery_containsValue_String_Byte_: - -.. _RealmQuery_containsValue_String__Byte_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Byte `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - -.. _io_realm_RealmQuery_containsValue_java_lang_String_java_lang_Boolean_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__java_lang_Boolean_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String_Boolean_: - -.. _io_realm_RealmQuery_containsValue_java_lang_String__Boolean_: - -.. _io_realm_RealmQuery_containsValue_String_java_lang_Boolean_: - -.. _io_realm_RealmQuery_containsValue_String__java_lang_Boolean_: - -.. _io_realm_RealmQuery_containsValue_String_Boolean_: - -.. _io_realm_RealmQuery_containsValue_String__Boolean_: - -.. _containsValue_java_lang_String_java_lang_Boolean_: - -.. _containsValue_java_lang_String__java_lang_Boolean_: - -.. _containsValue_java_lang_String_Boolean_: - -.. _containsValue_java_lang_String__Boolean_: - -.. _containsValue_String_java_lang_Boolean_: - -.. _containsValue_String__java_lang_Boolean_: - -.. _containsValue_String_Boolean_: - -.. _containsValue_String__Boolean_: - -.. _RealmQuery_containsValue_java_lang_String_java_lang_Boolean_: - -.. _RealmQuery_containsValue_java_lang_String__java_lang_Boolean_: - -.. _RealmQuery_containsValue_java_lang_String_Boolean_: - -.. _RealmQuery_containsValue_java_lang_String__Boolean_: - -.. _RealmQuery_containsValue_String_java_lang_Boolean_: - -.. _RealmQuery_containsValue_String__java_lang_Boolean_: - -.. _RealmQuery_containsValue_String_Boolean_: - -.. _RealmQuery_containsValue_String__Boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`containsValue ` ( - | `String `__ fieldName, - | `Boolean `__ value - | ) - - - - - * - Condition that value, if a dictionary field, contains the specified value. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to search for. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid. - - - - - - - - - - - - -.. _count: - -.. _count__: - -.. _RealmQuery_count: - -.. _RealmQuery_count__: - -.. _io_realm_RealmQuery_count: - -.. _io_realm_RealmQuery_count__: - - - -count ------ - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`count ` () - | - - - - - * - Counts the number of objects that fulfill the query conditions. - - - - - - - **Returns** - - the number of matching objects. - - - - - **Throws** - - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _distinct: - -.. _distinct__: - -.. _RealmQuery_distinct: - -.. _RealmQuery_distinct__: - -.. _io_realm_RealmQuery_distinct: - -.. _io_realm_RealmQuery_distinct__: - - - -distinct --------- - -.. _io_realm_RealmQuery_distinct_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_distinct_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_distinct_java_lang_String_String_: - -.. _io_realm_RealmQuery_distinct_java_lang_String__String_: - -.. _io_realm_RealmQuery_distinct_java_lang_String_String____: - -.. _io_realm_RealmQuery_distinct_java_lang_String__String____: - -.. _io_realm_RealmQuery_distinct_String_java_lang_String_: - -.. _io_realm_RealmQuery_distinct_String__java_lang_String_: - -.. _io_realm_RealmQuery_distinct_String_String_: - -.. _io_realm_RealmQuery_distinct_String__String_: - -.. _io_realm_RealmQuery_distinct_String_String____: - -.. _io_realm_RealmQuery_distinct_String__String____: - -.. _distinct_java_lang_String_java_lang_String_: - -.. _distinct_java_lang_String__java_lang_String_: - -.. _distinct_java_lang_String_String_: - -.. _distinct_java_lang_String__String_: - -.. _distinct_java_lang_String_String____: - -.. _distinct_java_lang_String__String____: - -.. _distinct_String_java_lang_String_: - -.. _distinct_String__java_lang_String_: - -.. _distinct_String_String_: - -.. _distinct_String__String_: - -.. _distinct_String_String____: - -.. _distinct_String__String____: - -.. _RealmQuery_distinct_java_lang_String_java_lang_String_: - -.. _RealmQuery_distinct_java_lang_String__java_lang_String_: - -.. _RealmQuery_distinct_java_lang_String_String_: - -.. _RealmQuery_distinct_java_lang_String__String_: - -.. _RealmQuery_distinct_java_lang_String_String____: - -.. _RealmQuery_distinct_java_lang_String__String____: - -.. _RealmQuery_distinct_String_java_lang_String_: - -.. _RealmQuery_distinct_String__java_lang_String_: - -.. _RealmQuery_distinct_String_String_: - -.. _RealmQuery_distinct_String__String_: - -.. _RealmQuery_distinct_String_String____: - -.. _RealmQuery_distinct_String__String____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`distinct ` ( - | `String `__ firstFieldName, - | `java.lang.String[] `__ remainingFieldNames - | ) - - - - - * - Selects a distinct set of objects of a specific class. When multiple distinct fields are given, all unique combinations of values in the fields will be returned. In case of multiple matches, it is undefined which object is returned. Unless the result is sorted, then the first object will be returned. - - - - - **Parameters** - - - ``firstFieldName`` - first field name to use when finding distinct objects. - - - - - ``remainingFieldNames`` - remaining field names when determining all unique combinations of field values. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field names is empty or ``null`` , does not exist, is an unsupported type, or points to a linked field. - - - - - - - `IllegalStateException `__ - if distinct field names were already defined. - - - - - - - - - - - - -.. _endGroup: - -.. _endGroup__: - -.. _RealmQuery_endGroup: - -.. _RealmQuery_endGroup__: - -.. _io_realm_RealmQuery_endGroup: - -.. _io_realm_RealmQuery_endGroup__: - - - -endGroup --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`endGroup ` () - | - - - - - * - End grouping of conditions ("right parenthesis") which was opened by a call to ``beginGroup()`` . - - - - - - - - - **Returns** - - the query object. - - - - - - - - - .. seealso:: - - - - - :ref:`beginGroup() ` - - - - - - - - - - - - -.. _endsWith: - -.. _endsWith__: - -.. _RealmQuery_endsWith: - -.. _RealmQuery_endsWith__: - -.. _io_realm_RealmQuery_endsWith: - -.. _io_realm_RealmQuery_endsWith__: - - - -endsWith --------- - -.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_endsWith_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_endsWith_String__RealmAny__Case_: - -.. _endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _endsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _endsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _endsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _endsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _endsWith_java_lang_String_RealmAny_Case_: - -.. _endsWith_java_lang_String__RealmAny__Case_: - -.. _endsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _endsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _endsWith_String_io_realm_RealmAny_Case_: - -.. _endsWith_String__io_realm_RealmAny__Case_: - -.. _endsWith_String_RealmAny_io_realm_Case_: - -.. _endsWith_String__RealmAny__io_realm_Case_: - -.. _endsWith_String_RealmAny_Case_: - -.. _endsWith_String__RealmAny__Case_: - -.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_endsWith_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_endsWith_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_endsWith_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_endsWith_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_endsWith_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_endsWith_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_endsWith_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_endsWith_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_endsWith_String_RealmAny_Case_: - -.. _RealmQuery_endsWith_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field ends with the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_endsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_endsWith_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_endsWith_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_endsWith_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_endsWith_String_String_Case_: - -.. _io_realm_RealmQuery_endsWith_String__String__Case_: - -.. _endsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _endsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _endsWith_java_lang_String_java_lang_String_Case_: - -.. _endsWith_java_lang_String__java_lang_String__Case_: - -.. _endsWith_java_lang_String_String_io_realm_Case_: - -.. _endsWith_java_lang_String__String__io_realm_Case_: - -.. _endsWith_java_lang_String_String_Case_: - -.. _endsWith_java_lang_String__String__Case_: - -.. _endsWith_String_java_lang_String_io_realm_Case_: - -.. _endsWith_String__java_lang_String__io_realm_Case_: - -.. _endsWith_String_java_lang_String_Case_: - -.. _endsWith_String__java_lang_String__Case_: - -.. _endsWith_String_String_io_realm_Case_: - -.. _endsWith_String__String__io_realm_Case_: - -.. _endsWith_String_String_Case_: - -.. _endsWith_String__String__Case_: - -.. _RealmQuery_endsWith_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_endsWith_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_endsWith_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_endsWith_java_lang_String_String_Case_: - -.. _RealmQuery_endsWith_java_lang_String__String__Case_: - -.. _RealmQuery_endsWith_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_endsWith_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_endsWith_String_java_lang_String_Case_: - -.. _RealmQuery_endsWith_String__java_lang_String__Case_: - -.. _RealmQuery_endsWith_String_String_io_realm_Case_: - -.. _RealmQuery_endsWith_String__String__io_realm_Case_: - -.. _RealmQuery_endsWith_String_String_Case_: - -.. _RealmQuery_endsWith_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field ends with the specified substring. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the substring. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_endsWith_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_String_RealmAny_: - -.. _io_realm_RealmQuery_endsWith_String__RealmAny_: - -.. _endsWith_java_lang_String_io_realm_RealmAny_: - -.. _endsWith_java_lang_String__io_realm_RealmAny_: - -.. _endsWith_java_lang_String_RealmAny_: - -.. _endsWith_java_lang_String__RealmAny_: - -.. _endsWith_String_io_realm_RealmAny_: - -.. _endsWith_String__io_realm_RealmAny_: - -.. _endsWith_String_RealmAny_: - -.. _endsWith_String__RealmAny_: - -.. _RealmQuery_endsWith_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_endsWith_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_endsWith_java_lang_String_RealmAny_: - -.. _RealmQuery_endsWith_java_lang_String__RealmAny_: - -.. _RealmQuery_endsWith_String_io_realm_RealmAny_: - -.. _RealmQuery_endsWith_String__io_realm_RealmAny_: - -.. _RealmQuery_endsWith_String_RealmAny_: - -.. _RealmQuery_endsWith_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Condition that the value of field ends with the specified string. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_endsWith_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String_String_: - -.. _io_realm_RealmQuery_endsWith_java_lang_String__String_: - -.. _io_realm_RealmQuery_endsWith_String_java_lang_String_: - -.. _io_realm_RealmQuery_endsWith_String__java_lang_String_: - -.. _io_realm_RealmQuery_endsWith_String_String_: - -.. _io_realm_RealmQuery_endsWith_String__String_: - -.. _endsWith_java_lang_String_java_lang_String_: - -.. _endsWith_java_lang_String__java_lang_String_: - -.. _endsWith_java_lang_String_String_: - -.. _endsWith_java_lang_String__String_: - -.. _endsWith_String_java_lang_String_: - -.. _endsWith_String__java_lang_String_: - -.. _endsWith_String_String_: - -.. _endsWith_String__String_: - -.. _RealmQuery_endsWith_java_lang_String_java_lang_String_: - -.. _RealmQuery_endsWith_java_lang_String__java_lang_String_: - -.. _RealmQuery_endsWith_java_lang_String_String_: - -.. _RealmQuery_endsWith_java_lang_String__String_: - -.. _RealmQuery_endsWith_String_java_lang_String_: - -.. _RealmQuery_endsWith_String__java_lang_String_: - -.. _RealmQuery_endsWith_String_String_: - -.. _RealmQuery_endsWith_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`endsWith ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Condition that the value of field ends with the specified string. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _equalTo: - -.. _equalTo__: - -.. _RealmQuery_equalTo: - -.. _RealmQuery_equalTo__: - -.. _io_realm_RealmQuery_equalTo: - -.. _io_realm_RealmQuery_equalTo__: - - - -equalTo -------- - -.. _io_realm_RealmQuery_equalTo_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_equalTo_String_ObjectId_: - -.. _io_realm_RealmQuery_equalTo_String__ObjectId_: - -.. _equalTo_java_lang_String_ObjectId_: - -.. _equalTo_java_lang_String__ObjectId_: - -.. _equalTo_String_ObjectId_: - -.. _equalTo_String__ObjectId_: - -.. _RealmQuery_equalTo_java_lang_String_ObjectId_: - -.. _RealmQuery_equalTo_java_lang_String__ObjectId_: - -.. _RealmQuery_equalTo_String_ObjectId_: - -.. _RealmQuery_equalTo_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_equalTo_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_equalTo_String_Decimal128_: - -.. _io_realm_RealmQuery_equalTo_String__Decimal128_: - -.. _equalTo_java_lang_String_Decimal128_: - -.. _equalTo_java_lang_String__Decimal128_: - -.. _equalTo_String_Decimal128_: - -.. _equalTo_String__Decimal128_: - -.. _RealmQuery_equalTo_java_lang_String_Decimal128_: - -.. _RealmQuery_equalTo_java_lang_String__Decimal128_: - -.. _RealmQuery_equalTo_String_Decimal128_: - -.. _RealmQuery_equalTo_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_equalTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_equalTo_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_equalTo_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_equalTo_String__RealmAny__Case_: - -.. _equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _equalTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _equalTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _equalTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _equalTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _equalTo_java_lang_String_RealmAny_Case_: - -.. _equalTo_java_lang_String__RealmAny__Case_: - -.. _equalTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _equalTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _equalTo_String_io_realm_RealmAny_Case_: - -.. _equalTo_String__io_realm_RealmAny__Case_: - -.. _equalTo_String_RealmAny_io_realm_Case_: - -.. _equalTo_String__RealmAny__io_realm_Case_: - -.. _equalTo_String_RealmAny_Case_: - -.. _equalTo_String__RealmAny__Case_: - -.. _RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_equalTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_equalTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_equalTo_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_equalTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_equalTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_equalTo_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_equalTo_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_equalTo_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_equalTo_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_equalTo_String_RealmAny_Case_: - -.. _RealmQuery_equalTo_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_equalTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_equalTo_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_equalTo_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_equalTo_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_equalTo_String_String_Case_: - -.. _io_realm_RealmQuery_equalTo_String__String__Case_: - -.. _equalTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _equalTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _equalTo_java_lang_String_java_lang_String_Case_: - -.. _equalTo_java_lang_String__java_lang_String__Case_: - -.. _equalTo_java_lang_String_String_io_realm_Case_: - -.. _equalTo_java_lang_String__String__io_realm_Case_: - -.. _equalTo_java_lang_String_String_Case_: - -.. _equalTo_java_lang_String__String__Case_: - -.. _equalTo_String_java_lang_String_io_realm_Case_: - -.. _equalTo_String__java_lang_String__io_realm_Case_: - -.. _equalTo_String_java_lang_String_Case_: - -.. _equalTo_String__java_lang_String__Case_: - -.. _equalTo_String_String_io_realm_Case_: - -.. _equalTo_String__String__io_realm_Case_: - -.. _equalTo_String_String_Case_: - -.. _equalTo_String__String__Case_: - -.. _RealmQuery_equalTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_equalTo_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_equalTo_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_equalTo_java_lang_String_String_Case_: - -.. _RealmQuery_equalTo_java_lang_String__String__Case_: - -.. _RealmQuery_equalTo_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_equalTo_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_equalTo_String_java_lang_String_Case_: - -.. _RealmQuery_equalTo_String__java_lang_String__Case_: - -.. _RealmQuery_equalTo_String_String_io_realm_Case_: - -.. _RealmQuery_equalTo_String__String__io_realm_Case_: - -.. _RealmQuery_equalTo_String_String_Case_: - -.. _RealmQuery_equalTo_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_equalTo_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String_String_: - -.. _io_realm_RealmQuery_equalTo_java_lang_String__String_: - -.. _io_realm_RealmQuery_equalTo_String_java_lang_String_: - -.. _io_realm_RealmQuery_equalTo_String__java_lang_String_: - -.. _io_realm_RealmQuery_equalTo_String_String_: - -.. _io_realm_RealmQuery_equalTo_String__String_: - -.. _equalTo_java_lang_String_java_lang_String_: - -.. _equalTo_java_lang_String__java_lang_String_: - -.. _equalTo_java_lang_String_String_: - -.. _equalTo_java_lang_String__String_: - -.. _equalTo_String_java_lang_String_: - -.. _equalTo_String__java_lang_String_: - -.. _equalTo_String_String_: - -.. _equalTo_String__String_: - -.. _RealmQuery_equalTo_java_lang_String_java_lang_String_: - -.. _RealmQuery_equalTo_java_lang_String__java_lang_String_: - -.. _RealmQuery_equalTo_java_lang_String_String_: - -.. _RealmQuery_equalTo_java_lang_String__String_: - -.. _RealmQuery_equalTo_String_java_lang_String_: - -.. _RealmQuery_equalTo_String__java_lang_String_: - -.. _RealmQuery_equalTo_String_String_: - -.. _RealmQuery_equalTo_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`equalTo ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _findAll: - -.. _findAll__: - -.. _RealmQuery_findAll: - -.. _RealmQuery_findAll__: - -.. _io_realm_RealmQuery_findAll: - -.. _io_realm_RealmQuery_findAll__: - - - -findAll -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`findAll ` () - | - - - - - * - Finds all objects that fulfill the query conditions.Launching heavy queries from the UI thread may result in a drop of frames or even ANRs. **We do not recommend doing so and therefore it is not allowed by default.** If you want to prevent these behaviors you can obtain a Realm using a :ref:`RealmConfiguration ` that explicitly sets :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` to ``false`` . This way you will be forced to launch your queries from a non-UI thread, otherwise calls to this method will throw a :ref:`RealmException ` . Alternatively, you can use :ref:`findAllAsync() ` . - - - - - - - - - - - **Returns** - - a :ref:`io.realm.RealmResults ` containing objects. If no objects match the condition, a list with zero objects is returned. - - - - - - - **Throws** - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmResults ` - - - - - - - - - - - - -.. _findAllAsync: - -.. _findAllAsync__: - -.. _RealmQuery_findAllAsync: - -.. _RealmQuery_findAllAsync__: - -.. _io_realm_RealmQuery_findAllAsync: - -.. _io_realm_RealmQuery_findAllAsync__: - - - -findAllAsync ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`findAllAsync ` () - | - - - - - * - Finds all objects that fulfill the query conditions. This method is only available from a Looper thread. - - - - - - - **Returns** - - immediately an empty :ref:`RealmResults ` . Users need to register a listener :ref:`io.realm.RealmResults.addChangeListener(RealmChangeListener) ` to be notified when the query completes. - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmResults ` - - - - - - - - - - - - -.. _findFirst: - -.. _findFirst__: - -.. _RealmQuery_findFirst: - -.. _RealmQuery_findFirst__: - -.. _io_realm_RealmQuery_findFirst: - -.. _io_realm_RealmQuery_findFirst__: - - - -findFirst ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`findFirst ` () - | - - - - - * - Finds the first object that fulfills the query conditions.Launching heavy queries from the UI thread may result in a drop of frames or even ANRs. **We do not recommend doing so, but it is allowed by default.** If you want to prevent these behaviors you can obtain a Realm using a :ref:`RealmConfiguration ` that explicitly sets :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` to ``false`` . This way you will be forced to launch your queries from a non-UI thread, otherwise calls to this method will throw a :ref:`RealmException ` . Alternatively, you can use :ref:`findFirstAsync() ` . - - - - - - - - - - - **Returns** - - the object found or ``null`` if no object matches the query conditions. - - - - - - - **Throws** - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmObject ` - - - - - - - - - - - - -.. _findFirstAsync: - -.. _findFirstAsync__: - -.. _RealmQuery_findFirstAsync: - -.. _RealmQuery_findFirstAsync__: - -.. _io_realm_RealmQuery_findFirstAsync: - -.. _io_realm_RealmQuery_findFirstAsync__: - - - -findFirstAsync --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`findFirstAsync ` () - | - - - - - * - Similar to :ref:`findFirst() ` but runs asynchronously on a worker thread. A listener should be registered to the returned :ref:`RealmObject ` to get the notification when query completes. The registered listener will also be triggered if there are changes made to the queried :ref:`RealmObject ` . If the :ref:`RealmObject ` is deleted, the listener will be called one last time and then stop. The query will not be re-run. - - - - - - - - - **Returns** - - immediately an empty :ref:`RealmObject ` with ``isLoaded() == false`` . Trying to access any field on the returned object before it is loaded will throw an ``IllegalStateException`` . - - - - - - - **Throws** - - - `IllegalStateException `__ - if this is called on a non-looper thread. - - - - - - - - - - - - -.. _getDescription: - -.. _getDescription__: - -.. _RealmQuery_getDescription: - -.. _RealmQuery_getDescription__: - -.. _io_realm_RealmQuery_getDescription: - -.. _io_realm_RealmQuery_getDescription__: - - - -getDescription --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getDescription ` () - | - - - - - * - Returns a textual description of this query. - - - - - - - **Returns** - - the textual description of the query. - - - - - - - - - - - -.. _getQueryPointer: - -.. _getQueryPointer__: - -.. _RealmQuery_getQueryPointer: - -.. _RealmQuery_getQueryPointer__: - -.. _io_realm_RealmQuery_getQueryPointer: - -.. _io_realm_RealmQuery_getQueryPointer__: - - - -getQueryPointer ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getQueryPointer ` () - | - - - - - * - Returns the pointer to the underlying C++ query. This method is only public due to architectural design choices that are hard to work around and should be considered internal and can change without warning. - - - - - - - **Returns** - - the pointer to the underlying C++ query. - - - - - - - - - - - -.. _getRealm: - -.. _getRealm__: - -.. _RealmQuery_getRealm: - -.. _RealmQuery_getRealm__: - -.. _io_realm_RealmQuery_getRealm: - -.. _io_realm_RealmQuery_getRealm__: - - - -getRealm --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Realm ` :ref:`getRealm ` () - | - - - - - * - Returns the :ref:`Realm ` instance to which this query belongs. - - Calling **Realm.close()** on the returned instance is discouraged as it is the same as calling it on the original Realm instance which may cause the Realm to fully close invalidating the query. - - - - - - - - - - - **Returns** - - :ref:`Realm ` instance this query belongs to. - - - - - - - **Throws** - - - `IllegalStateException `__ - if the Realm is an instance of :ref:`DynamicRealm ` or the :ref:`Realm ` was already closed. - - - - - - - - - - - - - - -.. _getTypeQueried: - -.. _getTypeQueried__: - -.. _RealmQuery_getTypeQueried: - -.. _RealmQuery_getTypeQueried__: - -.. _io_realm_RealmQuery_getTypeQueried: - -.. _io_realm_RealmQuery_getTypeQueried__: - - - -getTypeQueried --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getTypeQueried ` () - | - - - - - * - Returns the internal Realm name of the type being queried. - - - - - - - **Returns** - - the internal name of the Realm model class being queried. - - - - - - - - - - - -.. _greaterThan: - -.. _greaterThan__: - -.. _RealmQuery_greaterThan: - -.. _RealmQuery_greaterThan__: - -.. _io_realm_RealmQuery_greaterThan: - -.. _io_realm_RealmQuery_greaterThan__: - - - -greaterThan ------------ - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_greaterThan_String_ObjectId_: - -.. _io_realm_RealmQuery_greaterThan_String__ObjectId_: - -.. _greaterThan_java_lang_String_ObjectId_: - -.. _greaterThan_java_lang_String__ObjectId_: - -.. _greaterThan_String_ObjectId_: - -.. _greaterThan_String__ObjectId_: - -.. _RealmQuery_greaterThan_java_lang_String_ObjectId_: - -.. _RealmQuery_greaterThan_java_lang_String__ObjectId_: - -.. _RealmQuery_greaterThan_String_ObjectId_: - -.. _RealmQuery_greaterThan_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_greaterThan_String_Decimal128_: - -.. _io_realm_RealmQuery_greaterThan_String__Decimal128_: - -.. _greaterThan_java_lang_String_Decimal128_: - -.. _greaterThan_java_lang_String__Decimal128_: - -.. _greaterThan_String_Decimal128_: - -.. _greaterThan_String__Decimal128_: - -.. _RealmQuery_greaterThan_java_lang_String_Decimal128_: - -.. _RealmQuery_greaterThan_java_lang_String__Decimal128_: - -.. _RealmQuery_greaterThan_String_Decimal128_: - -.. _RealmQuery_greaterThan_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_String_RealmAny_: - -.. _io_realm_RealmQuery_greaterThan_String__RealmAny_: - -.. _greaterThan_java_lang_String_io_realm_RealmAny_: - -.. _greaterThan_java_lang_String__io_realm_RealmAny_: - -.. _greaterThan_java_lang_String_RealmAny_: - -.. _greaterThan_java_lang_String__RealmAny_: - -.. _greaterThan_String_io_realm_RealmAny_: - -.. _greaterThan_String__io_realm_RealmAny_: - -.. _greaterThan_String_RealmAny_: - -.. _greaterThan_String__RealmAny_: - -.. _RealmQuery_greaterThan_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_greaterThan_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_greaterThan_java_lang_String_RealmAny_: - -.. _RealmQuery_greaterThan_java_lang_String__RealmAny_: - -.. _RealmQuery_greaterThan_String_io_realm_RealmAny_: - -.. _RealmQuery_greaterThan_String__io_realm_RealmAny_: - -.. _RealmQuery_greaterThan_String_RealmAny_: - -.. _RealmQuery_greaterThan_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_java_util_Date_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__java_util_Date_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_Date_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__Date_: - -.. _io_realm_RealmQuery_greaterThan_String_java_util_Date_: - -.. _io_realm_RealmQuery_greaterThan_String__java_util_Date_: - -.. _io_realm_RealmQuery_greaterThan_String_Date_: - -.. _io_realm_RealmQuery_greaterThan_String__Date_: - -.. _greaterThan_java_lang_String_java_util_Date_: - -.. _greaterThan_java_lang_String__java_util_Date_: - -.. _greaterThan_java_lang_String_Date_: - -.. _greaterThan_java_lang_String__Date_: - -.. _greaterThan_String_java_util_Date_: - -.. _greaterThan_String__java_util_Date_: - -.. _greaterThan_String_Date_: - -.. _greaterThan_String__Date_: - -.. _RealmQuery_greaterThan_java_lang_String_java_util_Date_: - -.. _RealmQuery_greaterThan_java_lang_String__java_util_Date_: - -.. _RealmQuery_greaterThan_java_lang_String_Date_: - -.. _RealmQuery_greaterThan_java_lang_String__Date_: - -.. _RealmQuery_greaterThan_String_java_util_Date_: - -.. _RealmQuery_greaterThan_String__java_util_Date_: - -.. _RealmQuery_greaterThan_String_Date_: - -.. _RealmQuery_greaterThan_String__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_float_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__float_: - -.. _io_realm_RealmQuery_greaterThan_String_float_: - -.. _io_realm_RealmQuery_greaterThan_String__float_: - -.. _greaterThan_java_lang_String_float_: - -.. _greaterThan_java_lang_String__float_: - -.. _greaterThan_String_float_: - -.. _greaterThan_String__float_: - -.. _RealmQuery_greaterThan_java_lang_String_float_: - -.. _RealmQuery_greaterThan_java_lang_String__float_: - -.. _RealmQuery_greaterThan_String_float_: - -.. _RealmQuery_greaterThan_String__float_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **float** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_double_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__double_: - -.. _io_realm_RealmQuery_greaterThan_String_double_: - -.. _io_realm_RealmQuery_greaterThan_String__double_: - -.. _greaterThan_java_lang_String_double_: - -.. _greaterThan_java_lang_String__double_: - -.. _greaterThan_String_double_: - -.. _greaterThan_String__double_: - -.. _RealmQuery_greaterThan_java_lang_String_double_: - -.. _RealmQuery_greaterThan_java_lang_String__double_: - -.. _RealmQuery_greaterThan_String_double_: - -.. _RealmQuery_greaterThan_String__double_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **double** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_long_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__long_: - -.. _io_realm_RealmQuery_greaterThan_String_long_: - -.. _io_realm_RealmQuery_greaterThan_String__long_: - -.. _greaterThan_java_lang_String_long_: - -.. _greaterThan_java_lang_String__long_: - -.. _greaterThan_String_long_: - -.. _greaterThan_String__long_: - -.. _RealmQuery_greaterThan_java_lang_String_long_: - -.. _RealmQuery_greaterThan_java_lang_String__long_: - -.. _RealmQuery_greaterThan_String_long_: - -.. _RealmQuery_greaterThan_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThan_java_lang_String_int_: - -.. _io_realm_RealmQuery_greaterThan_java_lang_String__int_: - -.. _io_realm_RealmQuery_greaterThan_String_int_: - -.. _io_realm_RealmQuery_greaterThan_String__int_: - -.. _greaterThan_java_lang_String_int_: - -.. _greaterThan_java_lang_String__int_: - -.. _greaterThan_String_int_: - -.. _greaterThan_String__int_: - -.. _RealmQuery_greaterThan_java_lang_String_int_: - -.. _RealmQuery_greaterThan_java_lang_String__int_: - -.. _RealmQuery_greaterThan_String_int_: - -.. _RealmQuery_greaterThan_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThan ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Greater-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _greaterThanOrEqualTo: - -.. _greaterThanOrEqualTo__: - -.. _RealmQuery_greaterThanOrEqualTo: - -.. _RealmQuery_greaterThanOrEqualTo__: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo__: - - - -greaterThanOrEqualTo --------------------- - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_ObjectId_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__ObjectId_: - -.. _greaterThanOrEqualTo_java_lang_String_ObjectId_: - -.. _greaterThanOrEqualTo_java_lang_String__ObjectId_: - -.. _greaterThanOrEqualTo_String_ObjectId_: - -.. _greaterThanOrEqualTo_String__ObjectId_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_ObjectId_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__ObjectId_: - -.. _RealmQuery_greaterThanOrEqualTo_String_ObjectId_: - -.. _RealmQuery_greaterThanOrEqualTo_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_Decimal128_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__Decimal128_: - -.. _greaterThanOrEqualTo_java_lang_String_Decimal128_: - -.. _greaterThanOrEqualTo_java_lang_String__Decimal128_: - -.. _greaterThanOrEqualTo_String_Decimal128_: - -.. _greaterThanOrEqualTo_String__Decimal128_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_Decimal128_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__Decimal128_: - -.. _RealmQuery_greaterThanOrEqualTo_String_Decimal128_: - -.. _RealmQuery_greaterThanOrEqualTo_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_java_util_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__java_util_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_java_util_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__java_util_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_Date_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__Date_: - -.. _greaterThanOrEqualTo_java_lang_String_java_util_Date_: - -.. _greaterThanOrEqualTo_java_lang_String__java_util_Date_: - -.. _greaterThanOrEqualTo_java_lang_String_Date_: - -.. _greaterThanOrEqualTo_java_lang_String__Date_: - -.. _greaterThanOrEqualTo_String_java_util_Date_: - -.. _greaterThanOrEqualTo_String__java_util_Date_: - -.. _greaterThanOrEqualTo_String_Date_: - -.. _greaterThanOrEqualTo_String__Date_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_java_util_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__java_util_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__Date_: - -.. _RealmQuery_greaterThanOrEqualTo_String_java_util_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_String__java_util_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_String_Date_: - -.. _RealmQuery_greaterThanOrEqualTo_String__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_float_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__float_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_float_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__float_: - -.. _greaterThanOrEqualTo_java_lang_String_float_: - -.. _greaterThanOrEqualTo_java_lang_String__float_: - -.. _greaterThanOrEqualTo_String_float_: - -.. _greaterThanOrEqualTo_String__float_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_float_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__float_: - -.. _RealmQuery_greaterThanOrEqualTo_String_float_: - -.. _RealmQuery_greaterThanOrEqualTo_String__float_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **float** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_double_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__double_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_double_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__double_: - -.. _greaterThanOrEqualTo_java_lang_String_double_: - -.. _greaterThanOrEqualTo_java_lang_String__double_: - -.. _greaterThanOrEqualTo_String_double_: - -.. _greaterThanOrEqualTo_String__double_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_double_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__double_: - -.. _RealmQuery_greaterThanOrEqualTo_String_double_: - -.. _RealmQuery_greaterThanOrEqualTo_String__double_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **double** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_long_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__long_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_long_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__long_: - -.. _greaterThanOrEqualTo_java_lang_String_long_: - -.. _greaterThanOrEqualTo_java_lang_String__long_: - -.. _greaterThanOrEqualTo_String_long_: - -.. _greaterThanOrEqualTo_String__long_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_long_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__long_: - -.. _RealmQuery_greaterThanOrEqualTo_String_long_: - -.. _RealmQuery_greaterThanOrEqualTo_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String_int_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_java_lang_String__int_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String_int_: - -.. _io_realm_RealmQuery_greaterThanOrEqualTo_String__int_: - -.. _greaterThanOrEqualTo_java_lang_String_int_: - -.. _greaterThanOrEqualTo_java_lang_String__int_: - -.. _greaterThanOrEqualTo_String_int_: - -.. _greaterThanOrEqualTo_String__int_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String_int_: - -.. _RealmQuery_greaterThanOrEqualTo_java_lang_String__int_: - -.. _RealmQuery_greaterThanOrEqualTo_String_int_: - -.. _RealmQuery_greaterThanOrEqualTo_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`greaterThanOrEqualTo ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Greater-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _in: - -.. _in__: - -.. _RealmQuery_in: - -.. _RealmQuery_in__: - -.. _io_realm_RealmQuery_in: - -.. _io_realm_RealmQuery_in__: - - - -in ----- - -.. _io_realm_RealmQuery_in_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_in_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_in_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_in_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_in_java_lang_String_RealmAny____: - -.. _io_realm_RealmQuery_in_java_lang_String__RealmAny____: - -.. _io_realm_RealmQuery_in_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_in_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_in_String_RealmAny_: - -.. _io_realm_RealmQuery_in_String__RealmAny_: - -.. _io_realm_RealmQuery_in_String_RealmAny____: - -.. _io_realm_RealmQuery_in_String__RealmAny____: - -.. _in_java_lang_String_io_realm_RealmAny_: - -.. _in_java_lang_String__io_realm_RealmAny_: - -.. _in_java_lang_String_RealmAny_: - -.. _in_java_lang_String__RealmAny_: - -.. _in_java_lang_String_RealmAny____: - -.. _in_java_lang_String__RealmAny____: - -.. _in_String_io_realm_RealmAny_: - -.. _in_String__io_realm_RealmAny_: - -.. _in_String_RealmAny_: - -.. _in_String__RealmAny_: - -.. _in_String_RealmAny____: - -.. _in_String__RealmAny____: - -.. _RealmQuery_in_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_in_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_in_java_lang_String_RealmAny_: - -.. _RealmQuery_in_java_lang_String__RealmAny_: - -.. _RealmQuery_in_java_lang_String_RealmAny____: - -.. _RealmQuery_in_java_lang_String__RealmAny____: - -.. _RealmQuery_in_String_io_realm_RealmAny_: - -.. _RealmQuery_in_String__io_realm_RealmAny_: - -.. _RealmQuery_in_String_RealmAny_: - -.. _RealmQuery_in_String__RealmAny_: - -.. _RealmQuery_in_String_RealmAny____: - -.. _RealmQuery_in_String__RealmAny____: - -.. _io_realm_RealmQuery_in_String__RealmAny[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | :ref:`io.realm.RealmAny[] ` values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Date field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_util_Date_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_util_Date_: - -.. _io_realm_RealmQuery_in_java_lang_String_Date_: - -.. _io_realm_RealmQuery_in_java_lang_String__Date_: - -.. _io_realm_RealmQuery_in_java_lang_String_Date____: - -.. _io_realm_RealmQuery_in_java_lang_String__Date____: - -.. _io_realm_RealmQuery_in_String_java_util_Date_: - -.. _io_realm_RealmQuery_in_String__java_util_Date_: - -.. _io_realm_RealmQuery_in_String_Date_: - -.. _io_realm_RealmQuery_in_String__Date_: - -.. _io_realm_RealmQuery_in_String_Date____: - -.. _io_realm_RealmQuery_in_String__Date____: - -.. _in_java_lang_String_java_util_Date_: - -.. _in_java_lang_String__java_util_Date_: - -.. _in_java_lang_String_Date_: - -.. _in_java_lang_String__Date_: - -.. _in_java_lang_String_Date____: - -.. _in_java_lang_String__Date____: - -.. _in_String_java_util_Date_: - -.. _in_String__java_util_Date_: - -.. _in_String_Date_: - -.. _in_String__Date_: - -.. _in_String_Date____: - -.. _in_String__Date____: - -.. _RealmQuery_in_java_lang_String_java_util_Date_: - -.. _RealmQuery_in_java_lang_String__java_util_Date_: - -.. _RealmQuery_in_java_lang_String_Date_: - -.. _RealmQuery_in_java_lang_String__Date_: - -.. _RealmQuery_in_java_lang_String_Date____: - -.. _RealmQuery_in_java_lang_String__Date____: - -.. _RealmQuery_in_String_java_util_Date_: - -.. _RealmQuery_in_String__java_util_Date_: - -.. _RealmQuery_in_String_Date_: - -.. _RealmQuery_in_String__Date_: - -.. _RealmQuery_in_String_Date____: - -.. _RealmQuery_in_String__Date____: - -.. _io_realm_RealmQuery_in_String__Date[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.util.Date[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Date field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Boolean_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Boolean_: - -.. _io_realm_RealmQuery_in_java_lang_String_Boolean_: - -.. _io_realm_RealmQuery_in_java_lang_String__Boolean_: - -.. _io_realm_RealmQuery_in_java_lang_String_Boolean____: - -.. _io_realm_RealmQuery_in_java_lang_String__Boolean____: - -.. _io_realm_RealmQuery_in_String_java_lang_Boolean_: - -.. _io_realm_RealmQuery_in_String__java_lang_Boolean_: - -.. _io_realm_RealmQuery_in_String_Boolean_: - -.. _io_realm_RealmQuery_in_String__Boolean_: - -.. _io_realm_RealmQuery_in_String_Boolean____: - -.. _io_realm_RealmQuery_in_String__Boolean____: - -.. _in_java_lang_String_java_lang_Boolean_: - -.. _in_java_lang_String__java_lang_Boolean_: - -.. _in_java_lang_String_Boolean_: - -.. _in_java_lang_String__Boolean_: - -.. _in_java_lang_String_Boolean____: - -.. _in_java_lang_String__Boolean____: - -.. _in_String_java_lang_Boolean_: - -.. _in_String__java_lang_Boolean_: - -.. _in_String_Boolean_: - -.. _in_String__Boolean_: - -.. _in_String_Boolean____: - -.. _in_String__Boolean____: - -.. _RealmQuery_in_java_lang_String_java_lang_Boolean_: - -.. _RealmQuery_in_java_lang_String__java_lang_Boolean_: - -.. _RealmQuery_in_java_lang_String_Boolean_: - -.. _RealmQuery_in_java_lang_String__Boolean_: - -.. _RealmQuery_in_java_lang_String_Boolean____: - -.. _RealmQuery_in_java_lang_String__Boolean____: - -.. _RealmQuery_in_String_java_lang_Boolean_: - -.. _RealmQuery_in_String__java_lang_Boolean_: - -.. _RealmQuery_in_String_Boolean_: - -.. _RealmQuery_in_String__Boolean_: - -.. _RealmQuery_in_String_Boolean____: - -.. _RealmQuery_in_String__Boolean____: - -.. _io_realm_RealmQuery_in_String__Boolean[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Boolean[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Boolean. or empty. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Float_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Float_: - -.. _io_realm_RealmQuery_in_java_lang_String_Float_: - -.. _io_realm_RealmQuery_in_java_lang_String__Float_: - -.. _io_realm_RealmQuery_in_java_lang_String_Float____: - -.. _io_realm_RealmQuery_in_java_lang_String__Float____: - -.. _io_realm_RealmQuery_in_String_java_lang_Float_: - -.. _io_realm_RealmQuery_in_String__java_lang_Float_: - -.. _io_realm_RealmQuery_in_String_Float_: - -.. _io_realm_RealmQuery_in_String__Float_: - -.. _io_realm_RealmQuery_in_String_Float____: - -.. _io_realm_RealmQuery_in_String__Float____: - -.. _in_java_lang_String_java_lang_Float_: - -.. _in_java_lang_String__java_lang_Float_: - -.. _in_java_lang_String_Float_: - -.. _in_java_lang_String__Float_: - -.. _in_java_lang_String_Float____: - -.. _in_java_lang_String__Float____: - -.. _in_String_java_lang_Float_: - -.. _in_String__java_lang_Float_: - -.. _in_String_Float_: - -.. _in_String__Float_: - -.. _in_String_Float____: - -.. _in_String__Float____: - -.. _RealmQuery_in_java_lang_String_java_lang_Float_: - -.. _RealmQuery_in_java_lang_String__java_lang_Float_: - -.. _RealmQuery_in_java_lang_String_Float_: - -.. _RealmQuery_in_java_lang_String__Float_: - -.. _RealmQuery_in_java_lang_String_Float____: - -.. _RealmQuery_in_java_lang_String__Float____: - -.. _RealmQuery_in_String_java_lang_Float_: - -.. _RealmQuery_in_String__java_lang_Float_: - -.. _RealmQuery_in_String_Float_: - -.. _RealmQuery_in_String__Float_: - -.. _RealmQuery_in_String_Float____: - -.. _RealmQuery_in_String__Float____: - -.. _io_realm_RealmQuery_in_String__Float[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Float[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Float field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Double_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Double_: - -.. _io_realm_RealmQuery_in_java_lang_String_Double_: - -.. _io_realm_RealmQuery_in_java_lang_String__Double_: - -.. _io_realm_RealmQuery_in_java_lang_String_Double____: - -.. _io_realm_RealmQuery_in_java_lang_String__Double____: - -.. _io_realm_RealmQuery_in_String_java_lang_Double_: - -.. _io_realm_RealmQuery_in_String__java_lang_Double_: - -.. _io_realm_RealmQuery_in_String_Double_: - -.. _io_realm_RealmQuery_in_String__Double_: - -.. _io_realm_RealmQuery_in_String_Double____: - -.. _io_realm_RealmQuery_in_String__Double____: - -.. _in_java_lang_String_java_lang_Double_: - -.. _in_java_lang_String__java_lang_Double_: - -.. _in_java_lang_String_Double_: - -.. _in_java_lang_String__Double_: - -.. _in_java_lang_String_Double____: - -.. _in_java_lang_String__Double____: - -.. _in_String_java_lang_Double_: - -.. _in_String__java_lang_Double_: - -.. _in_String_Double_: - -.. _in_String__Double_: - -.. _in_String_Double____: - -.. _in_String__Double____: - -.. _RealmQuery_in_java_lang_String_java_lang_Double_: - -.. _RealmQuery_in_java_lang_String__java_lang_Double_: - -.. _RealmQuery_in_java_lang_String_Double_: - -.. _RealmQuery_in_java_lang_String__Double_: - -.. _RealmQuery_in_java_lang_String_Double____: - -.. _RealmQuery_in_java_lang_String__Double____: - -.. _RealmQuery_in_String_java_lang_Double_: - -.. _RealmQuery_in_String__java_lang_Double_: - -.. _RealmQuery_in_String_Double_: - -.. _RealmQuery_in_String__Double_: - -.. _RealmQuery_in_String_Double____: - -.. _RealmQuery_in_String__Double____: - -.. _io_realm_RealmQuery_in_String__Double[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Double[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Double field. empty. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Long_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Long_: - -.. _io_realm_RealmQuery_in_java_lang_String_Long_: - -.. _io_realm_RealmQuery_in_java_lang_String__Long_: - -.. _io_realm_RealmQuery_in_java_lang_String_Long____: - -.. _io_realm_RealmQuery_in_java_lang_String__Long____: - -.. _io_realm_RealmQuery_in_String_java_lang_Long_: - -.. _io_realm_RealmQuery_in_String__java_lang_Long_: - -.. _io_realm_RealmQuery_in_String_Long_: - -.. _io_realm_RealmQuery_in_String__Long_: - -.. _io_realm_RealmQuery_in_String_Long____: - -.. _io_realm_RealmQuery_in_String__Long____: - -.. _in_java_lang_String_java_lang_Long_: - -.. _in_java_lang_String__java_lang_Long_: - -.. _in_java_lang_String_Long_: - -.. _in_java_lang_String__Long_: - -.. _in_java_lang_String_Long____: - -.. _in_java_lang_String__Long____: - -.. _in_String_java_lang_Long_: - -.. _in_String__java_lang_Long_: - -.. _in_String_Long_: - -.. _in_String__Long_: - -.. _in_String_Long____: - -.. _in_String__Long____: - -.. _RealmQuery_in_java_lang_String_java_lang_Long_: - -.. _RealmQuery_in_java_lang_String__java_lang_Long_: - -.. _RealmQuery_in_java_lang_String_Long_: - -.. _RealmQuery_in_java_lang_String__Long_: - -.. _RealmQuery_in_java_lang_String_Long____: - -.. _RealmQuery_in_java_lang_String__Long____: - -.. _RealmQuery_in_String_java_lang_Long_: - -.. _RealmQuery_in_String__java_lang_Long_: - -.. _RealmQuery_in_String_Long_: - -.. _RealmQuery_in_String__Long_: - -.. _RealmQuery_in_String_Long____: - -.. _RealmQuery_in_String__Long____: - -.. _io_realm_RealmQuery_in_String__Long[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Long[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Long field. empty. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Integer_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Integer_: - -.. _io_realm_RealmQuery_in_java_lang_String_Integer_: - -.. _io_realm_RealmQuery_in_java_lang_String__Integer_: - -.. _io_realm_RealmQuery_in_java_lang_String_Integer____: - -.. _io_realm_RealmQuery_in_java_lang_String__Integer____: - -.. _io_realm_RealmQuery_in_String_java_lang_Integer_: - -.. _io_realm_RealmQuery_in_String__java_lang_Integer_: - -.. _io_realm_RealmQuery_in_String_Integer_: - -.. _io_realm_RealmQuery_in_String__Integer_: - -.. _io_realm_RealmQuery_in_String_Integer____: - -.. _io_realm_RealmQuery_in_String__Integer____: - -.. _in_java_lang_String_java_lang_Integer_: - -.. _in_java_lang_String__java_lang_Integer_: - -.. _in_java_lang_String_Integer_: - -.. _in_java_lang_String__Integer_: - -.. _in_java_lang_String_Integer____: - -.. _in_java_lang_String__Integer____: - -.. _in_String_java_lang_Integer_: - -.. _in_String__java_lang_Integer_: - -.. _in_String_Integer_: - -.. _in_String__Integer_: - -.. _in_String_Integer____: - -.. _in_String__Integer____: - -.. _RealmQuery_in_java_lang_String_java_lang_Integer_: - -.. _RealmQuery_in_java_lang_String__java_lang_Integer_: - -.. _RealmQuery_in_java_lang_String_Integer_: - -.. _RealmQuery_in_java_lang_String__Integer_: - -.. _RealmQuery_in_java_lang_String_Integer____: - -.. _RealmQuery_in_java_lang_String__Integer____: - -.. _RealmQuery_in_String_java_lang_Integer_: - -.. _RealmQuery_in_String__java_lang_Integer_: - -.. _RealmQuery_in_String_Integer_: - -.. _RealmQuery_in_String__Integer_: - -.. _RealmQuery_in_String_Integer____: - -.. _RealmQuery_in_String__Integer____: - -.. _io_realm_RealmQuery_in_String__Integer[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Integer[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Integer field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Short_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Short_: - -.. _io_realm_RealmQuery_in_java_lang_String_Short_: - -.. _io_realm_RealmQuery_in_java_lang_String__Short_: - -.. _io_realm_RealmQuery_in_java_lang_String_Short____: - -.. _io_realm_RealmQuery_in_java_lang_String__Short____: - -.. _io_realm_RealmQuery_in_String_java_lang_Short_: - -.. _io_realm_RealmQuery_in_String__java_lang_Short_: - -.. _io_realm_RealmQuery_in_String_Short_: - -.. _io_realm_RealmQuery_in_String__Short_: - -.. _io_realm_RealmQuery_in_String_Short____: - -.. _io_realm_RealmQuery_in_String__Short____: - -.. _in_java_lang_String_java_lang_Short_: - -.. _in_java_lang_String__java_lang_Short_: - -.. _in_java_lang_String_Short_: - -.. _in_java_lang_String__Short_: - -.. _in_java_lang_String_Short____: - -.. _in_java_lang_String__Short____: - -.. _in_String_java_lang_Short_: - -.. _in_String__java_lang_Short_: - -.. _in_String_Short_: - -.. _in_String__Short_: - -.. _in_String_Short____: - -.. _in_String__Short____: - -.. _RealmQuery_in_java_lang_String_java_lang_Short_: - -.. _RealmQuery_in_java_lang_String__java_lang_Short_: - -.. _RealmQuery_in_java_lang_String_Short_: - -.. _RealmQuery_in_java_lang_String__Short_: - -.. _RealmQuery_in_java_lang_String_Short____: - -.. _RealmQuery_in_java_lang_String__Short____: - -.. _RealmQuery_in_String_java_lang_Short_: - -.. _RealmQuery_in_String__java_lang_Short_: - -.. _RealmQuery_in_String_Short_: - -.. _RealmQuery_in_String__Short_: - -.. _RealmQuery_in_String_Short____: - -.. _RealmQuery_in_String__Short____: - -.. _io_realm_RealmQuery_in_String__Short[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Short[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Short field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_Byte_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_Byte_: - -.. _io_realm_RealmQuery_in_java_lang_String_Byte_: - -.. _io_realm_RealmQuery_in_java_lang_String__Byte_: - -.. _io_realm_RealmQuery_in_java_lang_String_Byte____: - -.. _io_realm_RealmQuery_in_java_lang_String__Byte____: - -.. _io_realm_RealmQuery_in_String_java_lang_Byte_: - -.. _io_realm_RealmQuery_in_String__java_lang_Byte_: - -.. _io_realm_RealmQuery_in_String_Byte_: - -.. _io_realm_RealmQuery_in_String__Byte_: - -.. _io_realm_RealmQuery_in_String_Byte____: - -.. _io_realm_RealmQuery_in_String__Byte____: - -.. _in_java_lang_String_java_lang_Byte_: - -.. _in_java_lang_String__java_lang_Byte_: - -.. _in_java_lang_String_Byte_: - -.. _in_java_lang_String__Byte_: - -.. _in_java_lang_String_Byte____: - -.. _in_java_lang_String__Byte____: - -.. _in_String_java_lang_Byte_: - -.. _in_String__java_lang_Byte_: - -.. _in_String_Byte_: - -.. _in_String__Byte_: - -.. _in_String_Byte____: - -.. _in_String__Byte____: - -.. _RealmQuery_in_java_lang_String_java_lang_Byte_: - -.. _RealmQuery_in_java_lang_String__java_lang_Byte_: - -.. _RealmQuery_in_java_lang_String_Byte_: - -.. _RealmQuery_in_java_lang_String__Byte_: - -.. _RealmQuery_in_java_lang_String_Byte____: - -.. _RealmQuery_in_java_lang_String__Byte____: - -.. _RealmQuery_in_String_java_lang_Byte_: - -.. _RealmQuery_in_String__java_lang_Byte_: - -.. _RealmQuery_in_String_Byte_: - -.. _RealmQuery_in_String__Byte_: - -.. _RealmQuery_in_String_Byte____: - -.. _RealmQuery_in_String__Byte____: - -.. _io_realm_RealmQuery_in_String__Byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.Byte[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a Byte field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_in_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_in_java_lang_String_String____io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__String_____io_realm_Case_: - -.. _io_realm_RealmQuery_in_java_lang_String_String____Case_: - -.. _io_realm_RealmQuery_in_java_lang_String__String_____Case_: - -.. _io_realm_RealmQuery_in_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_in_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_in_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_in_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_in_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_in_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_in_String_String_Case_: - -.. _io_realm_RealmQuery_in_String__String__Case_: - -.. _io_realm_RealmQuery_in_String_String____io_realm_Case_: - -.. _io_realm_RealmQuery_in_String__String_____io_realm_Case_: - -.. _io_realm_RealmQuery_in_String_String____Case_: - -.. _io_realm_RealmQuery_in_String__String_____Case_: - -.. _in_java_lang_String_java_lang_String_io_realm_Case_: - -.. _in_java_lang_String__java_lang_String__io_realm_Case_: - -.. _in_java_lang_String_java_lang_String_Case_: - -.. _in_java_lang_String__java_lang_String__Case_: - -.. _in_java_lang_String_String_io_realm_Case_: - -.. _in_java_lang_String__String__io_realm_Case_: - -.. _in_java_lang_String_String_Case_: - -.. _in_java_lang_String__String__Case_: - -.. _in_java_lang_String_String____io_realm_Case_: - -.. _in_java_lang_String__String_____io_realm_Case_: - -.. _in_java_lang_String_String____Case_: - -.. _in_java_lang_String__String_____Case_: - -.. _in_String_java_lang_String_io_realm_Case_: - -.. _in_String__java_lang_String__io_realm_Case_: - -.. _in_String_java_lang_String_Case_: - -.. _in_String__java_lang_String__Case_: - -.. _in_String_String_io_realm_Case_: - -.. _in_String__String__io_realm_Case_: - -.. _in_String_String_Case_: - -.. _in_String__String__Case_: - -.. _in_String_String____io_realm_Case_: - -.. _in_String__String_____io_realm_Case_: - -.. _in_String_String____Case_: - -.. _in_String__String_____Case_: - -.. _RealmQuery_in_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_in_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_in_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_in_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_in_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_in_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_in_java_lang_String_String_Case_: - -.. _RealmQuery_in_java_lang_String__String__Case_: - -.. _RealmQuery_in_java_lang_String_String____io_realm_Case_: - -.. _RealmQuery_in_java_lang_String__String_____io_realm_Case_: - -.. _RealmQuery_in_java_lang_String_String____Case_: - -.. _RealmQuery_in_java_lang_String__String_____Case_: - -.. _RealmQuery_in_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_in_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_in_String_java_lang_String_Case_: - -.. _RealmQuery_in_String__java_lang_String__Case_: - -.. _RealmQuery_in_String_String_io_realm_Case_: - -.. _RealmQuery_in_String__String__io_realm_Case_: - -.. _RealmQuery_in_String_String_Case_: - -.. _RealmQuery_in_String__String__Case_: - -.. _RealmQuery_in_String_String____io_realm_Case_: - -.. _RealmQuery_in_String__String_____io_realm_Case_: - -.. _RealmQuery_in_String_String____Case_: - -.. _RealmQuery_in_String__String_____Case_: - -.. _io_realm_RealmQuery_in_String__String[]__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values, - | :ref:`Case ` casing - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - ``casing`` - how casing is handled. :ref:`Case.INSENSITIVE ` works only for the Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. - - - - - - - - - - -.. _io_realm_RealmQuery_in_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_in_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_in_java_lang_String_String_: - -.. _io_realm_RealmQuery_in_java_lang_String__String_: - -.. _io_realm_RealmQuery_in_java_lang_String_String____: - -.. _io_realm_RealmQuery_in_java_lang_String__String____: - -.. _io_realm_RealmQuery_in_String_java_lang_String_: - -.. _io_realm_RealmQuery_in_String__java_lang_String_: - -.. _io_realm_RealmQuery_in_String_String_: - -.. _io_realm_RealmQuery_in_String__String_: - -.. _io_realm_RealmQuery_in_String_String____: - -.. _io_realm_RealmQuery_in_String__String____: - -.. _in_java_lang_String_java_lang_String_: - -.. _in_java_lang_String__java_lang_String_: - -.. _in_java_lang_String_String_: - -.. _in_java_lang_String__String_: - -.. _in_java_lang_String_String____: - -.. _in_java_lang_String__String____: - -.. _in_String_java_lang_String_: - -.. _in_String__java_lang_String_: - -.. _in_String_String_: - -.. _in_String__String_: - -.. _in_String_String____: - -.. _in_String__String____: - -.. _RealmQuery_in_java_lang_String_java_lang_String_: - -.. _RealmQuery_in_java_lang_String__java_lang_String_: - -.. _RealmQuery_in_java_lang_String_String_: - -.. _RealmQuery_in_java_lang_String__String_: - -.. _RealmQuery_in_java_lang_String_String____: - -.. _RealmQuery_in_java_lang_String__String____: - -.. _RealmQuery_in_String_java_lang_String_: - -.. _RealmQuery_in_String__java_lang_String_: - -.. _RealmQuery_in_String_String_: - -.. _RealmQuery_in_String__String_: - -.. _RealmQuery_in_String_String____: - -.. _RealmQuery_in_String__String____: - -.. _io_realm_RealmQuery_in_String__String[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`in ` ( - | `String `__ fieldName, - | `java.lang.String[] `__ values - | ) - - - - - * - In comparison. This allows you to test if objects match any value in an array of values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``values`` - array of values to compare with. If ``null`` or the empty array is provided the query will never match any results. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field isn't a String field. - - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _RealmQuery_isEmpty: - -.. _RealmQuery_isEmpty__: - -.. _io_realm_RealmQuery_isEmpty: - -.. _io_realm_RealmQuery_isEmpty__: - - - -isEmpty -------- - -.. _io_realm_RealmQuery_isEmpty_java_lang_String_: - -.. _io_realm_RealmQuery_isEmpty_String_: - -.. _isEmpty_java_lang_String_: - -.. _isEmpty_String_: - -.. _RealmQuery_isEmpty_java_lang_String_: - -.. _RealmQuery_isEmpty_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`isEmpty ` ( - | `String `__ fieldName - | ) - - - - - * - Condition that finds values that are considered "empty" i.e., an empty list, the 0-length string or byte array. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. - - - - - - - - - - - - -.. _isNotEmpty: - -.. _isNotEmpty__: - -.. _RealmQuery_isNotEmpty: - -.. _RealmQuery_isNotEmpty__: - -.. _io_realm_RealmQuery_isNotEmpty: - -.. _io_realm_RealmQuery_isNotEmpty__: - - - -isNotEmpty ----------- - -.. _io_realm_RealmQuery_isNotEmpty_java_lang_String_: - -.. _io_realm_RealmQuery_isNotEmpty_String_: - -.. _isNotEmpty_java_lang_String_: - -.. _isNotEmpty_String_: - -.. _RealmQuery_isNotEmpty_java_lang_String_: - -.. _RealmQuery_isNotEmpty_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`isNotEmpty ` ( - | `String `__ fieldName - | ) - - - - - * - Condition that finds values that are considered "Not-empty" i.e., a list, a string or a byte array with not-empty values. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field name isn't valid or its type isn't either a RealmList, String or byte array. - - - - - - - - - - - - -.. _isNotNull: - -.. _isNotNull__: - -.. _RealmQuery_isNotNull: - -.. _RealmQuery_isNotNull__: - -.. _io_realm_RealmQuery_isNotNull: - -.. _io_realm_RealmQuery_isNotNull__: - - - -isNotNull ---------- - -.. _io_realm_RealmQuery_isNotNull_java_lang_String_: - -.. _io_realm_RealmQuery_isNotNull_String_: - -.. _isNotNull_java_lang_String_: - -.. _isNotNull_String_: - -.. _RealmQuery_isNotNull_java_lang_String_: - -.. _RealmQuery_isNotNull_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`isNotNull ` ( - | `String `__ fieldName - | ) - - - - - * - Tests if a field is not ``null`` . Only works for nullable fields. - - - - - - - **Parameters** - - - ``fieldName`` - the field name. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not nullable. - - - - - - - - - - .. seealso:: - - - - - :ref:`Required for further infomation. ` - - - - - - - - - - - - -.. _isNull: - -.. _isNull__: - -.. _RealmQuery_isNull: - -.. _RealmQuery_isNull__: - -.. _io_realm_RealmQuery_isNull: - -.. _io_realm_RealmQuery_isNull__: - - - -isNull ------- - -.. _io_realm_RealmQuery_isNull_java_lang_String_: - -.. _io_realm_RealmQuery_isNull_String_: - -.. _isNull_java_lang_String_: - -.. _isNull_String_: - -.. _RealmQuery_isNull_java_lang_String_: - -.. _RealmQuery_isNull_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`isNull ` ( - | `String `__ fieldName - | ) - - - - - * - Tests if a field is ``null`` . Only works for nullable fields. - - For link queries, if any part of the link path is ``null`` the whole path is considered to be ``null`` e.g., ``isNull("linkField.stringField")`` will be considered to be ``null`` if either ``linkField`` or ``linkField.stringField`` is ``null`` . - - - - - - - - - **Parameters** - - - ``fieldName`` - the field name. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not nullable. - - - - - - - - - - .. seealso:: - - - - - :ref:`Required for further infomation. ` - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmQuery_isValid: - -.. _RealmQuery_isValid__: - -.. _io_realm_RealmQuery_isValid: - -.. _io_realm_RealmQuery_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - Checks if :ref:`io.realm.RealmQuery ` is still valid to use i.e., the :ref:`io.realm.Realm ` instance hasn't been closed and any parent :ref:`io.realm.RealmResults ` is still valid. - - - - - - - - - **Returns** - - ``true`` if still valid to use, ``false`` otherwise. - - - - - - - - - - - - - -.. _lessThan: - -.. _lessThan__: - -.. _RealmQuery_lessThan: - -.. _RealmQuery_lessThan__: - -.. _io_realm_RealmQuery_lessThan: - -.. _io_realm_RealmQuery_lessThan__: - - - -lessThan --------- - -.. _io_realm_RealmQuery_lessThan_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_lessThan_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_lessThan_String_ObjectId_: - -.. _io_realm_RealmQuery_lessThan_String__ObjectId_: - -.. _lessThan_java_lang_String_ObjectId_: - -.. _lessThan_java_lang_String__ObjectId_: - -.. _lessThan_String_ObjectId_: - -.. _lessThan_String__ObjectId_: - -.. _RealmQuery_lessThan_java_lang_String_ObjectId_: - -.. _RealmQuery_lessThan_java_lang_String__ObjectId_: - -.. _RealmQuery_lessThan_String_ObjectId_: - -.. _RealmQuery_lessThan_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Less-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThan_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_lessThan_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_lessThan_String_Decimal128_: - -.. _io_realm_RealmQuery_lessThan_String__Decimal128_: - -.. _lessThan_java_lang_String_Decimal128_: - -.. _lessThan_java_lang_String__Decimal128_: - -.. _lessThan_String_Decimal128_: - -.. _lessThan_String__Decimal128_: - -.. _RealmQuery_lessThan_java_lang_String_Decimal128_: - -.. _RealmQuery_lessThan_java_lang_String__Decimal128_: - -.. _RealmQuery_lessThan_String_Decimal128_: - -.. _RealmQuery_lessThan_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Less-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThan_java_lang_String_long_: - -.. _io_realm_RealmQuery_lessThan_java_lang_String__long_: - -.. _io_realm_RealmQuery_lessThan_String_long_: - -.. _io_realm_RealmQuery_lessThan_String__long_: - -.. _lessThan_java_lang_String_long_: - -.. _lessThan_java_lang_String__long_: - -.. _lessThan_String_long_: - -.. _lessThan_String__long_: - -.. _RealmQuery_lessThan_java_lang_String_long_: - -.. _RealmQuery_lessThan_java_lang_String__long_: - -.. _RealmQuery_lessThan_String_long_: - -.. _RealmQuery_lessThan_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Less-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThan_java_lang_String_int_: - -.. _io_realm_RealmQuery_lessThan_java_lang_String__int_: - -.. _io_realm_RealmQuery_lessThan_String_int_: - -.. _io_realm_RealmQuery_lessThan_String__int_: - -.. _lessThan_java_lang_String_int_: - -.. _lessThan_java_lang_String__int_: - -.. _lessThan_String_int_: - -.. _lessThan_String__int_: - -.. _RealmQuery_lessThan_java_lang_String_int_: - -.. _RealmQuery_lessThan_java_lang_String__int_: - -.. _RealmQuery_lessThan_String_int_: - -.. _RealmQuery_lessThan_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThan ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Less-than comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _lessThanOrEqualTo: - -.. _lessThanOrEqualTo__: - -.. _RealmQuery_lessThanOrEqualTo: - -.. _RealmQuery_lessThanOrEqualTo__: - -.. _io_realm_RealmQuery_lessThanOrEqualTo: - -.. _io_realm_RealmQuery_lessThanOrEqualTo__: - - - -lessThanOrEqualTo ------------------ - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String_ObjectId_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String__ObjectId_: - -.. _lessThanOrEqualTo_java_lang_String_ObjectId_: - -.. _lessThanOrEqualTo_java_lang_String__ObjectId_: - -.. _lessThanOrEqualTo_String_ObjectId_: - -.. _lessThanOrEqualTo_String__ObjectId_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String_ObjectId_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String__ObjectId_: - -.. _RealmQuery_lessThanOrEqualTo_String_ObjectId_: - -.. _RealmQuery_lessThanOrEqualTo_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Less-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String_Decimal128_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String__Decimal128_: - -.. _lessThanOrEqualTo_java_lang_String_Decimal128_: - -.. _lessThanOrEqualTo_java_lang_String__Decimal128_: - -.. _lessThanOrEqualTo_String_Decimal128_: - -.. _lessThanOrEqualTo_String__Decimal128_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String_Decimal128_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String__Decimal128_: - -.. _RealmQuery_lessThanOrEqualTo_String_Decimal128_: - -.. _RealmQuery_lessThanOrEqualTo_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Less-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String_long_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String__long_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String_long_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String__long_: - -.. _lessThanOrEqualTo_java_lang_String_long_: - -.. _lessThanOrEqualTo_java_lang_String__long_: - -.. _lessThanOrEqualTo_String_long_: - -.. _lessThanOrEqualTo_String__long_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String_long_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String__long_: - -.. _RealmQuery_lessThanOrEqualTo_String_long_: - -.. _RealmQuery_lessThanOrEqualTo_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Less-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String_int_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_java_lang_String__int_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String_int_: - -.. _io_realm_RealmQuery_lessThanOrEqualTo_String__int_: - -.. _lessThanOrEqualTo_java_lang_String_int_: - -.. _lessThanOrEqualTo_java_lang_String__int_: - -.. _lessThanOrEqualTo_String_int_: - -.. _lessThanOrEqualTo_String__int_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String_int_: - -.. _RealmQuery_lessThanOrEqualTo_java_lang_String__int_: - -.. _RealmQuery_lessThanOrEqualTo_String_int_: - -.. _RealmQuery_lessThanOrEqualTo_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`lessThanOrEqualTo ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Less-than-or-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _like: - -.. _like__: - -.. _RealmQuery_like: - -.. _RealmQuery_like__: - -.. _io_realm_RealmQuery_like: - -.. _io_realm_RealmQuery_like__: - - - -like ----- - -.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_like_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_like_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_like_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_like_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_like_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_like_String__RealmAny__Case_: - -.. _like_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _like_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _like_java_lang_String_io_realm_RealmAny_Case_: - -.. _like_java_lang_String__io_realm_RealmAny__Case_: - -.. _like_java_lang_String_RealmAny_io_realm_Case_: - -.. _like_java_lang_String__RealmAny__io_realm_Case_: - -.. _like_java_lang_String_RealmAny_Case_: - -.. _like_java_lang_String__RealmAny__Case_: - -.. _like_String_io_realm_RealmAny_io_realm_Case_: - -.. _like_String__io_realm_RealmAny__io_realm_Case_: - -.. _like_String_io_realm_RealmAny_Case_: - -.. _like_String__io_realm_RealmAny__Case_: - -.. _like_String_RealmAny_io_realm_Case_: - -.. _like_String__RealmAny__io_realm_Case_: - -.. _like_String_RealmAny_Case_: - -.. _like_String__RealmAny__Case_: - -.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_like_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_like_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_like_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_like_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_like_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_like_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_like_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_like_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_like_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_like_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_like_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_like_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_like_String_RealmAny_Case_: - -.. _RealmQuery_like_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the wildcard string. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_like_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_like_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_like_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_like_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_like_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_like_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_like_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_like_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_like_String_String_Case_: - -.. _io_realm_RealmQuery_like_String__String__Case_: - -.. _like_java_lang_String_java_lang_String_io_realm_Case_: - -.. _like_java_lang_String__java_lang_String__io_realm_Case_: - -.. _like_java_lang_String_java_lang_String_Case_: - -.. _like_java_lang_String__java_lang_String__Case_: - -.. _like_java_lang_String_String_io_realm_Case_: - -.. _like_java_lang_String__String__io_realm_Case_: - -.. _like_java_lang_String_String_Case_: - -.. _like_java_lang_String__String__Case_: - -.. _like_String_java_lang_String_io_realm_Case_: - -.. _like_String__java_lang_String__io_realm_Case_: - -.. _like_String_java_lang_String_Case_: - -.. _like_String__java_lang_String__Case_: - -.. _like_String_String_io_realm_Case_: - -.. _like_String__String__io_realm_Case_: - -.. _like_String_String_Case_: - -.. _like_String__String__Case_: - -.. _RealmQuery_like_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_like_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_like_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_like_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_like_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_like_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_like_java_lang_String_String_Case_: - -.. _RealmQuery_like_java_lang_String__String__Case_: - -.. _RealmQuery_like_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_like_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_like_String_java_lang_String_Case_: - -.. _RealmQuery_like_String__java_lang_String__Case_: - -.. _RealmQuery_like_String_String_io_realm_Case_: - -.. _RealmQuery_like_String__String__io_realm_Case_: - -.. _RealmQuery_like_String_String_Case_: - -.. _RealmQuery_like_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the wildcard string. - - - - - ``casing`` - how to handle casing. Setting this to :ref:`Case.INSENSITIVE ` only works for Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_like_java_lang_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_like_java_lang_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_like_java_lang_String_RealmAny_: - -.. _io_realm_RealmQuery_like_java_lang_String__RealmAny_: - -.. _io_realm_RealmQuery_like_String_io_realm_RealmAny_: - -.. _io_realm_RealmQuery_like_String__io_realm_RealmAny_: - -.. _io_realm_RealmQuery_like_String_RealmAny_: - -.. _io_realm_RealmQuery_like_String__RealmAny_: - -.. _like_java_lang_String_io_realm_RealmAny_: - -.. _like_java_lang_String__io_realm_RealmAny_: - -.. _like_java_lang_String_RealmAny_: - -.. _like_java_lang_String__RealmAny_: - -.. _like_String_io_realm_RealmAny_: - -.. _like_String__io_realm_RealmAny_: - -.. _like_String_RealmAny_: - -.. _like_String__RealmAny_: - -.. _RealmQuery_like_java_lang_String_io_realm_RealmAny_: - -.. _RealmQuery_like_java_lang_String__io_realm_RealmAny_: - -.. _RealmQuery_like_java_lang_String_RealmAny_: - -.. _RealmQuery_like_java_lang_String__RealmAny_: - -.. _RealmQuery_like_String_io_realm_RealmAny_: - -.. _RealmQuery_like_String__io_realm_RealmAny_: - -.. _RealmQuery_like_String_RealmAny_: - -.. _RealmQuery_like_String__RealmAny_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value - | ) - - - - - * - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the wildcard string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_like_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_like_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_like_java_lang_String_String_: - -.. _io_realm_RealmQuery_like_java_lang_String__String_: - -.. _io_realm_RealmQuery_like_String_java_lang_String_: - -.. _io_realm_RealmQuery_like_String__java_lang_String_: - -.. _io_realm_RealmQuery_like_String_String_: - -.. _io_realm_RealmQuery_like_String__String_: - -.. _like_java_lang_String_java_lang_String_: - -.. _like_java_lang_String__java_lang_String_: - -.. _like_java_lang_String_String_: - -.. _like_java_lang_String__String_: - -.. _like_String_java_lang_String_: - -.. _like_String__java_lang_String_: - -.. _like_String_String_: - -.. _like_String__String_: - -.. _RealmQuery_like_java_lang_String_java_lang_String_: - -.. _RealmQuery_like_java_lang_String__java_lang_String_: - -.. _RealmQuery_like_java_lang_String_String_: - -.. _RealmQuery_like_java_lang_String__String_: - -.. _RealmQuery_like_String_java_lang_String_: - -.. _RealmQuery_like_String__java_lang_String_: - -.. _RealmQuery_like_String_String_: - -.. _RealmQuery_like_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`like ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Condition that the value of field matches with the specified substring, with wildcards: - - - '\*' matches [0, n] unicode chars - - - - '?' matches a single unicode char. - - - - - - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the wildcard string. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _limit: - -.. _limit__: - -.. _RealmQuery_limit: - -.. _RealmQuery_limit__: - -.. _io_realm_RealmQuery_limit: - -.. _io_realm_RealmQuery_limit__: - - - -limit ------ - -.. _io_realm_RealmQuery_limit_long_: - -.. _limit_long_: - -.. _RealmQuery_limit_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`limit ` ( - | **long** limit - | ) - - - - - * - Limits the number of objects returned in case the query matched more objects.Note that when using this method in combination with :ref:`sort(String) ` and :ref:`distinct(String, String...) ` they will be executed in the order they where added which can affect the end result. - - - - - - - - - **Parameters** - - - ``limit`` - a limit that is ``≥ 1`` . - - - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the provided ``limit`` is less than 1. - - - - - - - - - - - - - - -.. _max: - -.. _max__: - -.. _RealmQuery_max: - -.. _RealmQuery_max__: - -.. _io_realm_RealmQuery_max: - -.. _io_realm_RealmQuery_max__: - - - -max ----- - -.. _io_realm_RealmQuery_max_java_lang_String_: - -.. _io_realm_RealmQuery_max_String_: - -.. _max_java_lang_String_: - -.. _max_String_: - -.. _RealmQuery_max_java_lang_String_: - -.. _RealmQuery_max_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field to look for a maximum on. Only number fields are supported. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _maxRealmAny: - -.. _maxRealmAny__: - -.. _RealmQuery_maxRealmAny: - -.. _RealmQuery_maxRealmAny__: - -.. _io_realm_RealmQuery_maxRealmAny: - -.. _io_realm_RealmQuery_maxRealmAny__: - - - -maxRealmAny ------------ - -.. _io_realm_RealmQuery_maxRealmAny_java_lang_String_: - -.. _io_realm_RealmQuery_maxRealmAny_String_: - -.. _maxRealmAny_java_lang_String_: - -.. _maxRealmAny_String_: - -.. _RealmQuery_maxRealmAny_java_lang_String_: - -.. _RealmQuery_maxRealmAny_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAny ` :ref:`maxRealmAny ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a :ref:`RealmAny ` field. - - - - - - - **Parameters** - - - ``fieldName`` - the field containing a RealmAny value. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given RealmAny field, :ref:`RealmAny.Type.NULL ` will be returned. Otherwise the maximum RealmAny is returned. When determining the maximum RealmAny, objects with ``null`` values are ignored. See the :ref:`RealmAny ` documentation for more details on how RealmAny values are compared. - - - - - - - **Throws** - - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). - - - - - - - - - - - - -.. _maximumDate: - -.. _maximumDate__: - -.. _RealmQuery_maximumDate: - -.. _RealmQuery_maximumDate__: - -.. _io_realm_RealmQuery_maximumDate: - -.. _io_realm_RealmQuery_maximumDate__: - - - -maximumDate ------------ - -.. _io_realm_RealmQuery_maximumDate_java_lang_String_: - -.. _io_realm_RealmQuery_maximumDate_String_: - -.. _maximumDate_java_lang_String_: - -.. _maximumDate_String_: - -.. _RealmQuery_maximumDate_java_lang_String_: - -.. _RealmQuery_maximumDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`maximumDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field name. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). - - - - - - - - - - - - -.. _min: - -.. _min__: - -.. _RealmQuery_min: - -.. _RealmQuery_min__: - -.. _io_realm_RealmQuery_min: - -.. _io_realm_RealmQuery_min__: - - - -min ----- - -.. _io_realm_RealmQuery_min_java_lang_String_: - -.. _io_realm_RealmQuery_min_String_: - -.. _min_java_lang_String_: - -.. _min_String_: - -.. _RealmQuery_min_java_lang_String_: - -.. _RealmQuery_min_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field to look for a minimum on. Only number fields are supported. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _minRealmAny: - -.. _minRealmAny__: - -.. _RealmQuery_minRealmAny: - -.. _RealmQuery_minRealmAny__: - -.. _io_realm_RealmQuery_minRealmAny: - -.. _io_realm_RealmQuery_minRealmAny__: - - - -minRealmAny ------------ - -.. _io_realm_RealmQuery_minRealmAny_java_lang_String_: - -.. _io_realm_RealmQuery_minRealmAny_String_: - -.. _minRealmAny_java_lang_String_: - -.. _minRealmAny_String_: - -.. _RealmQuery_minRealmAny_java_lang_String_: - -.. _RealmQuery_minRealmAny_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAny ` :ref:`minRealmAny ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a :ref:`RealmAny ` field. - - - - - - - **Parameters** - - - ``fieldName`` - the field containing a RealmAny value. - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given RealmAny field, :ref:`RealmAny.Type.NULL ` will be returned. Otherwise the minimum RealmAny is returned. When determining the minimum RealmAny, objects with ``null`` values are ignored. See the :ref:`RealmAny ` documentation for more details on how RealmAny values are compared. - - - - - - - **Throws** - - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _minimumDate: - -.. _minimumDate__: - -.. _RealmQuery_minimumDate: - -.. _RealmQuery_minimumDate__: - -.. _io_realm_RealmQuery_minimumDate: - -.. _io_realm_RealmQuery_minimumDate__: - - - -minimumDate ------------ - -.. _io_realm_RealmQuery_minimumDate_java_lang_String_: - -.. _io_realm_RealmQuery_minimumDate_String_: - -.. _minimumDate_java_lang_String_: - -.. _minimumDate_String_: - -.. _RealmQuery_minimumDate_java_lang_String_: - -.. _RealmQuery_minimumDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`minimumDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a field. - - - - - **Parameters** - - - ``fieldName`` - the field name - - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with ``null`` values are ignored. - - - - - - - **Throws** - - - `java.lang.UnsupportedOperationException `__ - if the query is not valid ("syntax error"). - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - -.. _not: - -.. _not__: - -.. _RealmQuery_not: - -.. _RealmQuery_not__: - -.. _io_realm_RealmQuery_not: - -.. _io_realm_RealmQuery_not__: - - - -not ----- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`not ` () - | - - - - - * - Negate condition. - - - - - - - **Returns** - - the query object. - - - - - - - - - - - -.. _notEqualTo: - -.. _notEqualTo__: - -.. _RealmQuery_notEqualTo: - -.. _RealmQuery_notEqualTo__: - -.. _io_realm_RealmQuery_notEqualTo: - -.. _io_realm_RealmQuery_notEqualTo__: - - - -notEqualTo ----------- - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_ObjectId_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__ObjectId_: - -.. _io_realm_RealmQuery_notEqualTo_String_ObjectId_: - -.. _io_realm_RealmQuery_notEqualTo_String__ObjectId_: - -.. _notEqualTo_java_lang_String_ObjectId_: - -.. _notEqualTo_java_lang_String__ObjectId_: - -.. _notEqualTo_String_ObjectId_: - -.. _notEqualTo_String__ObjectId_: - -.. _RealmQuery_notEqualTo_java_lang_String_ObjectId_: - -.. _RealmQuery_notEqualTo_java_lang_String__ObjectId_: - -.. _RealmQuery_notEqualTo_String_ObjectId_: - -.. _RealmQuery_notEqualTo_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Not-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_Decimal128_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__Decimal128_: - -.. _io_realm_RealmQuery_notEqualTo_String_Decimal128_: - -.. _io_realm_RealmQuery_notEqualTo_String__Decimal128_: - -.. _notEqualTo_java_lang_String_Decimal128_: - -.. _notEqualTo_java_lang_String__Decimal128_: - -.. _notEqualTo_String_Decimal128_: - -.. _notEqualTo_String__Decimal128_: - -.. _RealmQuery_notEqualTo_java_lang_String_Decimal128_: - -.. _RealmQuery_notEqualTo_java_lang_String__Decimal128_: - -.. _RealmQuery_notEqualTo_String_Decimal128_: - -.. _RealmQuery_notEqualTo_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Not-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__RealmAny__Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_io_realm_RealmAny_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__io_realm_RealmAny__Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_RealmAny_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__RealmAny__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_RealmAny_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__RealmAny__Case_: - -.. _notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _notEqualTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _notEqualTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _notEqualTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _notEqualTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _notEqualTo_java_lang_String_RealmAny_Case_: - -.. _notEqualTo_java_lang_String__RealmAny__Case_: - -.. _notEqualTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _notEqualTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _notEqualTo_String_io_realm_RealmAny_Case_: - -.. _notEqualTo_String__io_realm_RealmAny__Case_: - -.. _notEqualTo_String_RealmAny_io_realm_Case_: - -.. _notEqualTo_String__RealmAny__io_realm_Case_: - -.. _notEqualTo_String_RealmAny_Case_: - -.. _notEqualTo_String__RealmAny__Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_RealmAny_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__RealmAny__Case_: - -.. _RealmQuery_notEqualTo_String_io_realm_RealmAny_io_realm_Case_: - -.. _RealmQuery_notEqualTo_String__io_realm_RealmAny__io_realm_Case_: - -.. _RealmQuery_notEqualTo_String_io_realm_RealmAny_Case_: - -.. _RealmQuery_notEqualTo_String__io_realm_RealmAny__Case_: - -.. _RealmQuery_notEqualTo_String_RealmAny_io_realm_Case_: - -.. _RealmQuery_notEqualTo_String__RealmAny__io_realm_Case_: - -.. _RealmQuery_notEqualTo_String_RealmAny_Case_: - -.. _RealmQuery_notEqualTo_String__RealmAny__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | :ref:`RealmAny ` value, - | :ref:`Case ` casing - | ) - - - - - * - Not-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - ``casing`` - how casing is handled. :ref:`Case.INSENSITIVE ` works only for the Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_String_Case_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__String__Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_java_lang_String_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__java_lang_String__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_java_lang_String_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__java_lang_String__Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_String_io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__String__io_realm_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String_String_Case_: - -.. _io_realm_RealmQuery_notEqualTo_String__String__Case_: - -.. _notEqualTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _notEqualTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _notEqualTo_java_lang_String_java_lang_String_Case_: - -.. _notEqualTo_java_lang_String__java_lang_String__Case_: - -.. _notEqualTo_java_lang_String_String_io_realm_Case_: - -.. _notEqualTo_java_lang_String__String__io_realm_Case_: - -.. _notEqualTo_java_lang_String_String_Case_: - -.. _notEqualTo_java_lang_String__String__Case_: - -.. _notEqualTo_String_java_lang_String_io_realm_Case_: - -.. _notEqualTo_String__java_lang_String__io_realm_Case_: - -.. _notEqualTo_String_java_lang_String_Case_: - -.. _notEqualTo_String__java_lang_String__Case_: - -.. _notEqualTo_String_String_io_realm_Case_: - -.. _notEqualTo_String__String__io_realm_Case_: - -.. _notEqualTo_String_String_Case_: - -.. _notEqualTo_String__String__Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_java_lang_String_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__java_lang_String__Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_String_io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__String__io_realm_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String_String_Case_: - -.. _RealmQuery_notEqualTo_java_lang_String__String__Case_: - -.. _RealmQuery_notEqualTo_String_java_lang_String_io_realm_Case_: - -.. _RealmQuery_notEqualTo_String__java_lang_String__io_realm_Case_: - -.. _RealmQuery_notEqualTo_String_java_lang_String_Case_: - -.. _RealmQuery_notEqualTo_String__java_lang_String__Case_: - -.. _RealmQuery_notEqualTo_String_String_io_realm_Case_: - -.. _RealmQuery_notEqualTo_String__String__io_realm_Case_: - -.. _RealmQuery_notEqualTo_String_String_Case_: - -.. _RealmQuery_notEqualTo_String__String__Case_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value, - | :ref:`Case ` casing - | ) - - - - - * - Not-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - ``casing`` - how casing is handled. :ref:`Case.INSENSITIVE ` works only for the Latin-1 characters. - - - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_java_lang_String_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__java_lang_String_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String_String_: - -.. _io_realm_RealmQuery_notEqualTo_java_lang_String__String_: - -.. _io_realm_RealmQuery_notEqualTo_String_java_lang_String_: - -.. _io_realm_RealmQuery_notEqualTo_String__java_lang_String_: - -.. _io_realm_RealmQuery_notEqualTo_String_String_: - -.. _io_realm_RealmQuery_notEqualTo_String__String_: - -.. _notEqualTo_java_lang_String_java_lang_String_: - -.. _notEqualTo_java_lang_String__java_lang_String_: - -.. _notEqualTo_java_lang_String_String_: - -.. _notEqualTo_java_lang_String__String_: - -.. _notEqualTo_String_java_lang_String_: - -.. _notEqualTo_String__java_lang_String_: - -.. _notEqualTo_String_String_: - -.. _notEqualTo_String__String_: - -.. _RealmQuery_notEqualTo_java_lang_String_java_lang_String_: - -.. _RealmQuery_notEqualTo_java_lang_String__java_lang_String_: - -.. _RealmQuery_notEqualTo_java_lang_String_String_: - -.. _RealmQuery_notEqualTo_java_lang_String__String_: - -.. _RealmQuery_notEqualTo_String_java_lang_String_: - -.. _RealmQuery_notEqualTo_String__java_lang_String_: - -.. _RealmQuery_notEqualTo_String_String_: - -.. _RealmQuery_notEqualTo_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`notEqualTo ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Not-equal-to comparison. - - - - - **Parameters** - - - ``fieldName`` - the field to compare. - - - - - ``value`` - the value to compare with. - - - - - - - - **Returns** - - the query object. - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if one or more arguments do not match class or field type. - - - - - - - - - - - - -.. _or: - -.. _or__: - -.. _RealmQuery_or: - -.. _RealmQuery_or__: - -.. _io_realm_RealmQuery_or: - -.. _io_realm_RealmQuery_or__: - - - -or ----- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`or ` () - | - - - - - * - Logical-or two conditions. - - - - - - - **Returns** - - the query object. - - - - - - - - - - - -.. _rawPredicate: - -.. _rawPredicate__: - -.. _RealmQuery_rawPredicate: - -.. _RealmQuery_rawPredicate__: - -.. _io_realm_RealmQuery_rawPredicate: - -.. _io_realm_RealmQuery_rawPredicate__: - - - -rawPredicate ------------- - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String_java_lang_Object_: - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String__java_lang_Object_: - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String_Object_: - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String__Object_: - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String_Object____: - -.. _io_realm_RealmQuery_rawPredicate_java_lang_String__Object____: - -.. _io_realm_RealmQuery_rawPredicate_String_java_lang_Object_: - -.. _io_realm_RealmQuery_rawPredicate_String__java_lang_Object_: - -.. _io_realm_RealmQuery_rawPredicate_String_Object_: - -.. _io_realm_RealmQuery_rawPredicate_String__Object_: - -.. _io_realm_RealmQuery_rawPredicate_String_Object____: - -.. _io_realm_RealmQuery_rawPredicate_String__Object____: - -.. _rawPredicate_java_lang_String_java_lang_Object_: - -.. _rawPredicate_java_lang_String__java_lang_Object_: - -.. _rawPredicate_java_lang_String_Object_: - -.. _rawPredicate_java_lang_String__Object_: - -.. _rawPredicate_java_lang_String_Object____: - -.. _rawPredicate_java_lang_String__Object____: - -.. _rawPredicate_String_java_lang_Object_: - -.. _rawPredicate_String__java_lang_Object_: - -.. _rawPredicate_String_Object_: - -.. _rawPredicate_String__Object_: - -.. _rawPredicate_String_Object____: - -.. _rawPredicate_String__Object____: - -.. _RealmQuery_rawPredicate_java_lang_String_java_lang_Object_: - -.. _RealmQuery_rawPredicate_java_lang_String__java_lang_Object_: - -.. _RealmQuery_rawPredicate_java_lang_String_Object_: - -.. _RealmQuery_rawPredicate_java_lang_String__Object_: - -.. _RealmQuery_rawPredicate_java_lang_String_Object____: - -.. _RealmQuery_rawPredicate_java_lang_String__Object____: - -.. _RealmQuery_rawPredicate_String_java_lang_Object_: - -.. _RealmQuery_rawPredicate_String__java_lang_Object_: - -.. _RealmQuery_rawPredicate_String_Object_: - -.. _RealmQuery_rawPredicate_String__Object_: - -.. _RealmQuery_rawPredicate_String_Object____: - -.. _RealmQuery_rawPredicate_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`rawPredicate ` ( - | `String `__ predicate, - | `java.lang.Object[] `__ arguments - | ) - - - - - * - Create a text-based predicate using the Realm Query Language. This predicate can be combined with other raw or type safe predicates, it accepts Realm values as arguments.Class and property names used in the raw predicate can be either the names defined in the Realm Model classes or the internal names defined using the :ref:`io.realm.annotations.RealmClass ` or :ref:`io.realm.annotations.RealmField ` annotations. If a class or property name contains spaces those must be escaped. - - - - Arguments are defined in the string predicate as $argument_index, where $argument_index is a decimal integer that specifies the position of the argument in the argument list. The first argument is referenced by $0, the second by $1, etc.See `these docs `__ for a more detailed description of the Realm Query Language. - - Examples: - - - .. code-block:: java - - - RealmQuery query = realm.where(Person.class); - - // Simple query - query.rawPredicate("name = 'Jane'"); - - // Spaces in property name - query.rawPredicate("my\ property = 'Jane'"); - - // Multiple predicates - query.rawPredicate("name = 'Jane' OR name = 'John'") - - // Collection queries - query.rawPredicate("children.@count > 3") - query.rawPredicate("ALL children.age > 18") - - // Sub queries - query.rawPredicate("SUBQUERY(children, $child, $child.age > 21 AND $child.gender = 'male').@count > 0"); - - // Sort, Distinct, Limit - query.rawPredicate("name = 'Jane' SORT(lastName ASC) DISTINCT(city) LIMIT(5)"); - - // Arguments - query.rawPredicate("name = $0 AND age > $1", "Jane", 18); - - - - - - - - - - - **Parameters** - - - ``predicate`` - a Realm Query Language predicate. - - - - - ``arguments`` - Realm values for the predicate. - - - - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if there is an syntax error. - - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _RealmQuery_sort: - -.. _RealmQuery_sort__: - -.. _io_realm_RealmQuery_sort: - -.. _io_realm_RealmQuery_sort__: - - - -sort ----- - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort____: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort____: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort____: - -.. _io_realm_RealmQuery_sort_String__Sort____: - -.. _io_realm_RealmQuery_sort_String____io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_____io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String____Sort_: - -.. _io_realm_RealmQuery_sort_String_____Sort_: - -.. _io_realm_RealmQuery_sort_String____Sort____: - -.. _io_realm_RealmQuery_sort_String_____Sort____: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort____: - -.. _sort_java_lang_String__Sort____: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _sort_String_Sort____: - -.. _sort_String__Sort____: - -.. _sort_String____io_realm_Sort_: - -.. _sort_String_____io_realm_Sort_: - -.. _sort_String____Sort_: - -.. _sort_String_____Sort_: - -.. _sort_String____Sort____: - -.. _sort_String_____Sort____: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort____: - -.. _RealmQuery_sort_java_lang_String__Sort____: - -.. _RealmQuery_sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort_: - -.. _RealmQuery_sort_String_Sort_: - -.. _RealmQuery_sort_String__Sort_: - -.. _RealmQuery_sort_String_Sort____: - -.. _RealmQuery_sort_String__Sort____: - -.. _RealmQuery_sort_String____io_realm_Sort_: - -.. _RealmQuery_sort_String_____io_realm_Sort_: - -.. _RealmQuery_sort_String____Sort_: - -.. _RealmQuery_sort_String_____Sort_: - -.. _RealmQuery_sort_String____Sort____: - -.. _RealmQuery_sort_String_____Sort____: - -.. _io_realm_RealmQuery_sort_String[]__Sort[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `java.lang.String[] `__ fieldNames, - | :ref:`io.realm.Sort[] ` sortOrders - | ) - - - - - * - Sorts the query result by the specific field names in the provided orders. Later fields will only be used if the previous field values are equal.Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect. - - - - - - - **Parameters** - - - ``fieldNames`` - an array of field names to sort by. - - - - - ``sortOrders`` - how to sort the field names. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name does not exist. - - - - - `IllegalStateException `__ - if a sorting order was already defined. - - - - - - - - - - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort__String__Sort_: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort__String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_String_Sort_: - -.. _sort_java_lang_String__Sort__String__Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_String_Sort_: - -.. _sort_String__io_realm_Sort__String__Sort_: - -.. _sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_Sort_java_lang_String_Sort_: - -.. _sort_String__Sort__java_lang_String__Sort_: - -.. _sort_String_Sort_String_io_realm_Sort_: - -.. _sort_String__Sort__String__io_realm_Sort_: - -.. _sort_String_Sort_String_Sort_: - -.. _sort_String__Sort__String__Sort_: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort__String__Sort_: - -.. _RealmQuery_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmQuery_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmQuery_sort_String_io_realm_Sort_String_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort__String__Sort_: - -.. _RealmQuery_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_String_Sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_String__Sort__java_lang_String__Sort_: - -.. _RealmQuery_sort_String_Sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__Sort__String__io_realm_Sort_: - -.. _RealmQuery_sort_String_Sort_String_Sort_: - -.. _RealmQuery_sort_String__Sort__String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - - - * - Sorts the query result by the specific field names in the provided orders. ``fieldName2`` is only used in case of equal values in ``fieldName1`` . - - Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect. - - - - - - - **Parameters** - - - ``fieldName1`` - first field name - - - - - ``sortOrder1`` - sort order for first field - - - - - ``fieldName2`` - second field name - - - - - ``sortOrder2`` - sort order for second field - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name does not exist. - - - - - `IllegalStateException `__ - if a sorting order was already defined. - - - - - - - - - - -.. _io_realm_RealmQuery_sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String_Sort_: - -.. _io_realm_RealmQuery_sort_java_lang_String__Sort_: - -.. _io_realm_RealmQuery_sort_String_io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String__io_realm_Sort_: - -.. _io_realm_RealmQuery_sort_String_Sort_: - -.. _io_realm_RealmQuery_sort_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort_: - -.. _sort_String_Sort_: - -.. _sort_String__Sort_: - -.. _RealmQuery_sort_java_lang_String_io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String__io_realm_Sort_: - -.. _RealmQuery_sort_java_lang_String_Sort_: - -.. _RealmQuery_sort_java_lang_String__Sort_: - -.. _RealmQuery_sort_String_io_realm_Sort_: - -.. _RealmQuery_sort_String__io_realm_Sort_: - -.. _RealmQuery_sort_String_Sort_: - -.. _RealmQuery_sort_String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName, - | :ref:`Sort ` sortOrder - | ) - - - - - * - Sorts the query result by the specified field name and order.Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect. - - - - - - - **Parameters** - - - ``fieldName`` - the field name to sort by. - - - - - ``sortOrder`` - how to sort the results. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name does not exist. - - - - - `IllegalStateException `__ - if a sorting order was already defined. - - - - - - - - - - -.. _io_realm_RealmQuery_sort_java_lang_String_: - -.. _io_realm_RealmQuery_sort_String_: - -.. _sort_java_lang_String_: - -.. _sort_String_: - -.. _RealmQuery_sort_java_lang_String_: - -.. _RealmQuery_sort_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`sort ` ( - | `String `__ fieldName - | ) - - - - - * - Sorts the query result by the specific field name in ascending order.Sorting is currently limited to character sets in 'Latin Basic', 'Latin Supplement', 'Latin Extended A', 'Latin Extended B' (UTF-8 range 0-591). For other character sets, sorting will have no effect. - - - - - - - **Parameters** - - - ``fieldName`` - the field name to sort by. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field name does not exist. - - - - - `IllegalStateException `__ - if a sorting order was already defined. - - - - - - - - - - - - -.. _sum: - -.. _sum__: - -.. _RealmQuery_sum: - -.. _RealmQuery_sum__: - -.. _io_realm_RealmQuery_sum: - -.. _io_realm_RealmQuery_sum__: - - - -sum ----- - -.. _io_realm_RealmQuery_sum_java_lang_String_: - -.. _io_realm_RealmQuery_sum_String_: - -.. _sum_java_lang_String_: - -.. _sum_String_: - -.. _RealmQuery_sum_java_lang_String_: - -.. _RealmQuery_sum_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName - | ) - - - - - * - Calculates the sum of a given field. - - - - - **Parameters** - - - ``fieldName`` - the field to sum. Only number and RealmAny fields are supported. - - - - - - - - **Returns** - - the sum of fields of the matching objects. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the sum, objects with ``null`` values are ignored. When applied to a RealmAny field, only numeric values will be summed up (Byte/Integer/Integer/Long/Float/Double/Decimal128) and the returning type will be ``Decimal128`` . - - - - - - - **Throws** - - - `java.lang.IllegalArgumentException `__ - if the field is not a number type. - - - - - :ref:`RealmException ` - if called from the UI thread after opting out via :ref:`RealmConfiguration.Builder.allowQueriesOnUiThread(boolean) ` . - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmResults.txt b/source/sdk/java/api/io/realm/RealmResults.txt deleted file mode 100644 index 9ca2e7e568..0000000000 --- a/source/sdk/java/api/io/realm/RealmResults.txt +++ /dev/null @@ -1,3389 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmResults -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmResults: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.util.AbstractCollection `__ - | `java.util.AbstractList `__ - | **io.realm.OrderedRealmCollectionImpl** - | io.realm.RealmResults - - -This class holds all the matches of a :ref:`RealmQuery ` for a given Realm. The objects are not copied from the Realm to the RealmResults list, but are just referenced from the RealmResult instead. This saves memory and increases speed. - -RealmResults are live views, which means that if it is on an **Looper** thread, it will automatically update its query results after a transaction has been committed. If on a non-looper thread, **Realm.refresh()** must be called to update the results. - - - -Updates to RealmObjects from a RealmResults list must be done from within a transaction and the modified objects are persisted to the Realm file during the commit of the transaction. - -A RealmResults object cannot be passed between different threads. - -Notice that a RealmResults is never ``null`` not even in the case where it contains no objects. You should always use the **RealmResults.size()** method to check if a RealmResults is empty or not. - - - -If a RealmResults is built on RealmList through :ref:`RealmList.where() ` , it will become empty when the source RealmList gets deleted. - - - -:ref:`RealmResults ` can contain more elements than ``Integer.MAX_VALUE`` . In that case, you can access only first ``Integer.MAX_VALUE`` elements in it. - - - - - - -.. seealso:: - - - - - :ref:`RealmQuery.findAll() ` - - - - - :ref:`Realm.executeTransaction(Realm.Transaction) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmResults ` . - - - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`asChangesetObservable ` () - | - - - Returns an Rx Observable that monitors changes to this RealmResults. - - - - - * - public **** - - | :ref:`asFlowable ` () - | - - - Returns an Rx Flowable that monitors changes to this RealmResults. - - - - - * - public `String `__ - - | :ref:`asJSON ` () - | - - - Returns a JSON representation of the matches of a :ref:`RealmQuery ` . - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`freeze ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isFrozen ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - Returns ``false`` if the results are not yet loaded, ``true`` if they are loaded. - - - - - - - * - public **boolean** - - | :ref:`load ` () - | - - - Makes an asynchronous query blocking. - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **void** - - | :ref:`setBlob ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - Sets the binary value of the given field in all of the objects in the collection. - - - - - * - public **void** - - | :ref:`setBoolean ` ( - | `String `__ fieldName, - | **boolean** value - | ) - - - Sets the ``boolean`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setByte ` ( - | `String `__ fieldName, - | **byte** value - | ) - - - Sets the ``byte`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - Sets the ``Date`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setDecimal128 ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - Sets the ``Decimal128`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setDouble ` ( - | `String `__ fieldName, - | **double** value - | ) - - - Sets the ``double`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setFloat ` ( - | `String `__ fieldName, - | **float** value - | ) - - - Sets the ``float`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setInt ` ( - | `String `__ fieldName, - | **int** value - | ) - - - Sets the ``int`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setList ` <**T** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Replaces the RealmList at the given field on all objects in this collection. - - - - - * - public **void** - - | :ref:`setLong ` ( - | `String `__ fieldName, - | **long** value - | ) - - - Sets the ``long`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setNull ` ( - | `String `__ fieldName - | ) - - - Sets the value to ``null`` for the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setObject ` ( - | `String `__ fieldName, - | :ref:`RealmModel ` value - | ) - - - Sets a reference to another object on the given field in all of the objects in the collection. - - - - - * - public **void** - - | :ref:`setObjectId ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - Sets the ``ObjectId`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setShort ` ( - | `String `__ fieldName, - | **short** value - | ) - - - Sets the ``short`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - Sets the ``String`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setUUID ` ( - | `String `__ fieldName, - | `UUID `__ value - | ) - - - Sets the ``UUID`` value of the given field in all of the objects in the collection. - - - - - - - * - public **void** - - | :ref:`setValue ` ( - | `String `__ fieldName, - | `Object `__ value - | ) - - - Updates the field given by ``fieldName`` in all objects inside the query result. - - - - - - - * - public :ref:`RealmResults ` - - | :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - Sorts a collection based on the provided fields and sort orders. - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` () - | - - - Returns a :ref:`RealmQuery ` , which can be used to query for specific objects from this collection. - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.util.AbstractCollection `__ : ``iterator`` , ``size`` , ``isEmpty`` , ``contains`` , ``toArray`` , ``toArray`` , ``add`` , ``remove`` , ``containsAll`` , ``addAll`` , ``removeAll`` , ``retainAll`` , ``clear`` , ``toString`` -- Methods inherited from class `java.util.AbstractList `__ : ``add`` , ``get`` , ``set`` , ``add`` , ``remove`` , ``indexOf`` , ``lastIndexOf`` , ``clear`` , ``addAll`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``subList`` , ``equals`` , ``hashCode`` , ``removeRange`` -- Methods inherited from class **io.realm.OrderedRealmCollectionImpl**: ``isValid`` , ``isManaged`` , ``contains`` , ``get`` , ``first`` , ``first`` , ``last`` , ``last`` , ``deleteFromRealm`` , ``deleteAllFromRealm`` , ``iterator`` , ``listIterator`` , ``listIterator`` , ``sort`` , ``sort`` , ``sort`` , ``sort`` , ``size`` , ``min`` , ``minDate`` , ``max`` , ``maxDate`` , ``sum`` , ``average`` , ``remove`` , ``remove`` , ``removeAll`` , ``set`` , ``retainAll`` , ``deleteLastFromRealm`` , ``deleteFirstFromRealm`` , ``clear`` , ``add`` , ``add`` , ``addAll`` , ``addAll`` , ``createSnapshot`` , ``getRealm`` , ``getCollectionOperator`` - - - - -Method Detail -============= - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _RealmResults_addChangeListener: - -.. _RealmResults_addChangeListener__: - -.. _io_realm_RealmResults_addChangeListener: - -.. _io_realm_RealmResults_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_RealmResults_addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmResults_addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _RealmResults_addChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _RealmResults_addChangeListener_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmResults_addChangeListener_OrderedRealmCollectionChangeListener_RealmResults_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmResults ` . - - Registering a change listener will not prevent the underlying RealmResults from being garbage collected. If the RealmResults is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmResults results; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - results = realm.where(Person.class).findAllAsync(); - results.addChangeListener(new OrderedRealmCollectionChangeListener>() { - @Override - public void onChange(RealmResults persons, OrderedCollectionChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - -.. _io_realm_RealmResults_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmResults_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _RealmResults_addChangeListener_io_realm_RealmChangeListener_: - -.. _RealmResults_addChangeListener_RealmChangeListener_: - -.. _io_realm_RealmResults_addChangeListener_RealmChangeListener_RealmResults_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmResults ` . - - Registering a change listener will not prevent the underlying RealmResults from being garbage collected. If the RealmResults is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmResults results; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - results = realm.where(Person.class).findAllAsync(); - results.addChangeListener(new RealmChangeListener>() { - @Override - public void onChange(RealmResults persons) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the change listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - - - -.. _asChangesetObservable: - -.. _asChangesetObservable__: - -.. _RealmResults_asChangesetObservable: - -.. _RealmResults_asChangesetObservable__: - -.. _io_realm_RealmResults_asChangesetObservable: - -.. _io_realm_RealmResults_asChangesetObservable__: - - - -asChangesetObservable ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asChangesetObservable ` () - | - - - - - * - Returns an Rx Observable that monitors changes to this RealmResults. It will emit the current RealmResults when subscribed. For each update to the RealmResult a pair consisting of the RealmResults and the :ref:`OrderedCollectionChangeSet ` will be sent. The changeset will be ``null`` the first time an RealmResults is emitted. - - RealmResults will continually be emitted as the RealmResults are updated - ``onComplete`` will never be called. - - - - Items emitted from Realm Observables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Observables always emit items from the thread holding the live Realm. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - realm.where(Foo.class).findAllAsync().asChangesetObservable() - .observeOn(Schedulers.computation()) - .map((rxResults, changes) -> doExpensiveWork(rxResults, changes)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _asFlowable: - -.. _asFlowable__: - -.. _RealmResults_asFlowable: - -.. _RealmResults_asFlowable__: - -.. _io_realm_RealmResults_asFlowable: - -.. _io_realm_RealmResults_asFlowable__: - - - -asFlowable ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`asFlowable ` () - | - - - - - * - Returns an Rx Flowable that monitors changes to this RealmResults. It will emit the current RealmResults when subscribed to. RealmResults will continually be emitted as the RealmResults are updated - ``onComplete`` will never be called. - - Items emitted from Realm Flowables are frozen (See :ref:`freeze() ` . This means that they are immutable and can be read on any thread. - - - - Realm Flowables always emit items from the thread holding the live RealmResults. This means that if you need to do further processing, it is recommend to observe the values on a computation scheduler: - - - - .. code-block:: java - - realm.where(Foo.class).findAllAsync().asFlowable() - .observeOn(Schedulers.computation()) - .map(rxResults -> doExpensiveWork(rxResults)) - .observeOn(AndroidSchedulers.mainThread()) - .subscribe( ... ); - - - - - - - If you would like the ``asFlowable()`` to stop emitting items you can instruct RxJava to only emit only the first item by using the ``first()`` operator: - - - - - - .. code-block:: java - - - realm.where(Foo.class).findAllAsync().asFlowable() - .filter(results -> results.isLoaded()) - .first() - .subscribe( ... ) // You only get the results once - - - - - - - - - - - - - **Returns** - - RxJava Observable that only calls ``onNext`` . It will never call ``onComplete`` or ``OnError`` . - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if the required RxJava framework is not on the classpath or the corresponding Realm instance doesn't support RxJava. - - - - - `IllegalStateException `__ - if the Realm wasn't opened on a Looper thread. - - - - - - - - - - .. seealso:: - - - - - `RxJava and Realm `__ - - - - - - - - - - - - - -.. _asJSON: - -.. _asJSON__: - -.. _RealmResults_asJSON: - -.. _RealmResults_asJSON__: - -.. _io_realm_RealmResults_asJSON: - -.. _io_realm_RealmResults_asJSON__: - - - -asJSON ------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`asJSON ` () - | - - - - - * - Returns a JSON representation of the matches of a :ref:`RealmQuery ` . Cycles will be returned as row indices. This is a helper method used to inspect data, or for debugging purpose, this method could pull a large string which could cause an OutOfMemory error. - - - - - - - - - **Returns** - - string representation of a JSON array containing entries of the resulting :ref:`RealmQuery ` . - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmResults_freeze: - -.. _RealmResults_freeze__: - -.. _io_realm_RealmResults_freeze: - -.. _io_realm_RealmResults_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`freeze ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _RealmResults_isFrozen: - -.. _RealmResults_isFrozen__: - -.. _io_realm_RealmResults_isFrozen: - -.. _io_realm_RealmResults_isFrozen__: - - - -isFrozen --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFrozen ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _RealmResults_isLoaded: - -.. _RealmResults_isLoaded__: - -.. _io_realm_RealmResults_isLoaded: - -.. _io_realm_RealmResults_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - Returns ``false`` if the results are not yet loaded, ``true`` if they are loaded. - - - - - - - - - **Returns** - - ``true`` if the query has completed and the data is available, ``false`` if the query is still running in the background. - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _RealmResults_load: - -.. _RealmResults_load__: - -.. _io_realm_RealmResults_load: - -.. _io_realm_RealmResults_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`load ` () - | - - - - - * - Makes an asynchronous query blocking. This will also trigger any registered :ref:`RealmChangeListener ` when the query completes. - - - - - - - - - **Returns** - - ``true`` if it successfully completed the query, ``false`` otherwise. - - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _RealmResults_removeAllChangeListeners: - -.. _RealmResults_removeAllChangeListeners__: - -.. _io_realm_RealmResults_removeAllChangeListeners: - -.. _io_realm_RealmResults_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _RealmResults_removeChangeListener: - -.. _RealmResults_removeChangeListener__: - -.. _io_realm_RealmResults_removeChangeListener: - -.. _io_realm_RealmResults_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_RealmResults_removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmResults_removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _RealmResults_removeChangeListener_io_realm_OrderedRealmCollectionChangeListener_: - -.. _RealmResults_removeChangeListener_OrderedRealmCollectionChangeListener_: - -.. _io_realm_RealmResults_removeChangeListener_OrderedRealmCollectionChangeListener_RealmResults_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.OrderedRealmCollectionChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - -.. _io_realm_RealmResults_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmResults_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _RealmResults_removeChangeListener_io_realm_RealmChangeListener_: - -.. _RealmResults_removeChangeListener_RealmChangeListener_: - -.. _io_realm_RealmResults_removeChangeListener_RealmChangeListener_RealmResults_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _setBlob: - -.. _setBlob__: - -.. _RealmResults_setBlob: - -.. _RealmResults_setBlob__: - -.. _io_realm_RealmResults_setBlob: - -.. _io_realm_RealmResults_setBlob__: - - - -setBlob -------- - -.. _io_realm_RealmResults_setBlob_java_lang_String_byte_: - -.. _io_realm_RealmResults_setBlob_java_lang_String__byte_: - -.. _io_realm_RealmResults_setBlob_java_lang_String_byte____: - -.. _io_realm_RealmResults_setBlob_java_lang_String__byte____: - -.. _io_realm_RealmResults_setBlob_String_byte_: - -.. _io_realm_RealmResults_setBlob_String__byte_: - -.. _io_realm_RealmResults_setBlob_String_byte____: - -.. _io_realm_RealmResults_setBlob_String__byte____: - -.. _setBlob_java_lang_String_byte_: - -.. _setBlob_java_lang_String__byte_: - -.. _setBlob_java_lang_String_byte____: - -.. _setBlob_java_lang_String__byte____: - -.. _setBlob_String_byte_: - -.. _setBlob_String__byte_: - -.. _setBlob_String_byte____: - -.. _setBlob_String__byte____: - -.. _RealmResults_setBlob_java_lang_String_byte_: - -.. _RealmResults_setBlob_java_lang_String__byte_: - -.. _RealmResults_setBlob_java_lang_String_byte____: - -.. _RealmResults_setBlob_java_lang_String__byte____: - -.. _RealmResults_setBlob_String_byte_: - -.. _RealmResults_setBlob_String__byte_: - -.. _RealmResults_setBlob_String_byte____: - -.. _RealmResults_setBlob_String__byte____: - -.. _io_realm_RealmResults_setBlob_String__byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBlob ` ( - | `String `__ fieldName, - | **byte[]** value - | ) - - - - - * - Sets the binary value of the given field in all of the objects in the collection. - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a binary field. - - - - - - - - - - - - -.. _setBoolean: - -.. _setBoolean__: - -.. _RealmResults_setBoolean: - -.. _RealmResults_setBoolean__: - -.. _io_realm_RealmResults_setBoolean: - -.. _io_realm_RealmResults_setBoolean__: - - - -setBoolean ----------- - -.. _io_realm_RealmResults_setBoolean_java_lang_String_boolean_: - -.. _io_realm_RealmResults_setBoolean_java_lang_String__boolean_: - -.. _io_realm_RealmResults_setBoolean_String_boolean_: - -.. _io_realm_RealmResults_setBoolean_String__boolean_: - -.. _setBoolean_java_lang_String_boolean_: - -.. _setBoolean_java_lang_String__boolean_: - -.. _setBoolean_String_boolean_: - -.. _setBoolean_String__boolean_: - -.. _RealmResults_setBoolean_java_lang_String_boolean_: - -.. _RealmResults_setBoolean_java_lang_String__boolean_: - -.. _RealmResults_setBoolean_String_boolean_: - -.. _RealmResults_setBoolean_String__boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setBoolean ` ( - | `String `__ fieldName, - | **boolean** value - | ) - - - - - * - Sets the ``boolean`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a boolean field. - - - - - - - - - - - - -.. _setByte: - -.. _setByte__: - -.. _RealmResults_setByte: - -.. _RealmResults_setByte__: - -.. _io_realm_RealmResults_setByte: - -.. _io_realm_RealmResults_setByte__: - - - -setByte -------- - -.. _io_realm_RealmResults_setByte_java_lang_String_byte_: - -.. _io_realm_RealmResults_setByte_java_lang_String__byte_: - -.. _io_realm_RealmResults_setByte_String_byte_: - -.. _io_realm_RealmResults_setByte_String__byte_: - -.. _setByte_java_lang_String_byte_: - -.. _setByte_java_lang_String__byte_: - -.. _setByte_String_byte_: - -.. _setByte_String__byte_: - -.. _RealmResults_setByte_java_lang_String_byte_: - -.. _RealmResults_setByte_java_lang_String__byte_: - -.. _RealmResults_setByte_String_byte_: - -.. _RealmResults_setByte_String__byte_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setByte ` ( - | `String `__ fieldName, - | **byte** value - | ) - - - - - * - Sets the ``byte`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a byte field. - - - - - - - - - - - - -.. _setDate: - -.. _setDate__: - -.. _RealmResults_setDate: - -.. _RealmResults_setDate__: - -.. _io_realm_RealmResults_setDate: - -.. _io_realm_RealmResults_setDate__: - - - -setDate -------- - -.. _io_realm_RealmResults_setDate_java_lang_String_java_util_Date_: - -.. _io_realm_RealmResults_setDate_java_lang_String__java_util_Date_: - -.. _io_realm_RealmResults_setDate_java_lang_String_Date_: - -.. _io_realm_RealmResults_setDate_java_lang_String__Date_: - -.. _io_realm_RealmResults_setDate_String_java_util_Date_: - -.. _io_realm_RealmResults_setDate_String__java_util_Date_: - -.. _io_realm_RealmResults_setDate_String_Date_: - -.. _io_realm_RealmResults_setDate_String__Date_: - -.. _setDate_java_lang_String_java_util_Date_: - -.. _setDate_java_lang_String__java_util_Date_: - -.. _setDate_java_lang_String_Date_: - -.. _setDate_java_lang_String__Date_: - -.. _setDate_String_java_util_Date_: - -.. _setDate_String__java_util_Date_: - -.. _setDate_String_Date_: - -.. _setDate_String__Date_: - -.. _RealmResults_setDate_java_lang_String_java_util_Date_: - -.. _RealmResults_setDate_java_lang_String__java_util_Date_: - -.. _RealmResults_setDate_java_lang_String_Date_: - -.. _RealmResults_setDate_java_lang_String__Date_: - -.. _RealmResults_setDate_String_java_util_Date_: - -.. _RealmResults_setDate_String__java_util_Date_: - -.. _RealmResults_setDate_String_Date_: - -.. _RealmResults_setDate_String__Date_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDate ` ( - | `String `__ fieldName, - | `Date `__ value - | ) - - - - - * - Sets the ``Date`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Date`` field. - - - - - - - - - - - - - - -.. _setDecimal128: - -.. _setDecimal128__: - -.. _RealmResults_setDecimal128: - -.. _RealmResults_setDecimal128__: - -.. _io_realm_RealmResults_setDecimal128: - -.. _io_realm_RealmResults_setDecimal128__: - - - -setDecimal128 -------------- - -.. _io_realm_RealmResults_setDecimal128_java_lang_String_Decimal128_: - -.. _io_realm_RealmResults_setDecimal128_java_lang_String__Decimal128_: - -.. _io_realm_RealmResults_setDecimal128_String_Decimal128_: - -.. _io_realm_RealmResults_setDecimal128_String__Decimal128_: - -.. _setDecimal128_java_lang_String_Decimal128_: - -.. _setDecimal128_java_lang_String__Decimal128_: - -.. _setDecimal128_String_Decimal128_: - -.. _setDecimal128_String__Decimal128_: - -.. _RealmResults_setDecimal128_java_lang_String_Decimal128_: - -.. _RealmResults_setDecimal128_java_lang_String__Decimal128_: - -.. _RealmResults_setDecimal128_String_Decimal128_: - -.. _RealmResults_setDecimal128_String__Decimal128_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDecimal128 ` ( - | `String `__ fieldName, - | **Decimal128** value - | ) - - - - - * - Sets the ``Decimal128`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``Decimal128`` field. - - - - - - - - - - - - - - -.. _setDouble: - -.. _setDouble__: - -.. _RealmResults_setDouble: - -.. _RealmResults_setDouble__: - -.. _io_realm_RealmResults_setDouble: - -.. _io_realm_RealmResults_setDouble__: - - - -setDouble ---------- - -.. _io_realm_RealmResults_setDouble_java_lang_String_double_: - -.. _io_realm_RealmResults_setDouble_java_lang_String__double_: - -.. _io_realm_RealmResults_setDouble_String_double_: - -.. _io_realm_RealmResults_setDouble_String__double_: - -.. _setDouble_java_lang_String_double_: - -.. _setDouble_java_lang_String__double_: - -.. _setDouble_String_double_: - -.. _setDouble_String__double_: - -.. _RealmResults_setDouble_java_lang_String_double_: - -.. _RealmResults_setDouble_java_lang_String__double_: - -.. _RealmResults_setDouble_String_double_: - -.. _RealmResults_setDouble_String__double_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setDouble ` ( - | `String `__ fieldName, - | **double** value - | ) - - - - - * - Sets the ``double`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a double field. - - - - - - - - - - - - -.. _setFloat: - -.. _setFloat__: - -.. _RealmResults_setFloat: - -.. _RealmResults_setFloat__: - -.. _io_realm_RealmResults_setFloat: - -.. _io_realm_RealmResults_setFloat__: - - - -setFloat --------- - -.. _io_realm_RealmResults_setFloat_java_lang_String_float_: - -.. _io_realm_RealmResults_setFloat_java_lang_String__float_: - -.. _io_realm_RealmResults_setFloat_String_float_: - -.. _io_realm_RealmResults_setFloat_String__float_: - -.. _setFloat_java_lang_String_float_: - -.. _setFloat_java_lang_String__float_: - -.. _setFloat_String_float_: - -.. _setFloat_String__float_: - -.. _RealmResults_setFloat_java_lang_String_float_: - -.. _RealmResults_setFloat_java_lang_String__float_: - -.. _RealmResults_setFloat_String_float_: - -.. _RealmResults_setFloat_String__float_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setFloat ` ( - | `String `__ fieldName, - | **float** value - | ) - - - - - * - Sets the ``float`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a float field. - - - - - - - - - - - - -.. _setInt: - -.. _setInt__: - -.. _RealmResults_setInt: - -.. _RealmResults_setInt__: - -.. _io_realm_RealmResults_setInt: - -.. _io_realm_RealmResults_setInt__: - - - -setInt ------- - -.. _io_realm_RealmResults_setInt_java_lang_String_int_: - -.. _io_realm_RealmResults_setInt_java_lang_String__int_: - -.. _io_realm_RealmResults_setInt_String_int_: - -.. _io_realm_RealmResults_setInt_String__int_: - -.. _setInt_java_lang_String_int_: - -.. _setInt_java_lang_String__int_: - -.. _setInt_String_int_: - -.. _setInt_String__int_: - -.. _RealmResults_setInt_java_lang_String_int_: - -.. _RealmResults_setInt_java_lang_String__int_: - -.. _RealmResults_setInt_String_int_: - -.. _RealmResults_setInt_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setInt ` ( - | `String `__ fieldName, - | **int** value - | ) - - - - - * - Sets the ``int`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an integer field. - - - - - - - - - - - - -.. _setList: - -.. _setList__: - -.. _RealmResults_setList: - -.. _RealmResults_setList__: - -.. _io_realm_RealmResults_setList: - -.. _io_realm_RealmResults_setList__: - - - -setList -------- - -.. _io_realm_RealmResults_setList_java_lang_String_io_realm_RealmList_: - -.. _io_realm_RealmResults_setList_java_lang_String__io_realm_RealmList_: - -.. _io_realm_RealmResults_setList_java_lang_String_RealmList_: - -.. _io_realm_RealmResults_setList_java_lang_String__RealmList_: - -.. _io_realm_RealmResults_setList_String_io_realm_RealmList_: - -.. _io_realm_RealmResults_setList_String__io_realm_RealmList_: - -.. _io_realm_RealmResults_setList_String_RealmList_: - -.. _io_realm_RealmResults_setList_String__RealmList_: - -.. _setList_java_lang_String_io_realm_RealmList_: - -.. _setList_java_lang_String__io_realm_RealmList_: - -.. _setList_java_lang_String_RealmList_: - -.. _setList_java_lang_String__RealmList_: - -.. _setList_String_io_realm_RealmList_: - -.. _setList_String__io_realm_RealmList_: - -.. _setList_String_RealmList_: - -.. _setList_String__RealmList_: - -.. _RealmResults_setList_java_lang_String_io_realm_RealmList_: - -.. _RealmResults_setList_java_lang_String__io_realm_RealmList_: - -.. _RealmResults_setList_java_lang_String_RealmList_: - -.. _RealmResults_setList_java_lang_String__RealmList_: - -.. _RealmResults_setList_String_io_realm_RealmList_: - -.. _RealmResults_setList_String__io_realm_RealmList_: - -.. _RealmResults_setList_String_RealmList_: - -.. _RealmResults_setList_String__RealmList_: - -.. _io_realm_RealmResults_setList_String__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setList ` <**T** >( - | `String `__ fieldName, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Replaces the RealmList at the given field on all objects in this collection. - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``list`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, isn't a RealmList field , if the objects in the list are not managed or the type of the objects in the list are wrong. - - - - - - - - - - - - -.. _setLong: - -.. _setLong__: - -.. _RealmResults_setLong: - -.. _RealmResults_setLong__: - -.. _io_realm_RealmResults_setLong: - -.. _io_realm_RealmResults_setLong__: - - - -setLong -------- - -.. _io_realm_RealmResults_setLong_java_lang_String_long_: - -.. _io_realm_RealmResults_setLong_java_lang_String__long_: - -.. _io_realm_RealmResults_setLong_String_long_: - -.. _io_realm_RealmResults_setLong_String__long_: - -.. _setLong_java_lang_String_long_: - -.. _setLong_java_lang_String__long_: - -.. _setLong_String_long_: - -.. _setLong_String__long_: - -.. _RealmResults_setLong_java_lang_String_long_: - -.. _RealmResults_setLong_java_lang_String__long_: - -.. _RealmResults_setLong_String_long_: - -.. _RealmResults_setLong_String__long_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setLong ` ( - | `String `__ fieldName, - | **long** value - | ) - - - - - * - Sets the ``long`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a long field. - - - - - - - - - - - - -.. _setNull: - -.. _setNull__: - -.. _RealmResults_setNull: - -.. _RealmResults_setNull__: - -.. _io_realm_RealmResults_setNull: - -.. _io_realm_RealmResults_setNull__: - - - -setNull -------- - -.. _io_realm_RealmResults_setNull_java_lang_String_: - -.. _io_realm_RealmResults_setNull_String_: - -.. _setNull_java_lang_String_: - -.. _setNull_String_: - -.. _RealmResults_setNull_java_lang_String_: - -.. _RealmResults_setNull_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setNull ` ( - | `String `__ fieldName - | ) - - - - - * - Sets the value to ``null`` for the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist or is a primary key property. - - - - - `IllegalStateException `__ - if the field cannot hold ``null`` values. - - - - - - - - - - - - - - -.. _setObject: - -.. _setObject__: - -.. _RealmResults_setObject: - -.. _RealmResults_setObject__: - -.. _io_realm_RealmResults_setObject: - -.. _io_realm_RealmResults_setObject__: - - - -setObject ---------- - -.. _io_realm_RealmResults_setObject_java_lang_String_io_realm_RealmModel_: - -.. _io_realm_RealmResults_setObject_java_lang_String__io_realm_RealmModel_: - -.. _io_realm_RealmResults_setObject_java_lang_String_RealmModel_: - -.. _io_realm_RealmResults_setObject_java_lang_String__RealmModel_: - -.. _io_realm_RealmResults_setObject_String_io_realm_RealmModel_: - -.. _io_realm_RealmResults_setObject_String__io_realm_RealmModel_: - -.. _io_realm_RealmResults_setObject_String_RealmModel_: - -.. _io_realm_RealmResults_setObject_String__RealmModel_: - -.. _setObject_java_lang_String_io_realm_RealmModel_: - -.. _setObject_java_lang_String__io_realm_RealmModel_: - -.. _setObject_java_lang_String_RealmModel_: - -.. _setObject_java_lang_String__RealmModel_: - -.. _setObject_String_io_realm_RealmModel_: - -.. _setObject_String__io_realm_RealmModel_: - -.. _setObject_String_RealmModel_: - -.. _setObject_String__RealmModel_: - -.. _RealmResults_setObject_java_lang_String_io_realm_RealmModel_: - -.. _RealmResults_setObject_java_lang_String__io_realm_RealmModel_: - -.. _RealmResults_setObject_java_lang_String_RealmModel_: - -.. _RealmResults_setObject_java_lang_String__RealmModel_: - -.. _RealmResults_setObject_String_io_realm_RealmModel_: - -.. _RealmResults_setObject_String__io_realm_RealmModel_: - -.. _RealmResults_setObject_String_RealmModel_: - -.. _RealmResults_setObject_String__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setObject ` ( - | `String `__ fieldName, - | :ref:`RealmModel ` value - | ) - - - - - * - Sets a reference to another object on the given field in all of the objects in the collection. - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new object referenced by this field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't an Object reference field. - - - - - - - - - - - - -.. _setObjectId: - -.. _setObjectId__: - -.. _RealmResults_setObjectId: - -.. _RealmResults_setObjectId__: - -.. _io_realm_RealmResults_setObjectId: - -.. _io_realm_RealmResults_setObjectId__: - - - -setObjectId ------------ - -.. _io_realm_RealmResults_setObjectId_java_lang_String_ObjectId_: - -.. _io_realm_RealmResults_setObjectId_java_lang_String__ObjectId_: - -.. _io_realm_RealmResults_setObjectId_String_ObjectId_: - -.. _io_realm_RealmResults_setObjectId_String__ObjectId_: - -.. _setObjectId_java_lang_String_ObjectId_: - -.. _setObjectId_java_lang_String__ObjectId_: - -.. _setObjectId_String_ObjectId_: - -.. _setObjectId_String__ObjectId_: - -.. _RealmResults_setObjectId_java_lang_String_ObjectId_: - -.. _RealmResults_setObjectId_java_lang_String__ObjectId_: - -.. _RealmResults_setObjectId_String_ObjectId_: - -.. _RealmResults_setObjectId_String__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setObjectId ` ( - | `String `__ fieldName, - | **ObjectId** value - | ) - - - - - * - Sets the ``ObjectId`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``ObjectId`` field. - - - - - - - - - - - - - - -.. _setShort: - -.. _setShort__: - -.. _RealmResults_setShort: - -.. _RealmResults_setShort__: - -.. _io_realm_RealmResults_setShort: - -.. _io_realm_RealmResults_setShort__: - - - -setShort --------- - -.. _io_realm_RealmResults_setShort_java_lang_String_short_: - -.. _io_realm_RealmResults_setShort_java_lang_String__short_: - -.. _io_realm_RealmResults_setShort_String_short_: - -.. _io_realm_RealmResults_setShort_String__short_: - -.. _setShort_java_lang_String_short_: - -.. _setShort_java_lang_String__short_: - -.. _setShort_String_short_: - -.. _setShort_String__short_: - -.. _RealmResults_setShort_java_lang_String_short_: - -.. _RealmResults_setShort_java_lang_String__short_: - -.. _RealmResults_setShort_String_short_: - -.. _RealmResults_setShort_String__short_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setShort ` ( - | `String `__ fieldName, - | **short** value - | ) - - - - - * - Sets the ``short`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a short field. - - - - - - - - - - - - -.. _setString: - -.. _setString__: - -.. _RealmResults_setString: - -.. _RealmResults_setString__: - -.. _io_realm_RealmResults_setString: - -.. _io_realm_RealmResults_setString__: - - - -setString ---------- - -.. _io_realm_RealmResults_setString_java_lang_String_java_lang_String_: - -.. _io_realm_RealmResults_setString_java_lang_String__java_lang_String_: - -.. _io_realm_RealmResults_setString_java_lang_String_String_: - -.. _io_realm_RealmResults_setString_java_lang_String__String_: - -.. _io_realm_RealmResults_setString_String_java_lang_String_: - -.. _io_realm_RealmResults_setString_String__java_lang_String_: - -.. _io_realm_RealmResults_setString_String_String_: - -.. _io_realm_RealmResults_setString_String__String_: - -.. _setString_java_lang_String_java_lang_String_: - -.. _setString_java_lang_String__java_lang_String_: - -.. _setString_java_lang_String_String_: - -.. _setString_java_lang_String__String_: - -.. _setString_String_java_lang_String_: - -.. _setString_String__java_lang_String_: - -.. _setString_String_String_: - -.. _setString_String__String_: - -.. _RealmResults_setString_java_lang_String_java_lang_String_: - -.. _RealmResults_setString_java_lang_String__java_lang_String_: - -.. _RealmResults_setString_java_lang_String_String_: - -.. _RealmResults_setString_java_lang_String__String_: - -.. _RealmResults_setString_String_java_lang_String_: - -.. _RealmResults_setString_String__java_lang_String_: - -.. _RealmResults_setString_String_String_: - -.. _RealmResults_setString_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setString ` ( - | `String `__ fieldName, - | `String `__ value - | ) - - - - - * - Sets the ``String`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a String field. - - - - - - - - - - - - -.. _setUUID: - -.. _setUUID__: - -.. _RealmResults_setUUID: - -.. _RealmResults_setUUID__: - -.. _io_realm_RealmResults_setUUID: - -.. _io_realm_RealmResults_setUUID__: - - - -setUUID -------- - -.. _io_realm_RealmResults_setUUID_java_lang_String_java_util_UUID_: - -.. _io_realm_RealmResults_setUUID_java_lang_String__java_util_UUID_: - -.. _io_realm_RealmResults_setUUID_java_lang_String_UUID_: - -.. _io_realm_RealmResults_setUUID_java_lang_String__UUID_: - -.. _io_realm_RealmResults_setUUID_String_java_util_UUID_: - -.. _io_realm_RealmResults_setUUID_String__java_util_UUID_: - -.. _io_realm_RealmResults_setUUID_String_UUID_: - -.. _io_realm_RealmResults_setUUID_String__UUID_: - -.. _setUUID_java_lang_String_java_util_UUID_: - -.. _setUUID_java_lang_String__java_util_UUID_: - -.. _setUUID_java_lang_String_UUID_: - -.. _setUUID_java_lang_String__UUID_: - -.. _setUUID_String_java_util_UUID_: - -.. _setUUID_String__java_util_UUID_: - -.. _setUUID_String_UUID_: - -.. _setUUID_String__UUID_: - -.. _RealmResults_setUUID_java_lang_String_java_util_UUID_: - -.. _RealmResults_setUUID_java_lang_String__java_util_UUID_: - -.. _RealmResults_setUUID_java_lang_String_UUID_: - -.. _RealmResults_setUUID_java_lang_String__UUID_: - -.. _RealmResults_setUUID_String_java_util_UUID_: - -.. _RealmResults_setUUID_String__java_util_UUID_: - -.. _RealmResults_setUUID_String_UUID_: - -.. _RealmResults_setUUID_String__UUID_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setUUID ` ( - | `String `__ fieldName, - | `UUID `__ value - | ) - - - - - * - Sets the ``UUID`` value of the given field in all of the objects in the collection. - - - - - - - **Parameters** - - - ``fieldName`` - name of the field to update. - - - - - ``value`` - new value for the field. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if field name doesn't exist, is a primary key property or isn't a ``UUID`` field. - - - - - - - - - - - - - - -.. _setValue: - -.. _setValue__: - -.. _RealmResults_setValue: - -.. _RealmResults_setValue__: - -.. _io_realm_RealmResults_setValue: - -.. _io_realm_RealmResults_setValue__: - - - -setValue --------- - -.. _io_realm_RealmResults_setValue_java_lang_String_java_lang_Object_: - -.. _io_realm_RealmResults_setValue_java_lang_String__java_lang_Object_: - -.. _io_realm_RealmResults_setValue_java_lang_String_Object_: - -.. _io_realm_RealmResults_setValue_java_lang_String__Object_: - -.. _io_realm_RealmResults_setValue_String_java_lang_Object_: - -.. _io_realm_RealmResults_setValue_String__java_lang_Object_: - -.. _io_realm_RealmResults_setValue_String_Object_: - -.. _io_realm_RealmResults_setValue_String__Object_: - -.. _setValue_java_lang_String_java_lang_Object_: - -.. _setValue_java_lang_String__java_lang_Object_: - -.. _setValue_java_lang_String_Object_: - -.. _setValue_java_lang_String__Object_: - -.. _setValue_String_java_lang_Object_: - -.. _setValue_String__java_lang_Object_: - -.. _setValue_String_Object_: - -.. _setValue_String__Object_: - -.. _RealmResults_setValue_java_lang_String_java_lang_Object_: - -.. _RealmResults_setValue_java_lang_String__java_lang_Object_: - -.. _RealmResults_setValue_java_lang_String_Object_: - -.. _RealmResults_setValue_java_lang_String__Object_: - -.. _RealmResults_setValue_String_java_lang_Object_: - -.. _RealmResults_setValue_String__java_lang_Object_: - -.. _RealmResults_setValue_String_Object_: - -.. _RealmResults_setValue_String__Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setValue ` ( - | `String `__ fieldName, - | `Object `__ value - | ) - - - - - * - Updates the field given by ``fieldName`` in all objects inside the query result. - - This method will automatically try to convert numbers and booleans that are given as ``String`` to their appropriate type. For example ``"10"`` will be converted to ``10`` if the field type is :ref:`RealmFieldType.INTEGER ` . - - - - Using the typed setters like :ref:`setInt(String, int) ` will be faster than using this method. - - - - - - - - - **Parameters** - - - ``fieldName`` - field to update - - - - - ``value`` - value to update with. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the field could not be found, could not be updated or the argument didn't match the field type or could not be converted to match the underlying field type. - - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _RealmResults_sort: - -.. _RealmResults_sort__: - -.. _io_realm_RealmResults_sort: - -.. _io_realm_RealmResults_sort__: - - - -sort ----- - -.. _io_realm_RealmResults_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String_Sort_String_Sort_: - -.. _io_realm_RealmResults_sort_java_lang_String__Sort__String__Sort_: - -.. _io_realm_RealmResults_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmResults_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _io_realm_RealmResults_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String_io_realm_Sort_String_Sort_: - -.. _io_realm_RealmResults_sort_String__io_realm_Sort__String__Sort_: - -.. _io_realm_RealmResults_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String_Sort_java_lang_String_Sort_: - -.. _io_realm_RealmResults_sort_String__Sort__java_lang_String__Sort_: - -.. _io_realm_RealmResults_sort_String_Sort_String_io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String__Sort__String__io_realm_Sort_: - -.. _io_realm_RealmResults_sort_String_Sort_String_Sort_: - -.. _io_realm_RealmResults_sort_String__Sort__String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _sort_java_lang_String_Sort_String_Sort_: - -.. _sort_java_lang_String__Sort__String__Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _sort_String_io_realm_Sort_String_Sort_: - -.. _sort_String__io_realm_Sort__String__Sort_: - -.. _sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _sort_String_Sort_java_lang_String_Sort_: - -.. _sort_String__Sort__java_lang_String__Sort_: - -.. _sort_String_Sort_String_io_realm_Sort_: - -.. _sort_String__Sort__String__io_realm_Sort_: - -.. _sort_String_Sort_String_Sort_: - -.. _sort_String__Sort__String__Sort_: - -.. _RealmResults_sort_java_lang_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmResults_sort_java_lang_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmResults_sort_java_lang_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String_io_realm_Sort_String_Sort_: - -.. _RealmResults_sort_java_lang_String__io_realm_Sort__String__Sort_: - -.. _RealmResults_sort_java_lang_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String_Sort_java_lang_String_Sort_: - -.. _RealmResults_sort_java_lang_String__Sort__java_lang_String__Sort_: - -.. _RealmResults_sort_java_lang_String_Sort_String_io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String__Sort__String__io_realm_Sort_: - -.. _RealmResults_sort_java_lang_String_Sort_String_Sort_: - -.. _RealmResults_sort_java_lang_String__Sort__String__Sort_: - -.. _RealmResults_sort_String_io_realm_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmResults_sort_String__io_realm_Sort__java_lang_String__io_realm_Sort_: - -.. _RealmResults_sort_String_io_realm_Sort_java_lang_String_Sort_: - -.. _RealmResults_sort_String__io_realm_Sort__java_lang_String__Sort_: - -.. _RealmResults_sort_String_io_realm_Sort_String_io_realm_Sort_: - -.. _RealmResults_sort_String__io_realm_Sort__String__io_realm_Sort_: - -.. _RealmResults_sort_String_io_realm_Sort_String_Sort_: - -.. _RealmResults_sort_String__io_realm_Sort__String__Sort_: - -.. _RealmResults_sort_String_Sort_java_lang_String_io_realm_Sort_: - -.. _RealmResults_sort_String__Sort__java_lang_String__io_realm_Sort_: - -.. _RealmResults_sort_String_Sort_java_lang_String_Sort_: - -.. _RealmResults_sort_String__Sort__java_lang_String__Sort_: - -.. _RealmResults_sort_String_Sort_String_io_realm_Sort_: - -.. _RealmResults_sort_String__Sort__String__io_realm_Sort_: - -.. _RealmResults_sort_String_Sort_String_Sort_: - -.. _RealmResults_sort_String__Sort__String__Sort_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResults ` :ref:`sort ` ( - | `String `__ fieldName1, - | :ref:`Sort ` sortOrder1, - | `String `__ fieldName2, - | :ref:`Sort ` sortOrder2 - | ) - - - - - * - Sorts a collection based on the provided fields and sort orders. - - - - - - - **Returns** - - a new sorted :ref:`RealmResults ` will be created and returned. The original collection stays unchanged. - - - - - - - - - **Overrides** - - ``sort`` in class **OrderedRealmCollectionImpl** - - - - - - -.. _where: - -.. _where__: - -.. _RealmResults_where: - -.. _RealmResults_where__: - -.. _io_realm_RealmResults_where: - -.. _io_realm_RealmResults_where__: - - - -where ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` () - | - - - - - * - Returns a :ref:`RealmQuery ` , which can be used to query for specific objects from this collection. - - - - - - - - - **Returns** - - a RealmQuery object. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmSchema.txt b/source/sdk/java/api/io/realm/RealmSchema.txt deleted file mode 100644 index 0526e125b2..0000000000 --- a/source/sdk/java/api/io/realm/RealmSchema.txt +++ /dev/null @@ -1,1116 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmSchema -^^^^^^^^^^^^^^^^^ - -.. _io_realm_RealmSchema: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmSchema - - -Class for interacting with the Realm schema. This makes it possible to inspect, add, delete and change the classes in the Realm.:ref:`Realm.getSchema() ` returns an immutable ``RealmSchema`` which can only be used for inspecting. Use :ref:`DynamicRealm.getSchema() ` to get a mutable schema. - - - -All changes must happen inside a write transaction for the particular Realm. - - - - -.. seealso:: - - - - - :ref:`RealmMigration ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`contains ` ( - | `String `__ className - | ) - - - Checks if a given class already exists in the schema. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`create ` ( - | `String `__ className - | ) - - - Adds a new class to the Realm. - - - - - * - public **void** - - | :ref:`createKeyPathMapping ` () - | - - - Create the underlying keypath mapping. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`createWithPrimaryKeyField ` ( - | `String `__ className, - | `String `__ primaryKeyFieldName, - | `java.lang.Class\ `__ fieldType, - | :ref:`io.realm.FieldAttribute[] ` attributes - | ) - - - Adds a new class to the Realm with a primary key field defined. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`get ` ( - | `String `__ className - | ) - - - Returns the :ref:`RealmObjectSchema ` for a given class. - - - - - - - * - public abstract `Set `__ - - | :ref:`getAll ` () - | - - - Returns the :ref:`RealmObjectSchema ` s for all RealmObject classes that can be saved in this Realm. - - - - - - - * - protected final **ColumnInfo** - - | :ref:`getColumnInfo ` ( - | `String `__ className - | ) - - - - - - - - * - public abstract **void** - - | :ref:`remove ` ( - | `String `__ className - | ) - - - Removes a class from the Realm. - - - - - * - public abstract :ref:`RealmObjectSchema ` - - | :ref:`rename ` ( - | `String `__ oldClassName, - | `String `__ newClassName - | ) - - - Renames a class already in the Realm. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _contains: - -.. _contains__: - -.. _RealmSchema_contains: - -.. _RealmSchema_contains__: - -.. _io_realm_RealmSchema_contains: - -.. _io_realm_RealmSchema_contains__: - - - -contains --------- - -.. _io_realm_RealmSchema_contains_java_lang_String_: - -.. _io_realm_RealmSchema_contains_String_: - -.. _contains_java_lang_String_: - -.. _contains_String_: - -.. _RealmSchema_contains_java_lang_String_: - -.. _RealmSchema_contains_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`contains ` ( - | `String `__ className - | ) - - - - - * - Checks if a given class already exists in the schema. - - - - - **Parameters** - - - ``className`` - class name to check. - - - - - - - - **Returns** - - ``true`` if the class already exists. ``false`` otherwise. - - - - - - - - - - - - - -.. _create: - -.. _create__: - -.. _RealmSchema_create: - -.. _RealmSchema_create__: - -.. _io_realm_RealmSchema_create: - -.. _io_realm_RealmSchema_create__: - - - -create ------- - -.. _io_realm_RealmSchema_create_java_lang_String_: - -.. _io_realm_RealmSchema_create_String_: - -.. _create_java_lang_String_: - -.. _create_String_: - -.. _RealmSchema_create_java_lang_String_: - -.. _RealmSchema_create_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`create ` ( - | `String `__ className - | ) - - - - - * - Adds a new class to the Realm. - - - - - **Parameters** - - - ``className`` - name of the class. - - - - - - - - **Returns** - - a Realm schema object for that class. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. - - - - - - - - - - - - - - -.. _createKeyPathMapping: - -.. _createKeyPathMapping__: - -.. _RealmSchema_createKeyPathMapping: - -.. _RealmSchema_createKeyPathMapping__: - -.. _io_realm_RealmSchema_createKeyPathMapping: - -.. _io_realm_RealmSchema_createKeyPathMapping__: - - - -createKeyPathMapping --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`createKeyPathMapping ` () - | - - - - - * - Create the underlying keypath mapping. Should only be called by typed Realms. - - - - - - - - - - - - - - - -.. _createWithPrimaryKeyField: - -.. _createWithPrimaryKeyField__: - -.. _RealmSchema_createWithPrimaryKeyField: - -.. _RealmSchema_createWithPrimaryKeyField__: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField__: - - - -createWithPrimaryKeyField -------------------------- - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_Class_io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__Class__io_realm_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_Class_FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__Class__FieldAttribute_: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String_String_Class_FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String_String_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__String__Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute____: - -.. _createWithPrimaryKeyField_String_String_Class_io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__String__Class__io_realm_FieldAttribute_: - -.. _createWithPrimaryKeyField_String_String_Class_FieldAttribute_: - -.. _createWithPrimaryKeyField_String__String__Class__FieldAttribute_: - -.. _createWithPrimaryKeyField_String_String_Class_FieldAttribute____: - -.. _createWithPrimaryKeyField_String__String__Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_java_lang_String_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__java_lang_String__Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_java_lang_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__java_lang_Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String_String_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_java_lang_String__String__Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_java_lang_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__java_lang_Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_java_lang_String_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String__java_lang_String__Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_java_lang_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__java_lang_Class__FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_Class_io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__Class__io_realm_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_Class_FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__Class__FieldAttribute_: - -.. _RealmSchema_createWithPrimaryKeyField_String_String_Class_FieldAttribute____: - -.. _RealmSchema_createWithPrimaryKeyField_String__String__Class__FieldAttribute____: - -.. _io_realm_RealmSchema_createWithPrimaryKeyField_String__String__Class_____FieldAttribute____: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`createWithPrimaryKeyField ` ( - | `String `__ className, - | `String `__ primaryKeyFieldName, - | `java.lang.Class\ `__ fieldType, - | :ref:`io.realm.FieldAttribute[] ` attributes - | ) - - - - - * - Adds a new class to the Realm with a primary key field defined. - - - - - **Parameters** - - - ``className`` - name of the class. - - - - - ``primaryKeyFieldName`` - name of the primary key field. - - - - - ``fieldType`` - type of field to add. Only ``byte`` , ``short`` , ``int`` , ``long`` and their boxed types or the ``String`` is supported. - - - - - - - ``attributes`` - set of attributes for this field. This method implicitly adds :ref:`FieldAttribute.PRIMARY_KEY ` and :ref:`FieldAttribute.INDEXED ` attributes to the field. - - - - - - - - - - **Returns** - - a Realm schema object for that class. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable. - - - - - - - - - - - - - - -.. _get: - -.. _get__: - -.. _RealmSchema_get: - -.. _RealmSchema_get__: - -.. _io_realm_RealmSchema_get: - -.. _io_realm_RealmSchema_get__: - - - -get ----- - -.. _io_realm_RealmSchema_get_java_lang_String_: - -.. _io_realm_RealmSchema_get_String_: - -.. _get_java_lang_String_: - -.. _get_String_: - -.. _RealmSchema_get_java_lang_String_: - -.. _RealmSchema_get_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`get ` ( - | `String `__ className - | ) - - - - - * - Returns the :ref:`RealmObjectSchema ` for a given class. If this :ref:`RealmSchema ` is immutable, an immutable :ref:`RealmObjectSchema ` will be returned. Otherwise, it returns a mutable :ref:`RealmObjectSchema ` . - - - - - - - **Parameters** - - - ``className`` - name of the class - - - - - - - - **Returns** - - schema object for that class or ``null`` if the class doesn't exists. - - - - - - - - - - - - - -.. _getAll: - -.. _getAll__: - -.. _RealmSchema_getAll: - -.. _RealmSchema_getAll__: - -.. _io_realm_RealmSchema_getAll: - -.. _io_realm_RealmSchema_getAll__: - - - -getAll ------- - -.. list-table:: - :header-rows: 1 - - * - | public abstract `Set `__ :ref:`getAll ` () - | - - - - - * - Returns the :ref:`RealmObjectSchema ` s for all RealmObject classes that can be saved in this Realm. If this :ref:`RealmSchema ` is immutable, an immutable :ref:`RealmObjectSchema ` set will be returned. Otherwise, it returns an mutable :ref:`RealmObjectSchema ` set. - - - - - - - - - **Returns** - - the set of all classes in this Realm or no RealmObject classes can be saved in the Realm. - - - - - - - - - - - -.. _getColumnInfo: - -.. _getColumnInfo__: - -.. _RealmSchema_getColumnInfo: - -.. _RealmSchema_getColumnInfo__: - -.. _io_realm_RealmSchema_getColumnInfo: - -.. _io_realm_RealmSchema_getColumnInfo__: - - - -getColumnInfo -------------- - -.. _io_realm_RealmSchema_getColumnInfo_java_lang_String_: - -.. _io_realm_RealmSchema_getColumnInfo_String_: - -.. _getColumnInfo_java_lang_String_: - -.. _getColumnInfo_String_: - -.. _RealmSchema_getColumnInfo_java_lang_String_: - -.. _RealmSchema_getColumnInfo_String_: - -.. list-table:: - :header-rows: 1 - - * - | protected final **ColumnInfo** :ref:`getColumnInfo ` ( - | `String `__ className - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _RealmSchema_remove: - -.. _RealmSchema_remove__: - -.. _io_realm_RealmSchema_remove: - -.. _io_realm_RealmSchema_remove__: - - - -remove ------- - -.. _io_realm_RealmSchema_remove_java_lang_String_: - -.. _io_realm_RealmSchema_remove_String_: - -.. _remove_java_lang_String_: - -.. _remove_String_: - -.. _RealmSchema_remove_java_lang_String_: - -.. _RealmSchema_remove_String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract **void** :ref:`remove ` ( - | `String `__ className - | ) - - - - - * - Removes a class from the Realm. All data will be removed. Removing a class while other classes point to it will throw an `IllegalStateException `__ . Removes those classes or fields first. - - - - - - - **Parameters** - - - ``className`` - name of the class to remove. - - - - - - - - - - **Throws** - - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. - - - - - - - - - - - - - - -.. _rename: - -.. _rename__: - -.. _RealmSchema_rename: - -.. _RealmSchema_rename__: - -.. _io_realm_RealmSchema_rename: - -.. _io_realm_RealmSchema_rename__: - - - -rename ------- - -.. _io_realm_RealmSchema_rename_java_lang_String_java_lang_String_: - -.. _io_realm_RealmSchema_rename_java_lang_String__java_lang_String_: - -.. _io_realm_RealmSchema_rename_java_lang_String_String_: - -.. _io_realm_RealmSchema_rename_java_lang_String__String_: - -.. _io_realm_RealmSchema_rename_String_java_lang_String_: - -.. _io_realm_RealmSchema_rename_String__java_lang_String_: - -.. _io_realm_RealmSchema_rename_String_String_: - -.. _io_realm_RealmSchema_rename_String__String_: - -.. _rename_java_lang_String_java_lang_String_: - -.. _rename_java_lang_String__java_lang_String_: - -.. _rename_java_lang_String_String_: - -.. _rename_java_lang_String__String_: - -.. _rename_String_java_lang_String_: - -.. _rename_String__java_lang_String_: - -.. _rename_String_String_: - -.. _rename_String__String_: - -.. _RealmSchema_rename_java_lang_String_java_lang_String_: - -.. _RealmSchema_rename_java_lang_String__java_lang_String_: - -.. _RealmSchema_rename_java_lang_String_String_: - -.. _RealmSchema_rename_java_lang_String__String_: - -.. _RealmSchema_rename_String_java_lang_String_: - -.. _RealmSchema_rename_String__java_lang_String_: - -.. _RealmSchema_rename_String_String_: - -.. _RealmSchema_rename_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public abstract :ref:`RealmObjectSchema ` :ref:`rename ` ( - | `String `__ oldClassName, - | `String `__ newClassName - | ) - - - - - * - Renames a class already in the Realm. - - - - - **Parameters** - - - ``oldClassName`` - old class name. - - - - - ``newClassName`` - new class name. - - - - - - - - **Returns** - - a schema object for renamed class. - - - - - **Throws** - - - `UnsupportedOperationException `__ - if this :ref:`RealmSchema ` is immutable or of a synced Realm. - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/RealmSet.txt b/source/sdk/java/api/io/realm/RealmSet.txt deleted file mode 100644 index 5fabec40a3..0000000000 --- a/source/sdk/java/api/io/realm/RealmSet.txt +++ /dev/null @@ -1,2724 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmSet -^^^^^^^^^^^^^^ - -.. _io_realm_RealmSet: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.RealmSet - - -**Implemented interfaces:** - - - -- `java.util.Set `__ -- :ref:`io.realm.RealmCollection ` -- `java.util.Collection `__ -- `java.lang.Iterable `__ -- `java.util.Collection `__ -- `java.lang.Iterable `__ - - -RealmSet is a collection that contains no duplicate elements.Similarly to :ref:`RealmList ` s, a RealmSet can operate in managed and unmanaged modes. In managed mode a RealmSet persists all its contents inside a Realm whereas in unmanaged mode it functions like a `HashSet `__ . - - - -Managed RealmSets can only be created by Realm and will automatically update their content whenever the underlying Realm is updated. Managed RealmSet can only be accessed using the getter that points to a RealmSet field of a :ref:`RealmObject ` . - - - -Unmanaged elements in this set can be added to a Realm using the :ref:`Realm.copyToRealm(Iterable, ImportFlag...) ` method. - - - -**Warning: **the following methods are not supported for classes containing set fields yet: - - - -- :ref:`Realm.insert(RealmModel) ` - - - - -- :ref:`Realm.insert(Collection) ` - - - - -- :ref:`Realm.insertOrUpdate(RealmModel) ` - - - - -- :ref:`Realm.insertOrUpdate(Collection) ` - - - - -- **Realm.createAllFromJson(Class, String)** - - - - -- :ref:`Realm.createAllFromJson(Class, JSONArray) ` - - - - -- **Realm.createAllFromJson(Class, InputStream)** - - - - -- **Realm.createObjectFromJson(Class, String)** - - - - -- :ref:`Realm.createObjectFromJson(Class, JSONObject) ` } - - - - -- **Realm.createObjectFromJson(Class, InputStream)**} - - - - -- **Realm.createOrUpdateAllFromJson(Class, String)** - - - - -- :ref:`Realm.createOrUpdateAllFromJson(Class, JSONArray) ` - - - - -- **Realm.createOrUpdateAllFromJson(Class, InputStream)** - - - - -- **Realm.createOrUpdateObjectFromJson(Class, String)** - - - - -- :ref:`Realm.createOrUpdateObjectFromJson(Class, JSONObject) ` - - - - -- **Realm.createOrUpdateObjectFromJson(Class, InputStream)** - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmSet ` () - | - - - Instantiates a RealmSet in unmanaged mode. - - - - - * - | :ref:`RealmSet ` ( - | `java.util.Collection\ `__ collection - | ) - - - Instantiates a RealmSet in unmanaged mode with another collection. - - - - - * - | :ref:`RealmSet ` ( - | **BaseRealm** baseRealm, - | **OsSet** osSet, - | `java.lang.Class\ `__ valueClass - | ) - - - Instantiates a RealmSet in managed mode. - - - - - * - | :ref:`RealmSet ` ( - | **BaseRealm** baseRealm, - | **OsSet** osSet, - | `String `__ className - | ) - - - Instantiates a RealmSet in managed mode. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`add ` ( - | **E** e - | ) - - - - - - - - - - * - public **boolean** - - | :ref:`addAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.SetChangeListener\ ` listener - | ) - - - Adds a change listener to this :ref:`RealmSet ` . - - - - - - - * - public **void** - - | :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Adds a change listener to this :ref:`RealmSet ` . - - - - - - - * - public **double** - - | :ref:`average ` ( - | `String `__ fieldName - | ) - - - Returns the average of a given field. - - - - - * - public **void** - - | :ref:`clear ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`contains ` ( - | `Object `__ o - | ) - - - Tests whether this ``Collection`` contains the specified object. - - - - - - - * - public **boolean** - - | :ref:`containsAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - - - - - - * - public **boolean** - - | :ref:`deleteAllFromRealm ` () - | - - - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - * - public :ref:`RealmSet ` - - | :ref:`freeze ` () - | - - - - - - - - - - * - public `Class `__ - - | :ref:`getValueClass ` () - | - - - - - - - - * - public `String `__ - - | :ref:`getValueClassName ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isFrozen ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`isLoaded ` () - | - - - Checks if a collection has finished loading its data yet. - - - - - * - public **boolean** - - | :ref:`isManaged ` () - | - - - Checks if the collection is managed by Realm. - - - - - * - public **boolean** - - | :ref:`isValid ` () - | - - - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. - - - - - - - * - public `Iterator `__ - - | :ref:`iterator ` () - | - - - - - - - - - - * - public **boolean** - - | :ref:`load ` () - | - - - Blocks the collection until all data are available. - - - - - * - public `Number `__ - - | :ref:`max ` ( - | `String `__ fieldName - | ) - - - Finds the maximum value of a field. - - - - - * - public `Date `__ - - | :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - Finds the maximum date. - - - - - * - public `Number `__ - - | :ref:`min ` ( - | `String `__ fieldName - | ) - - - Finds the minimum value of a field. - - - - - * - public `Date `__ - - | :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - Finds the minimum date. - - - - - * - public **boolean** - - | :ref:`remove ` ( - | `Object `__ o - | ) - - - - - - - - - - * - public **boolean** - - | :ref:`removeAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - - - - - - * - public **void** - - | :ref:`removeAllChangeListeners ` () - | - - - Removes all user-defined change listeners. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.SetChangeListener\ ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **void** - - | :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - Removes the specified change listener. - - - - - * - public **boolean** - - | :ref:`retainAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - - - - - - * - public **int** - - | :ref:`size ` () - | - - - - - - - - - - * - public `Number `__ - - | :ref:`sum ` ( - | `String `__ fieldName - | ) - - - Calculates the sum of a given field. - - - - - * - public **T** - - | :ref:`toArray ` <**T** >( - | **T[]** a - | ) - - - - - - - - - - * - public `Object `__ - - | :ref:`toArray ` () - | - - - - - - - - - - * - public :ref:`RealmQuery ` - - | :ref:`where ` () - | - - - Returns a RealmQuery, which can be used to query for specific objects of this class. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmSet: - -.. _RealmSet__: - -.. _io_realm_RealmSet: - -.. _io_realm_RealmSet__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` () - | - - - - - * - Instantiates a RealmSet in unmanaged mode. - - - - - - - - - - - -.. _RealmSet: - -.. _RealmSet__: - -.. _io_realm_RealmSet: - -.. _io_realm_RealmSet__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` ( - | `java.util.Collection\ `__ collection - | ) - - - - - * - Instantiates a RealmSet in unmanaged mode with another collection. - - - - - **Parameters** - - - ``collection`` - the collection with which the set will be initially populated. - - - - - - - - - - - - -.. _RealmSet: - -.. _RealmSet__: - -.. _io_realm_RealmSet: - -.. _io_realm_RealmSet__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` ( - | **BaseRealm** baseRealm, - | **OsSet** osSet, - | `java.lang.Class\ `__ valueClass - | ) - - - - - * - Instantiates a RealmSet in managed mode. This constructor is used internally by Realm. - - - - - **Parameters** - - - ``baseRealm`` - - - - - - ``osSet`` - - - - - - ``valueClass`` - - - - - - - - - - - - - -.. _RealmSet: - -.. _RealmSet__: - -.. _io_realm_RealmSet: - -.. _io_realm_RealmSet__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` ( - | **BaseRealm** baseRealm, - | **OsSet** osSet, - | `String `__ className - | ) - - - - - * - Instantiates a RealmSet in managed mode. This constructor is used internally by a Dynamic Realm. - - - - - **Parameters** - - - ``baseRealm`` - - - - - - ``osSet`` - - - - - - ``className`` - - - - - - - - - - - - - - - -Method Detail -============= - -.. _add: - -.. _add__: - -.. _RealmSet_add: - -.. _RealmSet_add__: - -.. _io_realm_RealmSet_add: - -.. _io_realm_RealmSet_add__: - - - -add ----- - -.. _io_realm_RealmSet_add_E_: - -.. _add_E_: - -.. _RealmSet_add_E_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`add ` ( - | **E** e - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _addAll: - -.. _addAll__: - -.. _RealmSet_addAll: - -.. _RealmSet_addAll__: - -.. _io_realm_RealmSet_addAll: - -.. _io_realm_RealmSet_addAll__: - - - -addAll ------- - -.. _io_realm_RealmSet_addAll_java_util_Collection_: - -.. _io_realm_RealmSet_addAll_Collection_: - -.. _io_realm_RealmSet_addAll_Collection___extends_E__: - -.. _addAll_java_util_Collection_: - -.. _addAll_Collection_: - -.. _addAll_Collection___extends_E__: - -.. _RealmSet_addAll_java_util_Collection_: - -.. _RealmSet_addAll_Collection_: - -.. _RealmSet_addAll_Collection___extends_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`addAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _addChangeListener: - -.. _addChangeListener__: - -.. _RealmSet_addChangeListener: - -.. _RealmSet_addChangeListener__: - -.. _io_realm_RealmSet_addChangeListener: - -.. _io_realm_RealmSet_addChangeListener__: - - - -addChangeListener ------------------ - -.. _io_realm_RealmSet_addChangeListener_io_realm_SetChangeListener_: - -.. _io_realm_RealmSet_addChangeListener_SetChangeListener_: - -.. _addChangeListener_io_realm_SetChangeListener_: - -.. _addChangeListener_SetChangeListener_: - -.. _RealmSet_addChangeListener_io_realm_SetChangeListener_: - -.. _RealmSet_addChangeListener_SetChangeListener_: - -.. _io_realm_RealmSet_addChangeListener_SetChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.SetChangeListener\ ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmSet ` . - - Registering a change listener will not prevent the underlying RealmSet from being garbage collected. If the RealmSet is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmSet dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new SetChangeListener() { - @Override - public void onChange(RealmSet set, SetChangeSet changeSet) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - -.. _io_realm_RealmSet_addChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmSet_addChangeListener_RealmChangeListener_: - -.. _addChangeListener_io_realm_RealmChangeListener_: - -.. _addChangeListener_RealmChangeListener_: - -.. _RealmSet_addChangeListener_io_realm_RealmChangeListener_: - -.. _RealmSet_addChangeListener_RealmChangeListener_: - -.. _io_realm_RealmSet_addChangeListener_RealmChangeListener_RealmSet_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Adds a change listener to this :ref:`RealmSet ` . - - Registering a change listener will not prevent the underlying RealmSet from being garbage collected. If the RealmSet is garbage collected, the change listener will stop being triggered. To avoid this, keep a strong reference for as long as appropriate e.g. in a class variable. - - - - .. code-block:: java - - - public class MyActivity extends Activity { - - private RealmSet dogs; // Strong reference to keep listeners alive - - @Override - protected void onCreate(Bundle savedInstanceState) { - super.onCreate(savedInstanceState); - dogs = realm.where(Person.class).findFirst().getDogs(); - dogs.addChangeListener(new RealmChangeListener>() { - @Override - public void onChange(RealmSet map) { - // React to change - } - }); - } - } - - - - - - - - - - - **Parameters** - - - ``listener`` - the listener to be notified. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to add a listener from a non-Looper or `android.app.IntentService `__ thread. - - - - - - - - - - - - - - -.. _average: - -.. _average__: - -.. _RealmSet_average: - -.. _RealmSet_average__: - -.. _io_realm_RealmSet_average: - -.. _io_realm_RealmSet_average__: - - - -average -------- - -.. _io_realm_RealmSet_average_java_lang_String_: - -.. _io_realm_RealmSet_average_String_: - -.. _average_java_lang_String_: - -.. _average_String_: - -.. _RealmSet_average_java_lang_String_: - -.. _RealmSet_average_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`average ` ( - | `String `__ fieldName - | ) - - - - - * - Returns the average of a given field. - - - - - - - **Returns** - - the average for the given field amongst objects in query results. This will be of type double for all types of number fields. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the average, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _clear: - -.. _clear__: - -.. _RealmSet_clear: - -.. _RealmSet_clear__: - -.. _io_realm_RealmSet_clear: - -.. _io_realm_RealmSet_clear__: - - - -clear ------ - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`clear ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _contains: - -.. _contains__: - -.. _RealmSet_contains: - -.. _RealmSet_contains__: - -.. _io_realm_RealmSet_contains: - -.. _io_realm_RealmSet_contains__: - - - -contains --------- - -.. _io_realm_RealmSet_contains_java_lang_Object_: - -.. _io_realm_RealmSet_contains_Object_: - -.. _contains_java_lang_Object_: - -.. _contains_Object_: - -.. _RealmSet_contains_java_lang_Object_: - -.. _RealmSet_contains_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`contains ` ( - | `Object `__ o - | ) - - - - - * - Tests whether this ``Collection`` contains the specified object. Returns ``true`` if and only if at least one element ``elem`` in this ``Collection`` meets following requirement: ``(object==null ? elem==null : object.equals(elem))`` . - - - - - - - - - **Returns** - - ``true`` if object is an element of this ``Collection`` , ``false`` otherwise. - - - - - - - - - - - - - -.. _containsAll: - -.. _containsAll__: - -.. _RealmSet_containsAll: - -.. _RealmSet_containsAll__: - -.. _io_realm_RealmSet_containsAll: - -.. _io_realm_RealmSet_containsAll__: - - - -containsAll ------------ - -.. _io_realm_RealmSet_containsAll_java_util_Collection_: - -.. _io_realm_RealmSet_containsAll_Collection_: - -.. _containsAll_java_util_Collection_: - -.. _containsAll_Collection_: - -.. _RealmSet_containsAll_java_util_Collection_: - -.. _RealmSet_containsAll_Collection_: - -.. _io_realm_RealmSet_containsAll_Collection____: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`containsAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _deleteAllFromRealm: - -.. _deleteAllFromRealm__: - -.. _RealmSet_deleteAllFromRealm: - -.. _RealmSet_deleteAllFromRealm__: - -.. _io_realm_RealmSet_deleteAllFromRealm: - -.. _io_realm_RealmSet_deleteAllFromRealm__: - - - -deleteAllFromRealm ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`deleteAllFromRealm ` () - | - - - - - * - This deletes all objects in the collection from the underlying Realm as well as from the collection. - - - - - - - **Returns** - - ``true`` if objects was deleted, ``false`` otherwise. - - - - - - - - - - - - - -.. _freeze: - -.. _freeze__: - -.. _RealmSet_freeze: - -.. _RealmSet_freeze__: - -.. _io_realm_RealmSet_freeze: - -.. _io_realm_RealmSet_freeze__: - - - -freeze ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmSet ` :ref:`freeze ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _getValueClass: - -.. _getValueClass__: - -.. _RealmSet_getValueClass: - -.. _RealmSet_getValueClass__: - -.. _io_realm_RealmSet_getValueClass: - -.. _io_realm_RealmSet_getValueClass__: - - - -getValueClass -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Class `__ :ref:`getValueClass ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _getValueClassName: - -.. _getValueClassName__: - -.. _RealmSet_getValueClassName: - -.. _RealmSet_getValueClassName__: - -.. _io_realm_RealmSet_getValueClassName: - -.. _io_realm_RealmSet_getValueClassName__: - - - -getValueClassName ------------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getValueClassName ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _RealmSet_isEmpty: - -.. _RealmSet_isEmpty__: - -.. _io_realm_RealmSet_isEmpty: - -.. _io_realm_RealmSet_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isFrozen: - -.. _isFrozen__: - -.. _RealmSet_isFrozen: - -.. _RealmSet_isFrozen__: - -.. _io_realm_RealmSet_isFrozen: - -.. _io_realm_RealmSet_isFrozen__: - - - -isFrozen --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFrozen ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _isLoaded: - -.. _isLoaded__: - -.. _RealmSet_isLoaded: - -.. _RealmSet_isLoaded__: - -.. _io_realm_RealmSet_isLoaded: - -.. _io_realm_RealmSet_isLoaded__: - - - -isLoaded --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoaded ` () - | - - - - - * - Checks if a collection has finished loading its data yet. - - - - - - - **Returns** - - ``true`` if data has been loaded and is available, ``false`` if data is still being loaded. - - - - - - - - - - - - - -.. _isManaged: - -.. _isManaged__: - -.. _RealmSet_isManaged: - -.. _RealmSet_isManaged__: - -.. _io_realm_RealmSet_isManaged: - -.. _io_realm_RealmSet_isManaged__: - - - -isManaged ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isManaged ` () - | - - - - - * - Checks if the collection is managed by Realm. A managed collection is just a wrapper around the data in the underlying Realm file. On Looper threads, a managed collection will be live-updated so it always points to the latest data. Managed collections are thread confined so that they cannot be accessed from other threads than the one that created them.If this method returns ``false`` , the collection is unmanaged. An unmanaged collection is just a normal java collection, so it will not be live updated. - - - - - - - - - - - **Returns** - - ``true`` if this is a managed :ref:`RealmCollection ` , ``false`` otherwise. - - - - - - - - - - - - - -.. _isValid: - -.. _isValid__: - -.. _RealmSet_isValid: - -.. _RealmSet_isValid__: - -.. _io_realm_RealmSet_isValid: - -.. _io_realm_RealmSet_isValid__: - - - -isValid -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isValid ` () - | - - - - - * - Checks if the collection is still valid to use, i.e., the :ref:`io.realm.Realm ` instance hasn't been closed. It will always return ``true`` for an unmanaged collection. - - - - - - - - - **Returns** - - ``true`` if it is still valid to use or an unmanaged collection, ``false`` otherwise. - - - - - - - - - - - - - -.. _iterator: - -.. _iterator__: - -.. _RealmSet_iterator: - -.. _RealmSet_iterator__: - -.. _io_realm_RealmSet_iterator: - -.. _io_realm_RealmSet_iterator__: - - - -iterator --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Iterator `__ :ref:`iterator ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _load: - -.. _load__: - -.. _RealmSet_load: - -.. _RealmSet_load__: - -.. _io_realm_RealmSet_load: - -.. _io_realm_RealmSet_load__: - - - -load ----- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`load ` () - | - - - - - * - Blocks the collection until all data are available. - - - - - - - **Returns** - - ``true`` if the data could be successfully loaded, ``false`` otherwise. - - - - - - - - - - - - - -.. _max: - -.. _max__: - -.. _RealmSet_max: - -.. _RealmSet_max__: - -.. _io_realm_RealmSet_max: - -.. _io_realm_RealmSet_max__: - - - -max ----- - -.. _io_realm_RealmSet_max_java_lang_String_: - -.. _io_realm_RealmSet_max_String_: - -.. _max_java_lang_String_: - -.. _max_String_: - -.. _RealmSet_max_java_lang_String_: - -.. _RealmSet_max_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`max ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum value of a field. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the maximum value is returned. When determining the maximum value, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _maxDate: - -.. _maxDate__: - -.. _RealmSet_maxDate: - -.. _RealmSet_maxDate__: - -.. _io_realm_RealmSet_maxDate: - -.. _io_realm_RealmSet_maxDate__: - - - -maxDate -------- - -.. _io_realm_RealmSet_maxDate_java_lang_String_: - -.. _io_realm_RealmSet_maxDate_String_: - -.. _maxDate_java_lang_String_: - -.. _maxDate_String_: - -.. _RealmSet_maxDate_java_lang_String_: - -.. _RealmSet_maxDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`maxDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the maximum date. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the maximum date is returned. When determining the maximum date, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _min: - -.. _min__: - -.. _RealmSet_min: - -.. _RealmSet_min__: - -.. _io_realm_RealmSet_min: - -.. _io_realm_RealmSet_min__: - - - -min ----- - -.. _io_realm_RealmSet_min_java_lang_String_: - -.. _io_realm_RealmSet_min_String_: - -.. _min_java_lang_String_: - -.. _min_String_: - -.. _RealmSet_min_java_lang_String_: - -.. _RealmSet_min_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`min ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum value of a field. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given field, ``null`` will be returned. Otherwise the minimum value is returned. When determining the minimum value, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _minDate: - -.. _minDate__: - -.. _RealmSet_minDate: - -.. _RealmSet_minDate__: - -.. _io_realm_RealmSet_minDate: - -.. _io_realm_RealmSet_minDate__: - - - -minDate -------- - -.. _io_realm_RealmSet_minDate_java_lang_String_: - -.. _io_realm_RealmSet_minDate_String_: - -.. _minDate_java_lang_String_: - -.. _minDate_String_: - -.. _RealmSet_minDate_java_lang_String_: - -.. _RealmSet_minDate_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`minDate ` ( - | `String `__ fieldName - | ) - - - - - * - Finds the minimum date. - - - - - - - **Returns** - - if no objects exist or they all have ``null`` as the value for the given date field, ``null`` will be returned. Otherwise the minimum date is returned. When determining the minimum date, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _RealmSet_remove: - -.. _RealmSet_remove__: - -.. _io_realm_RealmSet_remove: - -.. _io_realm_RealmSet_remove__: - - - -remove ------- - -.. _io_realm_RealmSet_remove_java_lang_Object_: - -.. _io_realm_RealmSet_remove_Object_: - -.. _remove_java_lang_Object_: - -.. _remove_Object_: - -.. _RealmSet_remove_java_lang_Object_: - -.. _RealmSet_remove_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`remove ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _removeAll: - -.. _removeAll__: - -.. _RealmSet_removeAll: - -.. _RealmSet_removeAll__: - -.. _io_realm_RealmSet_removeAll: - -.. _io_realm_RealmSet_removeAll__: - - - -removeAll ---------- - -.. _io_realm_RealmSet_removeAll_java_util_Collection_: - -.. _io_realm_RealmSet_removeAll_Collection_: - -.. _removeAll_java_util_Collection_: - -.. _removeAll_Collection_: - -.. _RealmSet_removeAll_java_util_Collection_: - -.. _RealmSet_removeAll_Collection_: - -.. _io_realm_RealmSet_removeAll_Collection____: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`removeAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _removeAllChangeListeners: - -.. _removeAllChangeListeners__: - -.. _RealmSet_removeAllChangeListeners: - -.. _RealmSet_removeAllChangeListeners__: - -.. _io_realm_RealmSet_removeAllChangeListeners: - -.. _io_realm_RealmSet_removeAllChangeListeners__: - - - -removeAllChangeListeners ------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAllChangeListeners ` () - | - - - - - * - Removes all user-defined change listeners. - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if you try to remove listeners from a non-Looper Thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmChangeListener ` - - - - - - - - - - - - -.. _removeChangeListener: - -.. _removeChangeListener__: - -.. _RealmSet_removeChangeListener: - -.. _RealmSet_removeChangeListener__: - -.. _io_realm_RealmSet_removeChangeListener: - -.. _io_realm_RealmSet_removeChangeListener__: - - - -removeChangeListener --------------------- - -.. _io_realm_RealmSet_removeChangeListener_io_realm_SetChangeListener_: - -.. _io_realm_RealmSet_removeChangeListener_SetChangeListener_: - -.. _removeChangeListener_io_realm_SetChangeListener_: - -.. _removeChangeListener_SetChangeListener_: - -.. _RealmSet_removeChangeListener_io_realm_SetChangeListener_: - -.. _RealmSet_removeChangeListener_SetChangeListener_: - -.. _io_realm_RealmSet_removeChangeListener_SetChangeListener_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.SetChangeListener\ ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - -.. _io_realm_RealmSet_removeChangeListener_io_realm_RealmChangeListener_: - -.. _io_realm_RealmSet_removeChangeListener_RealmChangeListener_: - -.. _removeChangeListener_io_realm_RealmChangeListener_: - -.. _removeChangeListener_RealmChangeListener_: - -.. _RealmSet_removeChangeListener_io_realm_RealmChangeListener_: - -.. _RealmSet_removeChangeListener_RealmChangeListener_: - -.. _io_realm_RealmSet_removeChangeListener_RealmChangeListener_RealmSet_E___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeChangeListener ` ( - | :ref:`io.realm.RealmChangeListener\> ` listener - | ) - - - - - * - Removes the specified change listener. - - - - - **Parameters** - - - ``listener`` - the change listener to be removed. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the change listener is ``null`` . - - - - - - - `IllegalStateException `__ - if you try to remove a listener from a non-Looper Thread. - - - - - - - - - - - - -.. _retainAll: - -.. _retainAll__: - -.. _RealmSet_retainAll: - -.. _RealmSet_retainAll__: - -.. _io_realm_RealmSet_retainAll: - -.. _io_realm_RealmSet_retainAll__: - - - -retainAll ---------- - -.. _io_realm_RealmSet_retainAll_java_util_Collection_: - -.. _io_realm_RealmSet_retainAll_Collection_: - -.. _retainAll_java_util_Collection_: - -.. _retainAll_Collection_: - -.. _RealmSet_retainAll_java_util_Collection_: - -.. _RealmSet_retainAll_Collection_: - -.. _io_realm_RealmSet_retainAll_Collection____: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`retainAll ` ( - | `java.util.Collection\ `__ c - | ) - - - - - * - - - - - - - - - - - - - - - - - - -.. _size: - -.. _size__: - -.. _RealmSet_size: - -.. _RealmSet_size__: - -.. _io_realm_RealmSet_size: - -.. _io_realm_RealmSet_size__: - - - -size ----- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`size ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _sum: - -.. _sum__: - -.. _RealmSet_sum: - -.. _RealmSet_sum__: - -.. _io_realm_RealmSet_sum: - -.. _io_realm_RealmSet_sum__: - - - -sum ----- - -.. _io_realm_RealmSet_sum_java_lang_String_: - -.. _io_realm_RealmSet_sum_String_: - -.. _sum_java_lang_String_: - -.. _sum_String_: - -.. _RealmSet_sum_java_lang_String_: - -.. _RealmSet_sum_String_: - -.. list-table:: - :header-rows: 1 - - * - | public `Number `__ :ref:`sum ` ( - | `String `__ fieldName - | ) - - - - - * - Calculates the sum of a given field. - - - - - - - **Returns** - - the sum. If no objects exist or they all have ``null`` as the value for the given field, ``0`` will be returned. When computing the sum, objects with ``null`` values are ignored. - - - - - - - - - - - - - -.. _toArray: - -.. _toArray__: - -.. _RealmSet_toArray: - -.. _RealmSet_toArray__: - -.. _io_realm_RealmSet_toArray: - -.. _io_realm_RealmSet_toArray__: - - - -toArray -------- - -.. _io_realm_RealmSet_toArray_T_: - -.. _io_realm_RealmSet_toArray_T____: - -.. _toArray_T_: - -.. _toArray_T____: - -.. _RealmSet_toArray_T_: - -.. _RealmSet_toArray_T____: - -.. _io_realm_RealmSet_toArray_T[]_: - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`toArray ` <**T** >( - | **T[]** a - | ) - - - - - * - - - - - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public `Object `__ :ref:`toArray ` () - | - - - - - * - - - - - - - - - - - - - - - - - - -.. _where: - -.. _where__: - -.. _RealmSet_where: - -.. _RealmSet_where__: - -.. _io_realm_RealmSet_where: - -.. _io_realm_RealmSet_where__: - - - -where ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmQuery ` :ref:`where ` () - | - - - - - * - Returns a RealmQuery, which can be used to query for specific objects of this class. - - - - - - - **Returns** - - a RealmQuery object. - - - - - **Throws** - - - `IllegalStateException `__ - if Realm instance has been closed or parent object has been removed. - - - - - - - - - - .. seealso:: - - - - - :ref:`io.realm.RealmQuery ` - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/SetChangeListener.txt b/source/sdk/java/api/io/realm/SetChangeListener.txt deleted file mode 100644 index 0ffe569411..0000000000 --- a/source/sdk/java/api/io/realm/SetChangeListener.txt +++ /dev/null @@ -1,167 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SetChangeListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_SetChangeListener: - - - -io.realm -======== - -:ref:`SetChangeListener ` can be registered with a :ref:`RealmSet ` to receive a notification with a :ref:`SetChangeSet ` to describe the details of what have been changed in the set since last time. - -Realm instances on a thread without an `android.os.Looper `__ cannot register a :ref:`SetChangeListener ` . - - - - - - -.. seealso:: - - - - - :ref:`RealmSet.addChangeListener(SetChangeListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | :ref:`io.realm.RealmSet\ ` set, - | :ref:`SetChangeSet ` changes - | ) - - - - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _SetChangeListener_onChange: - -.. _SetChangeListener_onChange__: - -.. _io_realm_SetChangeListener_onChange: - -.. _io_realm_SetChangeListener_onChange__: - - - -onChange --------- - -.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet_io_realm_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet__io_realm_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_io_realm_RealmSet__SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_RealmSet_io_realm_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_RealmSet__io_realm_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_RealmSet_SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_RealmSet__SetChangeSet_: - -.. _onChange_io_realm_RealmSet_io_realm_SetChangeSet_: - -.. _onChange_io_realm_RealmSet__io_realm_SetChangeSet_: - -.. _onChange_io_realm_RealmSet_SetChangeSet_: - -.. _onChange_io_realm_RealmSet__SetChangeSet_: - -.. _onChange_RealmSet_io_realm_SetChangeSet_: - -.. _onChange_RealmSet__io_realm_SetChangeSet_: - -.. _onChange_RealmSet_SetChangeSet_: - -.. _onChange_RealmSet__SetChangeSet_: - -.. _SetChangeListener_onChange_io_realm_RealmSet_io_realm_SetChangeSet_: - -.. _SetChangeListener_onChange_io_realm_RealmSet__io_realm_SetChangeSet_: - -.. _SetChangeListener_onChange_io_realm_RealmSet_SetChangeSet_: - -.. _SetChangeListener_onChange_io_realm_RealmSet__SetChangeSet_: - -.. _SetChangeListener_onChange_RealmSet_io_realm_SetChangeSet_: - -.. _SetChangeListener_onChange_RealmSet__io_realm_SetChangeSet_: - -.. _SetChangeListener_onChange_RealmSet_SetChangeSet_: - -.. _SetChangeListener_onChange_RealmSet__SetChangeSet_: - -.. _io_realm_SetChangeListener_onChange_RealmSet_T___SetChangeSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | :ref:`io.realm.RealmSet\ ` set, - | :ref:`SetChangeSet ` changes - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/SetChangeSet.txt b/source/sdk/java/api/io/realm/SetChangeSet.txt deleted file mode 100644 index 64e628ed99..0000000000 --- a/source/sdk/java/api/io/realm/SetChangeSet.txt +++ /dev/null @@ -1,287 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class SetChangeSet -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_SetChangeSet: - - - -io.realm -======== - - - | `java.lang.Object `__ - | io.realm.SetChangeSet - - -This class describes the changes made to a set during the last update.:ref:`SetChangeSet ` is passed to the :ref:`SetChangeListener ` which is registered by :ref:`RealmSet.addChangeListener(SetChangeListener) ` . - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`SetChangeSet ` ( - | **OsCollectionChangeSet** osCollectionChangeSet - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **int** - - | :ref:`getNumberOfDeletions ` () - | - - - The number of entries that have been deleted - - - - - * - public **int** - - | :ref:`getNumberOfInsertions ` () - | - - - The number of entries that have been inserted. - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - Whether the change set is empty or not. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _SetChangeSet: - -.. _SetChangeSet__: - -.. _io_realm_SetChangeSet: - -.. _io_realm_SetChangeSet__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SetChangeSet ` ( - | **OsCollectionChangeSet** osCollectionChangeSet - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getNumberOfDeletions: - -.. _getNumberOfDeletions__: - -.. _SetChangeSet_getNumberOfDeletions: - -.. _SetChangeSet_getNumberOfDeletions__: - -.. _io_realm_SetChangeSet_getNumberOfDeletions: - -.. _io_realm_SetChangeSet_getNumberOfDeletions__: - - - -getNumberOfDeletions --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getNumberOfDeletions ` () - | - - - - - * - The number of entries that have been deleted - - - - - - - **Returns** - - the number of deletions - - - - - - - - - - - -.. _getNumberOfInsertions: - -.. _getNumberOfInsertions__: - -.. _SetChangeSet_getNumberOfInsertions: - -.. _SetChangeSet_getNumberOfInsertions__: - -.. _io_realm_SetChangeSet_getNumberOfInsertions: - -.. _io_realm_SetChangeSet_getNumberOfInsertions__: - - - -getNumberOfInsertions ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getNumberOfInsertions ` () - | - - - - - * - The number of entries that have been inserted. - - - - - - - **Returns** - - the number of insertions. - - - - - - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _SetChangeSet_isEmpty: - -.. _SetChangeSet_isEmpty__: - -.. _io_realm_SetChangeSet_isEmpty: - -.. _io_realm_SetChangeSet_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - Whether the change set is empty or not. This is needed to detect whether a notification has been triggered right after subscription. - - - - - - - **Returns** - - whether the change set contains changes. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/Sort.txt b/source/sdk/java/api/io/realm/Sort.txt deleted file mode 100644 index 23d458ab2d..0000000000 --- a/source/sdk/java/api/io/realm/Sort.txt +++ /dev/null @@ -1,307 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum Sort -^^^^^^^^^ - -.. _io_realm_Sort: - - - -io.realm -======== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.Sort - - -This class describes the sorting order used in Realm queries. - - -.. seealso:: - - - - - :ref:`io.realm.RealmQuery.sort(String, Sort) ` - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ASCENDING ` - - - - - - - * - :ref:`DESCENDING ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`getValue ` () - | - - - Returns the value for this setting that is used by the underlying query engine. - - - - - * - public static :ref:`Sort ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`Sort ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_Sort_ASCENDING: - -.. _Sort_ASCENDING: - - - -``ASCENDING`` --------------- - -public static final :ref:`Sort ` - - - - - -.. _io_realm_Sort_DESCENDING: - -.. _Sort_DESCENDING: - - - -``DESCENDING`` ---------------- - -public static final :ref:`Sort ` - - - - - - -Method Detail -============= - -.. _getValue: - -.. _getValue__: - -.. _Sort_getValue: - -.. _Sort_getValue__: - -.. _io_realm_Sort_getValue: - -.. _io_realm_Sort_getValue__: - - - -getValue --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`getValue ` () - | - - - - - * - Returns the value for this setting that is used by the underlying query engine. - - - - - - - **Returns** - - the value used by the underlying query engine to indicate this value. - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _Sort_valueOf: - -.. _Sort_valueOf__: - -.. _io_realm_Sort_valueOf: - -.. _io_realm_Sort_valueOf__: - - - -valueOf -------- - -.. _io_realm_Sort_valueOf_java_lang_String_: - -.. _io_realm_Sort_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _Sort_valueOf_java_lang_String_: - -.. _Sort_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Sort ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Sort_values: - -.. _Sort_values__: - -.. _io_realm_Sort_values: - -.. _io_realm_Sort_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Sort ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/annotations.txt b/source/sdk/java/api/io/realm/annotations.txt deleted file mode 100644 index d2114172ae..0000000000 --- a/source/sdk/java/api/io/realm/annotations.txt +++ /dev/null @@ -1,48 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.annotations -^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - Beta - Ignore - Index - LinkingObjects - PrimaryKey - RealmClass - RealmField - RealmModule - RealmNamingPolicy - Required - - - -| - -- :ref:`io.realm.annotations.Beta ` -- :ref:`io.realm.annotations.Ignore ` -- :ref:`io.realm.annotations.Index ` -- :ref:`io.realm.annotations.LinkingObjects ` -- :ref:`io.realm.annotations.PrimaryKey ` -- :ref:`io.realm.annotations.RealmClass ` -- :ref:`io.realm.annotations.RealmField ` -- :ref:`io.realm.annotations.RealmModule ` -- :ref:`io.realm.annotations.RealmNamingPolicy ` -- :ref:`io.realm.annotations.Required ` - - - diff --git a/source/sdk/java/api/io/realm/annotations/Beta.txt b/source/sdk/java/api/io/realm/annotations/Beta.txt deleted file mode 100644 index 53b885c23c..0000000000 --- a/source/sdk/java/api/io/realm/annotations/Beta.txt +++ /dev/null @@ -1,31 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type Beta -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_Beta: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -This annotation is added to classes, constructors or methods which are considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care. - diff --git a/source/sdk/java/api/io/realm/annotations/Ignore.txt b/source/sdk/java/api/io/realm/annotations/Ignore.txt deleted file mode 100644 index d6fef512ba..0000000000 --- a/source/sdk/java/api/io/realm/annotations/Ignore.txt +++ /dev/null @@ -1,31 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type Ignore -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_Ignore: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - - - diff --git a/source/sdk/java/api/io/realm/annotations/Index.txt b/source/sdk/java/api/io/realm/annotations/Index.txt deleted file mode 100644 index cecf3f79ca..0000000000 --- a/source/sdk/java/api/io/realm/annotations/Index.txt +++ /dev/null @@ -1,33 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type Index -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_Index: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -This annotation will add a search index to the field. A search index will make the Realm file larger and inserts slower but queries will be faster.NOTICE: Only String, int, byte, short, long, boolean and Date fields can be indexed. - - - diff --git a/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt b/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt deleted file mode 100644 index 4660f9a1d7..0000000000 --- a/source/sdk/java/api/io/realm/annotations/LinkingObjects.txt +++ /dev/null @@ -1,196 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type LinkingObjects -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_LinkingObjects: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -Annotation for defining a reverse relationship from one class to another. This annotation can only be added to a field of the type ``RealmResults`` . - - To expose reverse relationships for use, create a declaration as follows: - - -.. code-block:: java - - - - public class Person extends RealmObject { - String name; - Dog dog; // Normal relation - } - - public class Dog extends RealmObject { - // This holds all Person objects with a relation to this Dog object (= linking objects) - @LinkingObjects("dog") - final RealmResults owners = null; - } - - // Find all Dogs with at least one owner named John - realm.where(Dog.class).equalTo("owners.name", "John").findAll(); - - - - - -In the above example \`Person\` is related to \`Dog\` through the field \`dog\`. This in turn means that an implicit reverse relationship exists between the class \`Dog\` and the class \`Person\`. This inverse relationship is made public and queryable by the \`RealmResults\` field annotated with \`\@LinkingObject\`. This makes it possible to query properties of the dogs owner without having to manually maintain a "owner" field in the \`Dog\` class.Linking objects have the following properties: - - - -- The link is maintained by Realm and only works for managed objects. - - -- They can be queried just like normal relation. - - -- They can be followed just like normal relation. - - -- They are ignored when doing a \`copyToRealm().\` - - -- They are ignored when doing a \`copyFromRealm().\` - - -- They are ignored when using the various \`createObjectFromJson\*\` and \`createAllFromJson\*\` methods. - - -- Listeners on an object with a \`\@LinkingObject\` field will not be triggered if the linking objects change, e.g: if another object drops a reference to this object. - - - - -In addition, they have the following restrictions: - - - -- \@Ignore takes precedence. A \@LinkingObjects annotation on \@Ignore field will be ignored. - - - - -- The annotated field cannot be \@Required. - - - - -- The annotated field must be \`final\`. - - -- The annotation argument (the name of the backlinked field) is required. - - -- The annotation argument must be a simple field name. It cannot contain periods ('.'). - - -- The annotated field must be of type \`RealmResults\` where T is concrete class that extends \`RealmModel\`. - - - - -Note that when the source of the reverse reference (\`dog\` in the case above) is a \`List\`, there is a reverse reference for each forward reference, even if both forward references are to the same object. If the \`Person\` class above were defined as: - -.. code-block:: java - - public class DogLover extends RealmObject { - String name; - List dogs = new ArrayList; - } - - - then the following code executes without error - -.. code-block:: java - - Dog fido = new Dog(); - DogLover john = new DogLover() - john.dogs.add(fido); - john.dogs.add(fido); - assert john.dogs.size() == 2; - assert fido.owners.size() == 2; - - - - -Querying inverse relationship is like querying any ``RealmResults`` . This means that an inverse relationship cannot be ``null`` but it can be empty (length is 0). It is possible to query fields in the source class. This is equivalent to link queries. Please read - -`for more information `__ . - - - - -Optional Element Summary -======================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Optional Element and Description - - * - public `String `__ - - - - The name of a field that contains a relation to an instance of the class containing this annotation. - - - - - - - -Element Detail -============== - -.. _value: - -.. _value__: - -.. _LinkingObjects_value: - -.. _LinkingObjects_value__: - -.. _io_realm_annotations_LinkingObjects_value: - -.. _io_realm_annotations_LinkingObjects_value__: - -.. list-table:: - :header-rows: 1 - - * - value - - * - ``public String value`` - - The name of a field that contains a relation to an instance of the class containing this annotation. If this argument is not provided the annotation processor will abort with an ``IllegalArgumentException`` . - - - - - **Default:** - ``""`` - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt b/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt deleted file mode 100644 index e51d2ab475..0000000000 --- a/source/sdk/java/api/io/realm/annotations/PrimaryKey.txt +++ /dev/null @@ -1,45 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type PrimaryKey -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_PrimaryKey: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -The \@PrimaryKey annotation will mark a field as a primary key inside Realm. Only one field in a RealmObject class can have this annotation, and the field should uniquely identify the object. Trying to insert an object with an existing primary key will result in an ``io.realm.exceptions.RealmPrimaryKeyConstraintException`` . Primary key cannot be changed after the object created. - -Primary keys also count as having the :ref:`Index ` annotation. - - - -It is allowed to apply this annotation on the following primitive types: byte, short, int, and long. String, Byte, Short, Integer, Long, ObjectId and UUID are also allowed, and further permitted to have ``null`` as a primary key value. - - - -This annotation is not allowed inside Realm classes marked as ``@RealmClass(embedded = true)`` . - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/RealmClass.txt b/source/sdk/java/api/io/realm/annotations/RealmClass.txt deleted file mode 100644 index d8a0f60109..0000000000 --- a/source/sdk/java/api/io/realm/annotations/RealmClass.txt +++ /dev/null @@ -1,280 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type RealmClass -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_RealmClass: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -Interface used to mark a class that can be persisted by Realm. - - -Optional Element Summary -======================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Optional Element and Description - - * - public **boolean** - - - - Define objects of this type as "Embedded". - - - - - * - public :ref:`RealmNamingPolicy ` - - - - The naming policy applied to all fields in this class. - - - - - * - public `String `__ - - - - Manually set the internal name used by Realm for this class. - - - - - * - public `String `__ - - - - Manually set the internal name used by Realm for this class. - - - - - - - -Element Detail -============== - -.. _embedded: - -.. _embedded__: - -.. _RealmClass_embedded: - -.. _RealmClass_embedded__: - -.. _io_realm_annotations_RealmClass_embedded: - -.. _io_realm_annotations_RealmClass_embedded__: - -.. list-table:: - :header-rows: 1 - - * - embedded - - * - ``public boolean embedded`` - - Define objects of this type as "Embedded". Embedded objects have a slightly different behavior than normal objects: - - - They must have exactly 1 parent linking to them when the embedded object is added to the Realm. Embedded objects can be the parent of other embedded objects. The parent cannot be changed later, except by copying the object. - - - - They cannot have fields annotated with ``@PrimaryKey`` . - - - - - - When a parent object is deleted, all embedded objects are also deleted. - - - - It is possible to define an easy reference to the parent object using the ``@LinkingObjects`` annotation: - - - - - - .. code-block:: java - - - @LinkingObjects - public Parent parent; - - - - - - - - - - - - **Default:** - ``false`` - - - - -.. _fieldNamingPolicy: - -.. _fieldNamingPolicy__: - -.. _RealmClass_fieldNamingPolicy: - -.. _RealmClass_fieldNamingPolicy__: - -.. _io_realm_annotations_RealmClass_fieldNamingPolicy: - -.. _io_realm_annotations_RealmClass_fieldNamingPolicy__: - -.. list-table:: - :header-rows: 1 - - * - fieldNamingPolicy - - * - ``public RealmNamingPolicy fieldNamingPolicy`` - - The naming policy applied to all fields in this class. The default policy is :ref:`RealmNamingPolicy.NO_POLICY ` . - - It is possible to override the naming policy for each field by using the :ref:`RealmField ` annotation. - - - - - - - **Default:** - ``io.realm.annotations.RealmNamingPolicy.NO_POLICY`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting this policy means. ` - - - - - - - - - - -.. _name: - -.. _name__: - -.. _RealmClass_name: - -.. _RealmClass_name__: - -.. _io_realm_annotations_RealmClass_name: - -.. _io_realm_annotations_RealmClass_name__: - -.. list-table:: - :header-rows: 1 - - * - name - - * - ``public String name`` - - Manually set the internal name used by Realm for this class. If this class is part of any modules, this will also override any name policy set using :ref:`RealmModule.classNamingPolicy() ` . - - - - - **Default:** - ``""`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting the name means. ` - - - - - - - - - - -.. _value: - -.. _value__: - -.. _RealmClass_value: - -.. _RealmClass_value__: - -.. _io_realm_annotations_RealmClass_value: - -.. _io_realm_annotations_RealmClass_value__: - -.. list-table:: - :header-rows: 1 - - * - value - - * - ``public String value`` - - Manually set the internal name used by Realm for this class. If this class is part of any modules, this will also override any name policy set using :ref:`RealmModule.classNamingPolicy() ` . - - - - - **Default:** - ``""`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting the name means. ` - - - - - :ref:`name() ` - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/RealmField.txt b/source/sdk/java/api/io/realm/annotations/RealmField.txt deleted file mode 100644 index eb7652bc6b..0000000000 --- a/source/sdk/java/api/io/realm/annotations/RealmField.txt +++ /dev/null @@ -1,156 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type RealmField -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_RealmField: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -Annotation used on fields in Realm model classes. It describes metadata about the field. - - -Optional Element Summary -======================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Optional Element and Description - - * - public `String `__ - - - - Manually set the internal name used by Realm for this field. - - - - - * - public `String `__ - - - - Manually set the internal name used by Realm for this field. - - - - - - - -Element Detail -============== - -.. _name: - -.. _name__: - -.. _RealmField_name: - -.. _RealmField_name__: - -.. _io_realm_annotations_RealmField_name: - -.. _io_realm_annotations_RealmField_name__: - -.. list-table:: - :header-rows: 1 - - * - name - - * - ``public String name`` - - Manually set the internal name used by Realm for this field. This will override any :ref:`RealmNamingPolicy ` set on the class or the module. - - - - - **Default:** - ``""`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting the name means. ` - - - - - - - - - - -.. _value: - -.. _value__: - -.. _RealmField_value: - -.. _RealmField_value__: - -.. _io_realm_annotations_RealmField_value: - -.. _io_realm_annotations_RealmField_value__: - -.. list-table:: - :header-rows: 1 - - * - value - - * - ``public String value`` - - Manually set the internal name used by Realm for this field. This will override any :ref:`RealmNamingPolicy ` set on the class or the module. - - - - - **Default:** - ``""`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting the name means. ` - - - - - :ref:`name() ` - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/RealmModule.txt b/source/sdk/java/api/io/realm/annotations/RealmModule.txt deleted file mode 100644 index 4ce5b26f8b..0000000000 --- a/source/sdk/java/api/io/realm/annotations/RealmModule.txt +++ /dev/null @@ -1,318 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type RealmModule -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_RealmModule: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -By default a Realm can store all classes extending RealmObject in a project. However, if you want to restrict a Realm to only contain a subset of classes or want to share them between a library project and an app project, you must use a RealmModule.A RealmModule is a collection of classes extending RealmObject that can be combined with other RealmModules to create the schema for a Realm. This makes it easier to control versioning and migration of those Realms. - -A RealmModule can either be a library module or an app module. The distinction is made by setting ``library = true`` . Setting ``library = true`` is normally only relevant for library authors. See below for further details. - - - -Currently, it is not possible to have multiple RealmModule declarations in a single file. If you have more than one RealmModule, you will have to use separate Java files for each module. - - - -RealmModules and libraries -========================== - -Realms default behavior is to automatically create a RealmModule called ``DefaultRealmModule`` which contains all classes extending RealmObject in a project. This module is automatically known by Realm. - -This behavior is problematic when combining a library project and an app project that both uses Realm. This is because the ``DefaultRealmModule`` will be created for both the library project and the app project, which will cause the project to fail with duplicate class definition errors. - - - -Library authors are responsible for avoiding this conflict by using explicit modules where ``library = true`` is set. This disables the generation of the DefaultRealmModule for the library project and allows the library to be included in the app project that also uses Realm. This means that library projects that uses Realm internally are required to specify a specific module using ``RealmConfiguration.modules()`` . - - - -App developers are not required to specify any modules, as they implicitly use the ``DefaultRealmModule`` , but they now has the option of adding the library project classes to their schema using ``RealmConfiguration.addModule()`` . - - - - - - -.. seealso:: - - - - - `Example of a project using modules `__ - - - - - - - - - - -Optional Element Summary -======================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Optional Element and Description - - * - public **boolean** - - - - Instead of adding all Realm classes manually to a module, set this boolean to true to automatically include all Realm classes in this project. - - - - - * - public :ref:`RealmNamingPolicy ` - - - - The naming policy applied to all classes part of this module. - - - - - * - public `Class `__ - - - - Specifies the classes extending RealmObject that should be part of this module. - - - - - * - public :ref:`RealmNamingPolicy ` - - - - The naming policy applied to all field names in all classes part of this module. - - - - - * - public **boolean** - - - - Setting this to true will mark this module as a library module. - - - - - - - -Element Detail -============== - -.. _allClasses: - -.. _allClasses__: - -.. _RealmModule_allClasses: - -.. _RealmModule_allClasses__: - -.. _io_realm_annotations_RealmModule_allClasses: - -.. _io_realm_annotations_RealmModule_allClasses__: - -.. list-table:: - :header-rows: 1 - - * - allClasses - - * - ``public boolean allClasses`` - - Instead of adding all Realm classes manually to a module, set this boolean to true to automatically include all Realm classes in this project. This does not include classes from other libraries which must be exposed using their own module. Setting both ``allClasses = true`` and ``classes()`` will result in the annotation processor throwing an exception. - - - - - **Default:** - ``false`` - - - - -.. _classNamingPolicy: - -.. _classNamingPolicy__: - -.. _RealmModule_classNamingPolicy: - -.. _RealmModule_classNamingPolicy__: - -.. _io_realm_annotations_RealmModule_classNamingPolicy: - -.. _io_realm_annotations_RealmModule_classNamingPolicy__: - -.. list-table:: - :header-rows: 1 - - * - classNamingPolicy - - * - ``public RealmNamingPolicy classNamingPolicy`` - - The naming policy applied to all classes part of this module. The default policy is :ref:`RealmNamingPolicy.NO_POLICY ` . To define a naming policy for all fields in the classes, use :ref:`fieldNamingPolicy() ` . - - It is possible to override the naming policy specified in the module in each class using the :ref:`RealmClass ` annotation. - - - - If a class is part of multiple modules, the same naming policy must be applied to both modules, otherwise an error will be thrown. - - - - - **Default:** - ``io.realm.annotations.RealmNamingPolicy.NO_POLICY`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting this policy means. ` - - - - - - - - - - -.. _classes: - -.. _classes__: - -.. _RealmModule_classes: - -.. _RealmModule_classes__: - -.. _io_realm_annotations_RealmModule_classes: - -.. _io_realm_annotations_RealmModule_classes__: - -.. list-table:: - :header-rows: 1 - - * - classes - - * - ``public Class classes`` - - Specifies the classes extending RealmObject that should be part of this module. Only classes in this project can be included. Classes from other libraries must be exposed using their own module. Setting both ``allClasses = true`` and ``classes()`` will result in the annotation processor throwing an exception. - - - - - **Default:** - ``{}`` - - - - -.. _fieldNamingPolicy: - -.. _fieldNamingPolicy__: - -.. _RealmModule_fieldNamingPolicy: - -.. _RealmModule_fieldNamingPolicy__: - -.. _io_realm_annotations_RealmModule_fieldNamingPolicy: - -.. _io_realm_annotations_RealmModule_fieldNamingPolicy__: - -.. list-table:: - :header-rows: 1 - - * - fieldNamingPolicy - - * - ``public RealmNamingPolicy fieldNamingPolicy`` - - The naming policy applied to all field names in all classes part of this module. The default policy is :ref:`RealmNamingPolicy.NO_POLICY ` . To define a naming policy for class names, use :ref:`classNamingPolicy() ` . - - It is possible to override this naming policy using either :ref:`RealmClass.fieldNamingPolicy() ` or :ref:`RealmField.name() ` . - - - - - - - **Default:** - ``io.realm.annotations.RealmNamingPolicy.NO_POLICY`` - - - - .. seealso:: - - - - - :ref:`io.realm.annotations.RealmNamingPolicy for more information about what setting this policy means. ` - - - - - - - - - - -.. _library: - -.. _library__: - -.. _RealmModule_library: - -.. _RealmModule_library__: - -.. _io_realm_annotations_RealmModule_library: - -.. _io_realm_annotations_RealmModule_library__: - -.. list-table:: - :header-rows: 1 - - * - library - - * - ``public boolean library`` - - Setting this to true will mark this module as a library module. This will prevent Realm from generating the ``DefaultRealmModule`` containing all classes. This is required by libraries so they do not interfere with Realms running in app code, but it also means that all libraries using Realm must explicitly use a module and cannot rely on the default module being present. Creating library modules and normal modules in the same project is not allowed and will result in the annotation processor throwing an exception. - - - - - **Default:** - ``false`` - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt b/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt deleted file mode 100644 index 49118bb203..0000000000 --- a/source/sdk/java/api/io/realm/annotations/RealmNamingPolicy.txt +++ /dev/null @@ -1,462 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum RealmNamingPolicy -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_RealmNamingPolicy: - - - -io.realm.annotations -==================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.annotations.RealmNamingPolicy - - -This enum defines the possible ways class and field names can be mapped from what is used in Java to the name used internally in the Realm file.Examples where this is useful: - - - -- To support two model classes with the same simple name but in different packages. - - -- To make it easier to work with cross platform schemas as naming conventions are different. - - -- To use a Java class name that is longer than the 57 character limit enforced by Realm. - - -- To change a field name in Java without forcing app users through a migration process. - - - - -Depending on where the policy is applied, it will have slightly different semantics: - -- If applied to :ref:`RealmModule.classNamingPolicy ` all classes part of that module will be affected. If a class is part of multiple modules, the same naming policy must be applied to both modules, otherwise an error will be thrown. - - - - -- If applied to :ref:`RealmModule.fieldNamingPolicy ` all persistable fields in all classes part of this module will be affected. - - - - -- If applied to :ref:`RealmClass.fieldNamingPolicy ` all fields in that class will be affected. This will override any field naming policy specified on a module. - - - - - - -An example of this: - - - -.. code-block:: java - - - @RealmClass(name = "__person", fieldNamingPolicy = RealmNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) - public class Person implements RealmModel { // is converted to "__person" internally - public string firstName; // Is converted to "first_name" internally - } - - - - - -Choosing an internal name that differs from the name used in the Java model classes has the following implications: - - - -- Queries on ``DynamicRealm`` must use the internal name. Queries on normal ``Realm`` instances must continue to use the name as it is defined in the Java class. - - - - -- Migrations must use the internal name when creating classes and fields. - - -- Schema errors reported will use the internal names. - - - - -When automatically converting Java variable names, each variable name is normalized by splitting it into a list of words that are then joined using the rules of the target format. The following heuristics are used for determining what constitutes a "word". - - - -1. Anytime a ``_`` or ``$`` is encountered. Examples are "_FirstName", "_First_Name" and "$First$Name" which all becomes "First" and "Name". - - - - -#. Anytime you switch from a lower case character to an upper case character as identified by `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FirstName" which becomes "First" and "Name". - - - - -#. Anytime you switch from more than one uppercase character to a lower case one. The last upper case letter is assumed to be part of the next word. This is identified by using `Character.isUpperCase(int) `__ and `Character.isLowerCase(int) `__ . Example is "FIRSTName" which becomes "FIRST" and "Name. - - - - -#. Some characters like emojiis are neither uppercase nor lowercase characters, so they will be part of the current word. Examples are "my😁" and "MY😁" which are both treated as one word. - - -#. Hungarian notation, i.e. variable names starting with lowercase "m" followed by uppercase letter is stripped and not considered part of any word. Example is "mFirstName" and "mFIRSTName" which becomes "First" and "Name. - - - - -Note that changing the internal name does *NOT* affect importing data from JSON. The JSON data must still follow the names as defined in the Realm Java class. - -When it comes to parsing JSON using standard libraries like Moshi, GSON or Jackson it is important to keep in mind that these libraries define the transformation from JSON to Java while setting internal Realm names define the transformation from Java to the Realm file. - -This means that if you want to import data into Realm from JSON using these libraries you still need to provide the annotations from both the JSON parser library and Realm. - -Using Moshi, it would look something like this: - - - -.. code-block:: java - - - public class Person extends RealmObject { - @Json(name = "first_name") // Name used in JSON input. - @RealmField(name = "first_name") // Name used internally in the Realm file. - public string firstName; // name used in Java - } - - - - - - - - -.. seealso:: - - - - - :ref:`RealmModule ` - - - - - :ref:`RealmClass ` - - - - - :ref:`RealmField ` - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`CAMEL_CASE ` - - The name in the Java model class is converted to camelCase, i.e. - - - - - * - :ref:`IDENTITY ` - - The name in the Java model class is used as is internally. - - - - - * - :ref:`LOWER_CASE_WITH_UNDERSCORES ` - - The name in the Java model class is converted lowercase with each word separated by ``_`` . - - - - - - - * - :ref:`NO_POLICY ` - - No policy is applied. - - - - - * - :ref:`PASCAL_CASE ` - - The name in the Java model class is converted to PascalCase, i.e. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`RealmNamingPolicy ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`RealmNamingPolicy ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_annotations_RealmNamingPolicy_CAMEL_CASE: - -.. _RealmNamingPolicy_CAMEL_CASE: - - - -``CAMEL_CASE`` ---------------- - -public static final :ref:`RealmNamingPolicy ` - -The name in the Java model class is converted to camelCase, i.e. all words are joined together with the first letter in the first word lower cased, and the first letter of all subsequent words upper cased. This is the standard naming schema in Java, Kotlin, Swift and JavaScript.Examples: "firstName", "FirstName", "mFirstName", "FIRST_NAME", "First$Name" all becomes "firstName". - - - - - -.. _io_realm_annotations_RealmNamingPolicy_IDENTITY: - -.. _RealmNamingPolicy_IDENTITY: - - - -``IDENTITY`` -------------- - -public static final :ref:`RealmNamingPolicy ` - -The name in the Java model class is used as is internally. - - - -.. _io_realm_annotations_RealmNamingPolicy_LOWER_CASE_WITH_UNDERSCORES: - -.. _RealmNamingPolicy_LOWER_CASE_WITH_UNDERSCORES: - - - -``LOWER_CASE_WITH_UNDERSCORES`` --------------------------------- - -public static final :ref:`RealmNamingPolicy ` - -The name in the Java model class is converted lowercase with each word separated by ``_`` . This is the default naming scheme in C++. - -Examples: "firstName", "FirstName", "mFirstName", "FIRST_NAME", "First$Name" all becomes "first_name". - - - - - -.. _io_realm_annotations_RealmNamingPolicy_NO_POLICY: - -.. _RealmNamingPolicy_NO_POLICY: - - - -``NO_POLICY`` --------------- - -public static final :ref:`RealmNamingPolicy ` - -No policy is applied. This policy will not override any policy set on a parent element, e.g. if set in :ref:`RealmClass.fieldNamingPolicy ` , the module policy will still apply to field names. - -If two modules disagree on the policy and one of them is ``NO_POLICY`` , the other will be chosen without an error being thrown. - - - -This policy is the default. - - - - - -.. _io_realm_annotations_RealmNamingPolicy_PASCAL_CASE: - -.. _RealmNamingPolicy_PASCAL_CASE: - - - -``PASCAL_CASE`` ----------------- - -public static final :ref:`RealmNamingPolicy ` - -The name in the Java model class is converted to PascalCase, i.e. all words are joined together with the first letter of all words upper cased. This is the default naming scheme in .NET.Examples: "firstName", "FirstName", "mFirstName", "FIRST_NAME", "First$Name" all becomes "FirstName". - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _RealmNamingPolicy_valueOf: - -.. _RealmNamingPolicy_valueOf__: - -.. _io_realm_annotations_RealmNamingPolicy_valueOf: - -.. _io_realm_annotations_RealmNamingPolicy_valueOf__: - - - -valueOf -------- - -.. _io_realm_annotations_RealmNamingPolicy_valueOf_java_lang_String_: - -.. _io_realm_annotations_RealmNamingPolicy_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _RealmNamingPolicy_valueOf_java_lang_String_: - -.. _RealmNamingPolicy_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmNamingPolicy ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _RealmNamingPolicy_values: - -.. _RealmNamingPolicy_values__: - -.. _io_realm_annotations_RealmNamingPolicy_values: - -.. _io_realm_annotations_RealmNamingPolicy_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmNamingPolicy ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/annotations/Required.txt b/source/sdk/java/api/io/realm/annotations/Required.txt deleted file mode 100644 index f3d4f25306..0000000000 --- a/source/sdk/java/api/io/realm/annotations/Required.txt +++ /dev/null @@ -1,53 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Annotation Type Required -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_annotations_Required: - - - -io.realm.annotations -==================== - -**Implemented interfaces:** - - - -- `java.lang.annotation.Annotation `__ - - -This annotation will mark the field or the element in ``io.realm.RealmList`` as not nullable. - -When a field of type ``Boolean, Byte, Short, Integer, Long, Float, Double, String, byte[], Date`` is annotated with :ref:`Required ` , it cannot be set to ``null`` and Realm will throw an exception if it happens. - - - -Fields with primitive types are implicitly required. Note, ``String`` is not a primitive type, so in Java it is default nullable unless it is marked ``@Required`` . In Kotlin the reverse is true, so a ``String`` is non-null. To specify a nullable String in Kotlin you should use ``String?`` . - - - -If this annotation is used on a ``RealmList`` , the annotation is applied to the elements inside the list and not the list itself. The list itself is always non-null. This means that a list marked with this annotation are never allowed to hold ``null`` values even if the datatype would otherwise allow it. Realm will throw an exception if you attempt to store null values into a list marked ``@Required`` . - - - -This annotation cannot be used on a ``RealmAny`` , as the inner value of a RealmAny field is always nullable. Realm will throw an exception if you attempt mark a ``RealmAny`` as ``@Required`` . - - - -Compiling will fail if the :ref:`Required ` annotation is put an a ``RealmList`` containing references to other Realm objects. - - - - - diff --git a/source/sdk/java/api/io/realm/coroutines.txt b/source/sdk/java/api/io/realm/coroutines.txt deleted file mode 100644 index d4691a616b..0000000000 --- a/source/sdk/java/api/io/realm/coroutines.txt +++ /dev/null @@ -1,32 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.coroutines -^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - FlowFactory - RealmFlowFactory - - - -| - -- :ref:`io.realm.coroutines.FlowFactory ` -- :ref:`io.realm.coroutines.RealmFlowFactory ` - - - diff --git a/source/sdk/java/api/io/realm/coroutines/FlowFactory.txt b/source/sdk/java/api/io/realm/coroutines/FlowFactory.txt deleted file mode 100644 index 4ea100ea7d..0000000000 --- a/source/sdk/java/api/io/realm/coroutines/FlowFactory.txt +++ /dev/null @@ -1,1633 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface FlowFactory -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_coroutines_FlowFactory: - - - -io.realm.coroutines -=================== - -Factory interface for creating Kotlin **Flow**s for Realm classes. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **** - - | :ref:`changesetFrom ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - Creates a **Flow** for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - Creates a **Flow** for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` instance. - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` instance. - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - Creates a **Flow** for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - Creates a **Flow** for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm - | ) - - - Creates a **Flow** for a :ref:`DynamicRealm ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - Creates a **Flow** for a :ref:`Realm ` . - - - - - - - - - -Method Detail -============= - -.. _changesetFrom: - -.. _changesetFrom__: - -.. _FlowFactory_changesetFrom: - -.. _FlowFactory_changesetFrom__: - -.. _io_realm_coroutines_FlowFactory_changesetFrom: - -.. _io_realm_coroutines_FlowFactory_changesetFrom__: - - - -changesetFrom -------------- - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _FlowFactory_changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object plus the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the object is coming. - - - - - - - ``dynamicRealmObject`` - :ref:`DynamicRealmObject ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_T_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__T_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_RealmModel_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__RealmModel_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_T_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__T_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_RealmModel_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__RealmModel_: - -.. _changesetFrom_io_realm_Realm_T_: - -.. _changesetFrom_io_realm_Realm__T_: - -.. _changesetFrom_io_realm_Realm_RealmModel_: - -.. _changesetFrom_io_realm_Realm__RealmModel_: - -.. _changesetFrom_Realm_T_: - -.. _changesetFrom_Realm__T_: - -.. _changesetFrom_Realm_RealmModel_: - -.. _changesetFrom_Realm__RealmModel_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_T_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__T_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_RealmModel_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__RealmModel_: - -.. _FlowFactory_changesetFrom_Realm_T_: - -.. _FlowFactory_changesetFrom_Realm__T_: - -.. _FlowFactory_changesetFrom_Realm_RealmModel_: - -.. _FlowFactory_changesetFrom_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object plus the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``realm`` - :ref:`Realm ` instance from where the object is coming. - - - - - - - ``realmObject`` - :ref:`RealmObject ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _changesetFrom_DynamicRealm_RealmList_: - -.. _changesetFrom_DynamicRealm__RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _FlowFactory_changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_DynamicRealm_RealmList_: - -.. _FlowFactory_changesetFrom_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the object is coming. - - - - - - - ``list`` - :ref:`RealmList ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__RealmList_: - -.. _changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _changesetFrom_io_realm_Realm_RealmList_: - -.. _changesetFrom_io_realm_Realm__RealmList_: - -.. _changesetFrom_Realm_io_realm_RealmList_: - -.. _changesetFrom_Realm__io_realm_RealmList_: - -.. _changesetFrom_Realm_RealmList_: - -.. _changesetFrom_Realm__RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_RealmList_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__RealmList_: - -.. _FlowFactory_changesetFrom_Realm_io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_Realm__io_realm_RealmList_: - -.. _FlowFactory_changesetFrom_Realm_RealmList_: - -.. _FlowFactory_changesetFrom_Realm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``realm`` - :ref:`Realm ` instance from where the object is coming. - - - - - - - ``list`` - :ref:`RealmList ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _changesetFrom_DynamicRealm_RealmResults_: - -.. _changesetFrom_DynamicRealm__RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _FlowFactory_changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_DynamicRealm_RealmResults_: - -.. _FlowFactory_changesetFrom_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_DynamicRealm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the object is coming. - - - - - - - ``results`` - :ref:`RealmResults ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmResults. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_io_realm_Realm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__RealmResults_: - -.. _changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm__RealmResults_: - -.. _changesetFrom_Realm_io_realm_RealmResults_: - -.. _changesetFrom_Realm__io_realm_RealmResults_: - -.. _changesetFrom_Realm_RealmResults_: - -.. _changesetFrom_Realm__RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_Realm_RealmResults_: - -.. _FlowFactory_changesetFrom_io_realm_Realm__RealmResults_: - -.. _FlowFactory_changesetFrom_Realm_io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_Realm__io_realm_RealmResults_: - -.. _FlowFactory_changesetFrom_Realm_RealmResults_: - -.. _FlowFactory_changesetFrom_Realm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_changesetFrom_Realm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``realm`` - :ref:`Realm ` instance from where the object is coming. - - - - - - - ``results`` - :ref:`RealmResults ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmResults. - - - - - - - - - - - - - -.. _from: - -.. _from__: - -.. _FlowFactory_from: - -.. _FlowFactory_from__: - -.. _io_realm_coroutines_FlowFactory_from: - -.. _io_realm_coroutines_FlowFactory_from__: - - - -from ----- - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm_DynamicRealmObject_: - -.. _from_DynamicRealm__DynamicRealmObject_: - -.. _FlowFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _FlowFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _FlowFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _FlowFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _FlowFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _FlowFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _FlowFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _FlowFactory_from_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - - - - - - **Parameters** - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the object is coming. - - - - - - - ``dynamicRealmObject`` - :ref:`DynamicRealmObject ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_T_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__T_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_RealmModel_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__RealmModel_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_T_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__T_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_RealmModel_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__RealmModel_: - -.. _from_io_realm_Realm_T_: - -.. _from_io_realm_Realm__T_: - -.. _from_io_realm_Realm_RealmModel_: - -.. _from_io_realm_Realm__RealmModel_: - -.. _from_Realm_T_: - -.. _from_Realm__T_: - -.. _from_Realm_RealmModel_: - -.. _from_Realm__RealmModel_: - -.. _FlowFactory_from_io_realm_Realm_T_: - -.. _FlowFactory_from_io_realm_Realm__T_: - -.. _FlowFactory_from_io_realm_Realm_RealmModel_: - -.. _FlowFactory_from_io_realm_Realm__RealmModel_: - -.. _FlowFactory_from_Realm_T_: - -.. _FlowFactory_from_Realm__T_: - -.. _FlowFactory_from_Realm_RealmModel_: - -.. _FlowFactory_from_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - - - - **Type Parameters** - - - ``T`` - type of query target - - - - - - - - **Parameters** - - - ``realmObject`` - :ref:`RealmObject ` instance being observed for changes to be emitted by the flow. - - - - - - - ``realm`` - :ref:`Realm ` instance from where the object is coming. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__RealmList_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm_RealmList_: - -.. _from_io_realm_DynamicRealm__RealmList_: - -.. _from_DynamicRealm_io_realm_RealmList_: - -.. _from_DynamicRealm__io_realm_RealmList_: - -.. _from_DynamicRealm_RealmList_: - -.. _from_DynamicRealm__RealmList_: - -.. _FlowFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _FlowFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _FlowFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _FlowFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _FlowFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _FlowFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _FlowFactory_from_DynamicRealm_RealmList_: - -.. _FlowFactory_from_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmList. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - **Type Parameters** - - - ``T`` - type of RealmObject - - - - - - - - **Parameters** - - - ``realmList`` - :ref:`RealmList ` instance being observed for changes to be emitted by the flow. - - - - - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the results are coming. - - - - - - - - - - **Returns** - - **Flow** that emit all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__RealmList_: - -.. _from_io_realm_Realm_io_realm_RealmList_: - -.. _from_io_realm_Realm__io_realm_RealmList_: - -.. _from_io_realm_Realm_RealmList_: - -.. _from_io_realm_Realm__RealmList_: - -.. _from_Realm_io_realm_RealmList_: - -.. _from_Realm__io_realm_RealmList_: - -.. _from_Realm_RealmList_: - -.. _from_Realm__RealmList_: - -.. _FlowFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _FlowFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _FlowFactory_from_io_realm_Realm_RealmList_: - -.. _FlowFactory_from_io_realm_Realm__RealmList_: - -.. _FlowFactory_from_Realm_io_realm_RealmList_: - -.. _FlowFactory_from_Realm__io_realm_RealmList_: - -.. _FlowFactory_from_Realm_RealmList_: - -.. _FlowFactory_from_Realm__RealmList_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmList. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - **Type Parameters** - - - ``T`` - type of RealmObject - - - - - - - - **Parameters** - - - ``realmList`` - :ref:`RealmList ` instance being observed for changes to be emitted by the flow. - - - - - - - ``realm`` - :ref:`Realm ` instance from where the results are coming. - - - - - - - - - - **Returns** - - **Flow** that emit all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__RealmResults_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm_RealmResults_: - -.. _from_io_realm_DynamicRealm__RealmResults_: - -.. _from_DynamicRealm_io_realm_RealmResults_: - -.. _from_DynamicRealm__io_realm_RealmResults_: - -.. _from_DynamicRealm_RealmResults_: - -.. _from_DynamicRealm__RealmResults_: - -.. _FlowFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _FlowFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _FlowFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _FlowFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _FlowFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _FlowFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _FlowFactory_from_DynamicRealm_RealmResults_: - -.. _FlowFactory_from_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - - - - **Type Parameters** - - - ``T`` - type of RealmObject. - - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` instance being observed for changes to be emitted by the flow. - - - - - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance from where the results are coming. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__RealmResults_: - -.. _from_io_realm_Realm_io_realm_RealmResults_: - -.. _from_io_realm_Realm__io_realm_RealmResults_: - -.. _from_io_realm_Realm_RealmResults_: - -.. _from_io_realm_Realm__RealmResults_: - -.. _from_Realm_io_realm_RealmResults_: - -.. _from_Realm__io_realm_RealmResults_: - -.. _from_Realm_RealmResults_: - -.. _from_Realm__RealmResults_: - -.. _FlowFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _FlowFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _FlowFactory_from_io_realm_Realm_RealmResults_: - -.. _FlowFactory_from_io_realm_Realm__RealmResults_: - -.. _FlowFactory_from_Realm_io_realm_RealmResults_: - -.. _FlowFactory_from_Realm__io_realm_RealmResults_: - -.. _FlowFactory_from_Realm_RealmResults_: - -.. _FlowFactory_from_Realm__RealmResults_: - -.. _io_realm_coroutines_FlowFactory_from_Realm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - - - - **Type Parameters** - - - ``T`` - type of RealmObject. - - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` instance being observed for changes to be emitted by the flow. - - - - - - - ``realm`` - :ref:`Realm ` instance from where the results are coming. - - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_DynamicRealm_: - -.. _io_realm_coroutines_FlowFactory_from_DynamicRealm_: - -.. _from_io_realm_DynamicRealm_: - -.. _from_DynamicRealm_: - -.. _FlowFactory_from_io_realm_DynamicRealm_: - -.. _FlowFactory_from_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - - - - - - **Parameters** - - - ``dynamicRealm`` - :ref:`DynamicRealm ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - Flow that emits all updates to the Realm. - - - - - - - - - -.. _io_realm_coroutines_FlowFactory_from_io_realm_Realm_: - -.. _io_realm_coroutines_FlowFactory_from_Realm_: - -.. _from_io_realm_Realm_: - -.. _from_Realm_: - -.. _FlowFactory_from_io_realm_Realm_: - -.. _FlowFactory_from_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - - - * - Creates a **Flow** for a :ref:`Realm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - - - - - - **Parameters** - - - ``realm`` - :ref:`Realm ` instance being observed for changes to be emitted by the flow. - - - - - - - - - - **Returns** - - Flow that emits all updates to the Realm. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt b/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt deleted file mode 100644 index 3681daf949..0000000000 --- a/source/sdk/java/api/io/realm/coroutines/RealmFlowFactory.txt +++ /dev/null @@ -1,1471 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmFlowFactory -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_coroutines_RealmFlowFactory: - - - -io.realm.coroutines -=================== - - - | `java.lang.Object `__ - | io.realm.coroutines.RealmFlowFactory - - -**Implemented interfaces:** - - - -- :ref:`io.realm.coroutines.FlowFactory ` - - -Factory class used to create coroutine **Flow**s. - -This class is used by default unless overridden in :ref:`io.realm.RealmConfiguration.Builder.flowFactory(FlowFactory) ` . - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmFlowFactory ` ( - | `Boolean `__ returnFrozenObjects - | ) - - - Constructor for the Flow factory. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **** - - | :ref:`changesetFrom ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - Creates a **Flow** for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - Creates a **Flow** for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` instance. - - - - - - - * - public **** - - | :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` instance. - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - Creates a **Flow** for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - Creates a **Flow** for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - Creates a **Flow** for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a **Flow** for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm - | ) - - - Creates a **Flow** for a :ref:`DynamicRealm ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - Creates a **Flow** for a :ref:`Realm ` . - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmFlowFactory: - -.. _RealmFlowFactory__: - -.. _io_realm_coroutines_RealmFlowFactory: - -.. _io_realm_coroutines_RealmFlowFactory__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFlowFactory ` ( - | `Boolean `__ returnFrozenObjects - | ) - - - - - * - Constructor for the Flow factory. - - - - - **Parameters** - - - ``returnFrozenObjects`` - whether the emissions should return frozen objects or not. - - - - - - - - - - - - - - -Method Detail -============= - -.. _changesetFrom: - -.. _changesetFrom__: - -.. _RealmFlowFactory_changesetFrom: - -.. _RealmFlowFactory_changesetFrom__: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom__: - - - -changesetFrom -------------- - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_DynamicRealmObject_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object plus the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_T_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__T_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_T_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__T_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__RealmModel_: - -.. _changesetFrom_io_realm_Realm_T_: - -.. _changesetFrom_io_realm_Realm__T_: - -.. _changesetFrom_io_realm_Realm_RealmModel_: - -.. _changesetFrom_io_realm_Realm__RealmModel_: - -.. _changesetFrom_Realm_T_: - -.. _changesetFrom_Realm__T_: - -.. _changesetFrom_Realm_RealmModel_: - -.. _changesetFrom_Realm__RealmModel_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_T_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__T_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_RealmModel_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__RealmModel_: - -.. _RealmFlowFactory_changesetFrom_Realm_T_: - -.. _RealmFlowFactory_changesetFrom_Realm__T_: - -.. _RealmFlowFactory_changesetFrom_Realm_RealmModel_: - -.. _RealmFlowFactory_changesetFrom_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object plus the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _changesetFrom_DynamicRealm_RealmList_: - -.. _changesetFrom_DynamicRealm__RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__RealmList_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__RealmList_: - -.. _changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _changesetFrom_io_realm_Realm_RealmList_: - -.. _changesetFrom_io_realm_Realm__RealmList_: - -.. _changesetFrom_Realm_io_realm_RealmList_: - -.. _changesetFrom_Realm__io_realm_RealmList_: - -.. _changesetFrom_Realm_RealmList_: - -.. _changesetFrom_Realm__RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__RealmList_: - -.. _RealmFlowFactory_changesetFrom_Realm_io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_Realm__io_realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_Realm_RealmList_: - -.. _RealmFlowFactory_changesetFrom_Realm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the list it should emit the list plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _changesetFrom_DynamicRealm_RealmResults_: - -.. _changesetFrom_DynamicRealm__RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_DynamicRealm__RealmResults_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_DynamicRealm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmResults. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_io_realm_Realm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__RealmResults_: - -.. _changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm_RealmResults_: - -.. _changesetFrom_io_realm_Realm__RealmResults_: - -.. _changesetFrom_Realm_io_realm_RealmResults_: - -.. _changesetFrom_Realm__io_realm_RealmResults_: - -.. _changesetFrom_Realm_RealmResults_: - -.. _changesetFrom_Realm__RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_io_realm_Realm__RealmResults_: - -.. _RealmFlowFactory_changesetFrom_Realm_io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_Realm__io_realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_Realm_RealmResults_: - -.. _RealmFlowFactory_changesetFrom_Realm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_changesetFrom_Realm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetFrom ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` instance. It should emit the initial results when subscribed to and on each subsequent update of the results it should emit the results plus the :ref:`io.realm.rx.CollectionChange ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmResults. - - - - - - - - - - - - - -.. _from: - -.. _from__: - -.. _RealmFlowFactory_from: - -.. _RealmFlowFactory_from__: - -.. _io_realm_coroutines_RealmFlowFactory_from: - -.. _io_realm_coroutines_RealmFlowFactory_from__: - - - -from ----- - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm_DynamicRealmObject_: - -.. _from_DynamicRealm__DynamicRealmObject_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RealmFlowFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _RealmFlowFactory_from_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`DynamicRealmObject ` dynamicRealmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_T_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__T_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_T_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__T_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_RealmModel_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__RealmModel_: - -.. _from_io_realm_Realm_T_: - -.. _from_io_realm_Realm__T_: - -.. _from_io_realm_Realm_RealmModel_: - -.. _from_io_realm_Realm__RealmModel_: - -.. _from_Realm_T_: - -.. _from_Realm__T_: - -.. _from_Realm_RealmModel_: - -.. _from_Realm__RealmModel_: - -.. _RealmFlowFactory_from_io_realm_Realm_T_: - -.. _RealmFlowFactory_from_io_realm_Realm__T_: - -.. _RealmFlowFactory_from_io_realm_Realm_RealmModel_: - -.. _RealmFlowFactory_from_io_realm_Realm__RealmModel_: - -.. _RealmFlowFactory_from_Realm_T_: - -.. _RealmFlowFactory_from_Realm__T_: - -.. _RealmFlowFactory_from_Realm_RealmModel_: - -.. _RealmFlowFactory_from_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | **T** realmObject - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the DynamicRealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__RealmList_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm_RealmList_: - -.. _from_io_realm_DynamicRealm__RealmList_: - -.. _from_DynamicRealm_io_realm_RealmList_: - -.. _from_DynamicRealm__io_realm_RealmList_: - -.. _from_DynamicRealm_RealmList_: - -.. _from_DynamicRealm__RealmList_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _RealmFlowFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _RealmFlowFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _RealmFlowFactory_from_DynamicRealm_RealmList_: - -.. _RealmFlowFactory_from_DynamicRealm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmList. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - - - - - **Returns** - - **Flow** that emit all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__io_realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__RealmList_: - -.. _from_io_realm_Realm_io_realm_RealmList_: - -.. _from_io_realm_Realm__io_realm_RealmList_: - -.. _from_io_realm_Realm_RealmList_: - -.. _from_io_realm_Realm__RealmList_: - -.. _from_Realm_io_realm_RealmList_: - -.. _from_Realm__io_realm_RealmList_: - -.. _from_Realm_RealmList_: - -.. _from_Realm__RealmList_: - -.. _RealmFlowFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_Realm_RealmList_: - -.. _RealmFlowFactory_from_io_realm_Realm__RealmList_: - -.. _RealmFlowFactory_from_Realm_io_realm_RealmList_: - -.. _RealmFlowFactory_from_Realm__io_realm_RealmList_: - -.. _RealmFlowFactory_from_Realm_RealmList_: - -.. _RealmFlowFactory_from_Realm__RealmList_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__RealmList_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` realmList - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmList ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmList. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - - - - - **Returns** - - **Flow** that emit all updates to the RealmList. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__RealmResults_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm_RealmResults_: - -.. _from_io_realm_DynamicRealm__RealmResults_: - -.. _from_DynamicRealm_io_realm_RealmResults_: - -.. _from_DynamicRealm__io_realm_RealmResults_: - -.. _from_DynamicRealm_RealmResults_: - -.. _from_DynamicRealm__RealmResults_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _RealmFlowFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _RealmFlowFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _RealmFlowFactory_from_DynamicRealm_RealmResults_: - -.. _RealmFlowFactory_from_DynamicRealm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`DynamicRealm ` dynamicRealm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__io_realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__RealmResults_: - -.. _from_io_realm_Realm_io_realm_RealmResults_: - -.. _from_io_realm_Realm__io_realm_RealmResults_: - -.. _from_io_realm_Realm_RealmResults_: - -.. _from_io_realm_Realm__RealmResults_: - -.. _from_Realm_io_realm_RealmResults_: - -.. _from_Realm__io_realm_RealmResults_: - -.. _from_Realm_RealmResults_: - -.. _from_Realm__RealmResults_: - -.. _RealmFlowFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_Realm_RealmResults_: - -.. _RealmFlowFactory_from_io_realm_Realm__RealmResults_: - -.. _RealmFlowFactory_from_Realm_io_realm_RealmResults_: - -.. _RealmFlowFactory_from_Realm__io_realm_RealmResults_: - -.. _RealmFlowFactory_from_Realm_RealmResults_: - -.. _RealmFlowFactory_from_Realm__RealmResults_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm__RealmResults_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**T** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a **Flow** for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - - - - - - - - **Returns** - - **Flow** that emits all updates to the RealmObject. - - - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_DynamicRealm_: - -.. _io_realm_coroutines_RealmFlowFactory_from_DynamicRealm_: - -.. _from_io_realm_DynamicRealm_: - -.. _from_DynamicRealm_: - -.. _RealmFlowFactory_from_io_realm_DynamicRealm_: - -.. _RealmFlowFactory_from_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` dynamicRealm - | ) - - - - - * - Creates a **Flow** for a :ref:`DynamicRealm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - - - - - - - - **Returns** - - Flow that emits all updates to the Realm. - - - - - - - - - -.. _io_realm_coroutines_RealmFlowFactory_from_io_realm_Realm_: - -.. _io_realm_coroutines_RealmFlowFactory_from_Realm_: - -.. _from_io_realm_Realm_: - -.. _from_Realm_: - -.. _RealmFlowFactory_from_io_realm_Realm_: - -.. _RealmFlowFactory_from_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - - - * - Creates a **Flow** for a :ref:`Realm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - - - - - - - - **Returns** - - Flow that emits all updates to the Realm. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions.txt b/source/sdk/java/api/io/realm/exceptions.txt deleted file mode 100644 index 0ab7dc3e97..0000000000 --- a/source/sdk/java/api/io/realm/exceptions.txt +++ /dev/null @@ -1,42 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.exceptions -^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - RealmFileException.Kind - DownloadingRealmInterruptedException - RealmException - RealmFileException - RealmMigrationNeededException - RealmPrimaryKeyConstraintException - RealmError - - - -| - -- :ref:`io.realm.exceptions.RealmFileException.Kind ` -- :ref:`io.realm.exceptions.DownloadingRealmInterruptedException ` -- :ref:`io.realm.exceptions.RealmException ` -- :ref:`io.realm.exceptions.RealmFileException ` -- :ref:`io.realm.exceptions.RealmMigrationNeededException ` -- :ref:`io.realm.exceptions.RealmPrimaryKeyConstraintException ` -- :ref:`io.realm.exceptions.RealmError ` - - - diff --git a/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt b/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt deleted file mode 100644 index 99d1c82d50..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/DownloadingRealmInterruptedException.txt +++ /dev/null @@ -1,145 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception DownloadingRealmInterruptedException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_DownloadingRealmInterruptedException: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.exceptions.DownloadingRealmInterruptedException - - -Exception class used when a Realm was interrupted while downloading the initial data set. This can only happen if :ref:`SyncConfiguration.Builder.waitForInitialRemoteData() ` is set. - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`DownloadingRealmInterruptedException ` ( - | :ref:`SyncConfiguration ` syncConfig, - | `Throwable `__ exception - | ) - - - - - - - - * - | :ref:`DownloadingRealmInterruptedException ` ( - | :ref:`SyncConfiguration ` syncConfig, - | `String `__ message - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _DownloadingRealmInterruptedException: - -.. _DownloadingRealmInterruptedException__: - -.. _io_realm_exceptions_DownloadingRealmInterruptedException: - -.. _io_realm_exceptions_DownloadingRealmInterruptedException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DownloadingRealmInterruptedException ` ( - | :ref:`SyncConfiguration ` syncConfig, - | `Throwable `__ exception - | ) - - - - - * - - - - - - - - - - - - -.. _DownloadingRealmInterruptedException: - -.. _DownloadingRealmInterruptedException__: - -.. _io_realm_exceptions_DownloadingRealmInterruptedException: - -.. _io_realm_exceptions_DownloadingRealmInterruptedException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DownloadingRealmInterruptedException ` ( - | :ref:`SyncConfiguration ` syncConfig, - | `String `__ message - | ) - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmError.txt b/source/sdk/java/api/io/realm/exceptions/RealmError.txt deleted file mode 100644 index 5b0c1fc13f..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmError.txt +++ /dev/null @@ -1,98 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Error RealmError -^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmError: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Error `__ - | io.realm.exceptions.RealmError - - -RealmError is a Realm specific Error used when unrecoverable problems happen in the underlying storage engine. A RealmError should never be caught or ignored. By doing so, the Realm could possibly get corrupted. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmError ` ( - | `String `__ detailMessage - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _RealmError: - -.. _RealmError__: - -.. _io_realm_exceptions_RealmError: - -.. _io_realm_exceptions_RealmError__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmError ` ( - | `String `__ detailMessage - | ) - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmException.txt b/source/sdk/java/api/io/realm/exceptions/RealmException.txt deleted file mode 100644 index 9dbb8eedf2..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmException.txt +++ /dev/null @@ -1,141 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception RealmException -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmException: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.exceptions.RealmException - - -RealmException is for Realm specific exceptions. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmException ` ( - | `String `__ detailMessage - | ) - - - - - - - - * - | :ref:`RealmException ` ( - | `String `__ detailMessage, - | `Throwable `__ exception - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _RealmException: - -.. _RealmException__: - -.. _io_realm_exceptions_RealmException: - -.. _io_realm_exceptions_RealmException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmException ` ( - | `String `__ detailMessage - | ) - - - - - * - - - - - - - - - - - - -.. _RealmException: - -.. _RealmException__: - -.. _io_realm_exceptions_RealmException: - -.. _io_realm_exceptions_RealmException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmException ` ( - | `String `__ detailMessage, - | `Throwable `__ exception - | ) - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt b/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt deleted file mode 100644 index 1e00343605..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmFileException.txt +++ /dev/null @@ -1,381 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception RealmFileException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmFileException: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.exceptions.RealmFileException - - -Class for reporting problems when accessing the Realm related files. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmFileException ` ( - | **byte** value, - | `String `__ message - | ) - - - - - - - - * - | :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `String `__ message - | ) - - - - - - - - * - | :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `Throwable `__ cause - | ) - - - - - - - - * - | :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `String `__ message, - | `Throwable `__ cause - | ) - - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`RealmFileException.Kind ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`RealmFileException.Kind ` - - | :ref:`getKind ` () - | - - - Gets the **kind** of this exception. - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _RealmFileException: - -.. _RealmFileException__: - -.. _io_realm_exceptions_RealmFileException: - -.. _io_realm_exceptions_RealmFileException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFileException ` ( - | **byte** value, - | `String `__ message - | ) - - - - - * - - - - - - - - - - - - -.. _RealmFileException: - -.. _RealmFileException__: - -.. _io_realm_exceptions_RealmFileException: - -.. _io_realm_exceptions_RealmFileException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `String `__ message - | ) - - - - - * - - - - - - - - - - - - -.. _RealmFileException: - -.. _RealmFileException__: - -.. _io_realm_exceptions_RealmFileException: - -.. _io_realm_exceptions_RealmFileException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `Throwable `__ cause - | ) - - - - - * - - - - - - - - - - - - -.. _RealmFileException: - -.. _RealmFileException__: - -.. _io_realm_exceptions_RealmFileException: - -.. _io_realm_exceptions_RealmFileException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFileException ` ( - | :ref:`RealmFileException.Kind ` kind, - | `String `__ message, - | `Throwable `__ cause - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getKind: - -.. _getKind__: - -.. _RealmFileException_getKind: - -.. _RealmFileException_getKind__: - -.. _io_realm_exceptions_RealmFileException_getKind: - -.. _io_realm_exceptions_RealmFileException_getKind__: - - - -getKind -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmFileException.Kind ` :ref:`getKind ` () - | - - - - - * - Gets the **kind** of this exception. - - - - - - - - - **Returns** - - the **kind** of this exception. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _RealmFileException_toString: - -.. _RealmFileException_toString__: - -.. _io_realm_exceptions_RealmFileException_toString: - -.. _io_realm_exceptions_RealmFileException_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Throwable `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt b/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt deleted file mode 100644 index a7c6db31b7..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmFileException/Kind.txt +++ /dev/null @@ -1,386 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum RealmFileException.Kind -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmFileException_Kind: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.exceptions.RealmFileException.Kind - - - - -**Enclosing class:** - -:ref:`RealmFileException ` - - - -The specific kind of this :ref:`RealmFileException ` . - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ACCESS_ERROR ` - - Thrown for any I/O related exception scenarios when a Realm is opened. - - - - - * - :ref:`BAD_HISTORY ` - - Thrown if the history type of the on-disk Realm is unexpected or incompatible. - - - - - * - :ref:`EXISTS ` - - Thrown if the destination file exists but it is not supposed to. - - - - - * - :ref:`FORMAT_UPGRADE_REQUIRED ` - - Thrown if the file needs to be upgraded to a new format, but upgrades have been explicitly disabled. - - - - - * - :ref:`INCOMPATIBLE_LOCK_FILE ` - - Thrown if the database file is currently open in another process which cannot share with the current process due to an architecture mismatch. - - - - - * - :ref:`INCOMPATIBLE_SYNC_FILE ` - - Thrown if an attempt was made to open an Realm file created with Realm Object Server 1.\*, which is not compatible with Realm Object Server 2.\*. - - - - - * - :ref:`NOT_FOUND ` - - Thrown if the relevant file cannot be found. - - - - - * - :ref:`PERMISSION_DENIED ` - - Thrown if the user does not have permission to open or create the specified file in the specified access mode when the Realm is opened. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`RealmFileException.Kind ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`RealmFileException.Kind ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_exceptions_RealmFileException_Kind_ACCESS_ERROR: - -.. _RealmFileException_Kind_ACCESS_ERROR: - - - -``ACCESS_ERROR`` ------------------ - -public static final :ref:`RealmFileException.Kind ` - -Thrown for any I/O related exception scenarios when a Realm is opened. - - - -.. _io_realm_exceptions_RealmFileException_Kind_BAD_HISTORY: - -.. _RealmFileException_Kind_BAD_HISTORY: - - - -``BAD_HISTORY`` ----------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the history type of the on-disk Realm is unexpected or incompatible. - - - -.. _io_realm_exceptions_RealmFileException_Kind_EXISTS: - -.. _RealmFileException_Kind_EXISTS: - - - -``EXISTS`` ------------ - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the destination file exists but it is not supposed to. - - - -.. _io_realm_exceptions_RealmFileException_Kind_FORMAT_UPGRADE_REQUIRED: - -.. _RealmFileException_Kind_FORMAT_UPGRADE_REQUIRED: - - - -``FORMAT_UPGRADE_REQUIRED`` ----------------------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the file needs to be upgraded to a new format, but upgrades have been explicitly disabled. - - - -.. _io_realm_exceptions_RealmFileException_Kind_INCOMPATIBLE_LOCK_FILE: - -.. _RealmFileException_Kind_INCOMPATIBLE_LOCK_FILE: - - - -``INCOMPATIBLE_LOCK_FILE`` ---------------------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the database file is currently open in another process which cannot share with the current process due to an architecture mismatch. - - - -.. _io_realm_exceptions_RealmFileException_Kind_INCOMPATIBLE_SYNC_FILE: - -.. _RealmFileException_Kind_INCOMPATIBLE_SYNC_FILE: - - - -``INCOMPATIBLE_SYNC_FILE`` ---------------------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if an attempt was made to open an Realm file created with Realm Object Server 1.\*, which is not compatible with Realm Object Server 2.\*. This exception should automatically be handled by Realm. - - - -.. _io_realm_exceptions_RealmFileException_Kind_NOT_FOUND: - -.. _RealmFileException_Kind_NOT_FOUND: - - - -``NOT_FOUND`` --------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the relevant file cannot be found. - - - -.. _io_realm_exceptions_RealmFileException_Kind_PERMISSION_DENIED: - -.. _RealmFileException_Kind_PERMISSION_DENIED: - - - -``PERMISSION_DENIED`` ----------------------- - -public static final :ref:`RealmFileException.Kind ` - -Thrown if the user does not have permission to open or create the specified file in the specified access mode when the Realm is opened. - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _Kind_valueOf: - -.. _Kind_valueOf__: - -.. _RealmFileException_Kind_valueOf: - -.. _RealmFileException_Kind_valueOf__: - -.. _io_realm_exceptions_RealmFileException_Kind_valueOf: - -.. _io_realm_exceptions_RealmFileException_Kind_valueOf__: - - - -valueOf -------- - -.. _io_realm_exceptions_RealmFileException_Kind_valueOf_java_lang_String_: - -.. _io_realm_exceptions_RealmFileException_Kind_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _RealmFileException_Kind_valueOf_java_lang_String_: - -.. _RealmFileException_Kind_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmFileException.Kind ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Kind_values: - -.. _Kind_values__: - -.. _RealmFileException_Kind_values: - -.. _RealmFileException_Kind_values__: - -.. _io_realm_exceptions_RealmFileException_Kind_values: - -.. _io_realm_exceptions_RealmFileException_Kind_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmFileException.Kind ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt b/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt deleted file mode 100644 index 6f970bcf11..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmMigrationNeededException.txt +++ /dev/null @@ -1,191 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception RealmMigrationNeededException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmMigrationNeededException: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.exceptions.RealmMigrationNeededException - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmMigrationNeededException ` ( - | `String `__ canonicalRealmPath, - | `String `__ detailMessage - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public `String `__ - - | :ref:`getPath ` () - | - - - Returns the canonical path to the Realm file that needs to be migrated. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _RealmMigrationNeededException: - -.. _RealmMigrationNeededException__: - -.. _io_realm_exceptions_RealmMigrationNeededException: - -.. _io_realm_exceptions_RealmMigrationNeededException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmMigrationNeededException ` ( - | `String `__ canonicalRealmPath, - | `String `__ detailMessage - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getPath: - -.. _getPath__: - -.. _RealmMigrationNeededException_getPath: - -.. _RealmMigrationNeededException_getPath__: - -.. _io_realm_exceptions_RealmMigrationNeededException_getPath: - -.. _io_realm_exceptions_RealmMigrationNeededException_getPath__: - - - -getPath -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getPath ` () - | - - - - - * - Returns the canonical path to the Realm file that needs to be migrated.This can be used for easy reference during a migration: - - - - - - - - - **Returns** - - Canonical path to the Realm file. - - - - - - - - - .. seealso:: - - - - - `File.getCanonicalPath() `__ - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt b/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt deleted file mode 100644 index 77861d7e4c..0000000000 --- a/source/sdk/java/api/io/realm/exceptions/RealmPrimaryKeyConstraintException.txt +++ /dev/null @@ -1,113 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception RealmPrimaryKeyConstraintException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_exceptions_RealmPrimaryKeyConstraintException: - - - -io.realm.exceptions -=================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.exceptions.RealmPrimaryKeyConstraintException - - -Class for reporting problems when the primary key constraint is being broken. - - -.. seealso:: - - - - - :ref:`io.realm.annotations.PrimaryKey ` - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmPrimaryKeyConstraintException ` ( - | `String `__ message - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _RealmPrimaryKeyConstraintException: - -.. _RealmPrimaryKeyConstraintException__: - -.. _io_realm_exceptions_RealmPrimaryKeyConstraintException: - -.. _io_realm_exceptions_RealmPrimaryKeyConstraintException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmPrimaryKeyConstraintException ` ( - | `String `__ message - | ) - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/gradle.txt b/source/sdk/java/api/io/realm/gradle.txt deleted file mode 100644 index 557b703e48..0000000000 --- a/source/sdk/java/api/io/realm/gradle.txt +++ /dev/null @@ -1,33 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:orphan: - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.gradle -^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - RealmPluginExtension - RealmPluginExtension.PropertyChangedListener - - - -| - -- :ref:`io.realm.gradle.RealmPluginExtension ` -- :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` - - - diff --git a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt deleted file mode 100644 index 64ec353c73..0000000000 --- a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension.txt +++ /dev/null @@ -1,532 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:orphan: - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmPluginExtension -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_gradle_RealmPluginExtension: - - - -io.realm.gradle -=============== - - - | `java.lang.Object `__ - | io.realm.gradle.RealmPluginExtension - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmPluginExtension ` () - | - - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static interface`` - - :ref:`RealmPluginExtension.PropertyChangedListener ` - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`KEY_KOTLIN_EXTENSIONS_ENABLED ` - - - - - * - public static final `String `__ - - - - :ref:`KEY_SYNC_ENABLED ` - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addPropertyListener ` ( - | `String `__ property, - | :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` listener - | ) - - - - - - - - * - public **boolean** - - | :ref:`isKotlinExtensionsEnabled ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isSyncEnabled ` () - | - - - - - - - - * - public **void** - - | :ref:`setKotlinExtensionsEnabled ` ( - | **boolean** kotlinExtensionsEnabled - | ) - - - - - - - - * - public **void** - - | :ref:`setSyncEnabled ` ( - | **boolean** syncEnabled - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_gradle_RealmPluginExtension_KEY_KOTLIN_EXTENSIONS_ENABLED: - - - -``KEY_KOTLIN_EXTENSIONS_ENABLED`` ----------------------------------- - - - - -.. _io_realm_gradle_RealmPluginExtension_KEY_SYNC_ENABLED: - - - -``KEY_SYNC_ENABLED`` ---------------------- - - - - - - -Constructor Detail -================== - -.. _RealmPluginExtension: - -.. _RealmPluginExtension__: - -.. _io_realm_gradle_RealmPluginExtension: - -.. _io_realm_gradle_RealmPluginExtension__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmPluginExtension ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _addPropertyListener: - -.. _addPropertyListener__: - -.. _RealmPluginExtension_addPropertyListener: - -.. _RealmPluginExtension_addPropertyListener__: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener__: - - - -addPropertyListener -------------------- - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: - -.. _io_realm_gradle_RealmPluginExtension_addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String_PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String__PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_String_PropertyChangedListener_: - -.. _addPropertyListener_String__PropertyChangedListener_: - -.. _addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: - -.. _addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String__PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_java_lang_String__RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String_io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String__io_realm_gradle_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String__PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String_RealmPluginExtension_PropertyChangedListener_: - -.. _RealmPluginExtension_addPropertyListener_String__RealmPluginExtension_PropertyChangedListener_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addPropertyListener ` ( - | `String `__ property, - | :ref:`io.realm.gradle.RealmPluginExtension.PropertyChangedListener ` listener - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _isKotlinExtensionsEnabled: - -.. _isKotlinExtensionsEnabled__: - -.. _RealmPluginExtension_isKotlinExtensionsEnabled: - -.. _RealmPluginExtension_isKotlinExtensionsEnabled__: - -.. _io_realm_gradle_RealmPluginExtension_isKotlinExtensionsEnabled: - -.. _io_realm_gradle_RealmPluginExtension_isKotlinExtensionsEnabled__: - - - -isKotlinExtensionsEnabled -------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isKotlinExtensionsEnabled ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _isSyncEnabled: - -.. _isSyncEnabled__: - -.. _RealmPluginExtension_isSyncEnabled: - -.. _RealmPluginExtension_isSyncEnabled__: - -.. _io_realm_gradle_RealmPluginExtension_isSyncEnabled: - -.. _io_realm_gradle_RealmPluginExtension_isSyncEnabled__: - - - -isSyncEnabled -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isSyncEnabled ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _setKotlinExtensionsEnabled: - -.. _setKotlinExtensionsEnabled__: - -.. _RealmPluginExtension_setKotlinExtensionsEnabled: - -.. _RealmPluginExtension_setKotlinExtensionsEnabled__: - -.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled: - -.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled__: - - - -setKotlinExtensionsEnabled --------------------------- - -.. _io_realm_gradle_RealmPluginExtension_setKotlinExtensionsEnabled_boolean_: - -.. _setKotlinExtensionsEnabled_boolean_: - -.. _RealmPluginExtension_setKotlinExtensionsEnabled_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setKotlinExtensionsEnabled ` ( - | **boolean** kotlinExtensionsEnabled - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _setSyncEnabled: - -.. _setSyncEnabled__: - -.. _RealmPluginExtension_setSyncEnabled: - -.. _RealmPluginExtension_setSyncEnabled__: - -.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled: - -.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled__: - - - -setSyncEnabled --------------- - -.. _io_realm_gradle_RealmPluginExtension_setSyncEnabled_boolean_: - -.. _setSyncEnabled_boolean_: - -.. _RealmPluginExtension_setSyncEnabled_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`setSyncEnabled ` ( - | **boolean** syncEnabled - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt b/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt deleted file mode 100644 index 831e9cb9eb..0000000000 --- a/source/sdk/java/api/io/realm/gradle/RealmPluginExtension/PropertyChangedListener.txt +++ /dev/null @@ -1,114 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:orphan: - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmPluginExtension.PropertyChangedListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener: - - - -io.realm.gradle -=============== - - - -**Enclosing class:** - -:ref:`RealmPluginExtension ` - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | **T** value - | ) - - - - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _PropertyChangedListener_onChange: - -.. _PropertyChangedListener_onChange__: - -.. _RealmPluginExtension_PropertyChangedListener_onChange: - -.. _RealmPluginExtension_PropertyChangedListener_onChange__: - -.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange: - -.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange__: - - - -onChange --------- - -.. _io_realm_gradle_RealmPluginExtension_PropertyChangedListener_onChange_T_: - -.. _onChange_T_: - -.. _RealmPluginExtension_PropertyChangedListener_onChange_T_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | **T** value - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/log.txt b/source/sdk/java/api/io/realm/log.txt deleted file mode 100644 index 615515bc3e..0000000000 --- a/source/sdk/java/api/io/realm/log.txt +++ /dev/null @@ -1,34 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.log -^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - LogLevel - RealmLog - RealmLogger - - - -| - -- :ref:`io.realm.log.LogLevel ` -- :ref:`io.realm.log.RealmLog ` -- :ref:`io.realm.log.RealmLogger ` - - - diff --git a/source/sdk/java/api/io/realm/log/LogLevel.txt b/source/sdk/java/api/io/realm/log/LogLevel.txt deleted file mode 100644 index a53da42aa9..0000000000 --- a/source/sdk/java/api/io/realm/log/LogLevel.txt +++ /dev/null @@ -1,270 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class LogLevel -^^^^^^^^^^^^^^ - -.. _io_realm_log_LogLevel: - - - -io.realm.log -============ - - - | `java.lang.Object `__ - | io.realm.log.LogLevel - - -The Log levels defined and used by Realm when logging events in the API.Realm uses the log levels defined by Log4J: https://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html - - - - -.. seealso:: - - - - - :ref:`RealmLog.add(RealmLogger) ` - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`LogLevel ` () - | - - - - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final **int** - - - - :ref:`ALL ` - - The ALL has the lowest possible rank and is intended to turn on all logging. - - - * - public static final **int** - - - - :ref:`DEBUG ` - - The DEBUG level designates fine-grained informational events that are mostly useful to debug an application. - - - * - public static final **int** - - - - :ref:`ERROR ` - - The ERROR level designates error events that might still allow the application to continue running. - - - * - public static final **int** - - - - :ref:`FATAL ` - - The FATAL level designates very severe error events that will presumably lead the application to abort. - - - * - public static final **int** - - - - :ref:`INFO ` - - The INFO level designates informational messages that highlight the progress of the application at coarse-grained level. - - - * - public static final **int** - - - - :ref:`OFF ` - - The OFF has the highest possible rank and is intended to turn off logging. - - - * - public static final **int** - - - - :ref:`TRACE ` - - The TRACE level designates finer-grained informational events than DEBUG. - - - * - public static final **int** - - - - :ref:`WARN ` - - The WARN level designates potentially harmful situations. - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_log_LogLevel_ALL: - - - -``ALL`` --------- - -The ALL has the lowest possible rank and is intended to turn on all logging. - - -.. _io_realm_log_LogLevel_DEBUG: - - - -``DEBUG`` ----------- - -The DEBUG level designates fine-grained informational events that are mostly useful to debug an application. - - -.. _io_realm_log_LogLevel_ERROR: - - - -``ERROR`` ----------- - -The ERROR level designates error events that might still allow the application to continue running. - - -.. _io_realm_log_LogLevel_FATAL: - - - -``FATAL`` ----------- - -The FATAL level designates very severe error events that will presumably lead the application to abort. - - -.. _io_realm_log_LogLevel_INFO: - - - -``INFO`` ---------- - -The INFO level designates informational messages that highlight the progress of the application at coarse-grained level. - - -.. _io_realm_log_LogLevel_OFF: - - - -``OFF`` --------- - -The OFF has the highest possible rank and is intended to turn off logging. - - -.. _io_realm_log_LogLevel_TRACE: - - - -``TRACE`` ----------- - -The TRACE level designates finer-grained informational events than DEBUG. - - -.. _io_realm_log_LogLevel_WARN: - - - -``WARN`` ---------- - -The WARN level designates potentially harmful situations. - - - - -Constructor Detail -================== - -.. _LogLevel: - -.. _LogLevel__: - -.. _io_realm_log_LogLevel: - -.. _io_realm_log_LogLevel__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`LogLevel ` () - | - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/log/RealmLog.txt b/source/sdk/java/api/io/realm/log/RealmLog.txt deleted file mode 100644 index f4d1f1f80f..0000000000 --- a/source/sdk/java/api/io/realm/log/RealmLog.txt +++ /dev/null @@ -1,2964 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmLog -^^^^^^^^^^^^^^ - -.. _io_realm_log_RealmLog: - - - -io.realm.log -============ - - - | `java.lang.Object `__ - | io.realm.log.RealmLog - - -Global logger used by all Realm components. Custom loggers can be added by registering classes implementing :ref:`RealmLogger ` . - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmLog ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static **void** - - | :ref:`add ` ( - | :ref:`RealmLogger ` logger - | ) - - - Adds a logger implementation that will be notified on log events. - - - - - * - public static **void** - - | :ref:`clear ` () - | - - - Removes all loggers. - - - - - * - public static **void** - - | :ref:`debug ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.DEBUG ` event. - - - - - - - * - public static **void** - - | :ref:`debug ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.DEBUG ` event. - - - - - - - * - public static **void** - - | :ref:`debug ` ( - | `Throwable `__ throwable - | ) - - - Logs a :ref:`LogLevel.DEBUG ` exception. - - - - - - - * - public static **void** - - | :ref:`error ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs an :ref:`LogLevel.ERROR ` event. - - - - - - - * - public static **void** - - | :ref:`error ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs an :ref:`LogLevel.ERROR ` event. - - - - - - - * - public static **void** - - | :ref:`error ` ( - | `Throwable `__ throwable - | ) - - - Logs an :ref:`LogLevel.ERROR ` exception. - - - - - - - * - public static **void** - - | :ref:`fatal ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.FATAL ` event. - - - - - - - * - public static **void** - - | :ref:`fatal ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs an :ref:`LogLevel.FATAL ` event. - - - - - - - * - public static **void** - - | :ref:`fatal ` ( - | `Throwable `__ throwable - | ) - - - Logs a :ref:`LogLevel.FATAL ` exception. - - - - - - - * - public static **int** - - | :ref:`getLevel ` () - | - - - Get the current :ref:`LogLevel ` . - - - - - - - * - public static **void** - - | :ref:`info ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs an :ref:`LogLevel.INFO ` event. - - - - - - - * - public static **void** - - | :ref:`info ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs an :ref:`LogLevel.INFO ` event. - - - - - - - * - public static **void** - - | :ref:`info ` ( - | `Throwable `__ throwable - | ) - - - Logs an :ref:`LogLevel.INFO ` exception. - - - - - - - * - public static **void** - - | :ref:`registerDefaultLogger ` () - | - - - Adds default native logger if it has been removed before. - - - - - * - public static **boolean** - - | :ref:`remove ` ( - | :ref:`RealmLogger ` logger - | ) - - - Removes the given logger if it is currently added. - - - - - * - public static **void** - - | :ref:`setLevel ` ( - | **int** level - | ) - - - Sets the current :ref:`LogLevel ` . - - - - - - - * - public static **void** - - | :ref:`trace ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.TRACE ` event. - - - - - - - * - public static **void** - - | :ref:`trace ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.TRACE ` event. - - - - - - - * - public static **void** - - | :ref:`trace ` ( - | `Throwable `__ throwable - | ) - - - Logs a :ref:`LogLevel.TRACE ` exception. - - - - - - - * - public static **void** - - | :ref:`warn ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.WARN ` event. - - - - - - - * - public static **void** - - | :ref:`warn ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - Logs a :ref:`LogLevel.WARN ` event. - - - - - - - * - public static **void** - - | :ref:`warn ` ( - | `Throwable `__ throwable - | ) - - - Logs a :ref:`LogLevel.WARN ` exception. - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmLog: - -.. _RealmLog__: - -.. _io_realm_log_RealmLog: - -.. _io_realm_log_RealmLog__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmLog ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _add: - -.. _add__: - -.. _RealmLog_add: - -.. _RealmLog_add__: - -.. _io_realm_log_RealmLog_add: - -.. _io_realm_log_RealmLog_add__: - - - -add ----- - -.. _io_realm_log_RealmLog_add_io_realm_log_RealmLogger_: - -.. _io_realm_log_RealmLog_add_RealmLogger_: - -.. _add_io_realm_log_RealmLogger_: - -.. _add_RealmLogger_: - -.. _RealmLog_add_io_realm_log_RealmLogger_: - -.. _RealmLog_add_RealmLogger_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`add ` ( - | :ref:`RealmLogger ` logger - | ) - - - - - * - Adds a logger implementation that will be notified on log events. - - - - - **Parameters** - - - ``logger`` - the reference to a :ref:`RealmLogger ` implementation. - - - - - - - - - - - - - - - - - - -.. _clear: - -.. _clear__: - -.. _RealmLog_clear: - -.. _RealmLog_clear__: - -.. _io_realm_log_RealmLog_clear: - -.. _io_realm_log_RealmLog_clear__: - - - -clear ------ - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`clear ` () - | - - - - - * - Removes all loggers. The default native logger will be removed as well. Use :ref:`registerDefaultLogger() ` to add it back. - - - - - - - - - - - - - - - - - -.. _debug: - -.. _debug__: - -.. _RealmLog_debug: - -.. _RealmLog_debug__: - -.. _io_realm_log_RealmLog_debug: - -.. _io_realm_log_RealmLog_debug__: - - - -debug ------ - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_debug_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_debug_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_debug_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_debug_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_debug_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_debug_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_debug_Throwable__String__Object____: - -.. _debug_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _debug_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _debug_java_lang_Throwable_java_lang_String_Object_: - -.. _debug_java_lang_Throwable__java_lang_String__Object_: - -.. _debug_java_lang_Throwable_java_lang_String_Object____: - -.. _debug_java_lang_Throwable__java_lang_String__Object____: - -.. _debug_java_lang_Throwable_String_java_lang_Object_: - -.. _debug_java_lang_Throwable__String__java_lang_Object_: - -.. _debug_java_lang_Throwable_String_Object_: - -.. _debug_java_lang_Throwable__String__Object_: - -.. _debug_java_lang_Throwable_String_Object____: - -.. _debug_java_lang_Throwable__String__Object____: - -.. _debug_Throwable_java_lang_String_java_lang_Object_: - -.. _debug_Throwable__java_lang_String__java_lang_Object_: - -.. _debug_Throwable_java_lang_String_Object_: - -.. _debug_Throwable__java_lang_String__Object_: - -.. _debug_Throwable_java_lang_String_Object____: - -.. _debug_Throwable__java_lang_String__Object____: - -.. _debug_Throwable_String_java_lang_Object_: - -.. _debug_Throwable__String__java_lang_Object_: - -.. _debug_Throwable_String_Object_: - -.. _debug_Throwable__String__Object_: - -.. _debug_Throwable_String_Object____: - -.. _debug_Throwable__String__Object____: - -.. _RealmLog_debug_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_debug_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_debug_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_debug_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_debug_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_debug_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_debug_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_debug_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_debug_java_lang_Throwable_String_Object_: - -.. _RealmLog_debug_java_lang_Throwable__String__Object_: - -.. _RealmLog_debug_java_lang_Throwable_String_Object____: - -.. _RealmLog_debug_java_lang_Throwable__String__Object____: - -.. _RealmLog_debug_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_debug_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_debug_Throwable_java_lang_String_Object_: - -.. _RealmLog_debug_Throwable__java_lang_String__Object_: - -.. _RealmLog_debug_Throwable_java_lang_String_Object____: - -.. _RealmLog_debug_Throwable__java_lang_String__Object____: - -.. _RealmLog_debug_Throwable_String_java_lang_Object_: - -.. _RealmLog_debug_Throwable__String__java_lang_Object_: - -.. _RealmLog_debug_Throwable_String_Object_: - -.. _RealmLog_debug_Throwable__String__Object_: - -.. _RealmLog_debug_Throwable_String_Object____: - -.. _RealmLog_debug_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`debug ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.DEBUG ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_debug_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_debug_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_debug_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_debug_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_debug_String_Object_: - -.. _io_realm_log_RealmLog_debug_String__Object_: - -.. _io_realm_log_RealmLog_debug_String_Object____: - -.. _io_realm_log_RealmLog_debug_String__Object____: - -.. _debug_java_lang_String_java_lang_Object_: - -.. _debug_java_lang_String__java_lang_Object_: - -.. _debug_java_lang_String_Object_: - -.. _debug_java_lang_String__Object_: - -.. _debug_java_lang_String_Object____: - -.. _debug_java_lang_String__Object____: - -.. _debug_String_java_lang_Object_: - -.. _debug_String__java_lang_Object_: - -.. _debug_String_Object_: - -.. _debug_String__Object_: - -.. _debug_String_Object____: - -.. _debug_String__Object____: - -.. _RealmLog_debug_java_lang_String_java_lang_Object_: - -.. _RealmLog_debug_java_lang_String__java_lang_Object_: - -.. _RealmLog_debug_java_lang_String_Object_: - -.. _RealmLog_debug_java_lang_String__Object_: - -.. _RealmLog_debug_java_lang_String_Object____: - -.. _RealmLog_debug_java_lang_String__Object____: - -.. _RealmLog_debug_String_java_lang_Object_: - -.. _RealmLog_debug_String__java_lang_Object_: - -.. _RealmLog_debug_String_Object_: - -.. _RealmLog_debug_String__Object_: - -.. _RealmLog_debug_String_Object____: - -.. _RealmLog_debug_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`debug ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.DEBUG ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_debug_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_debug_Throwable_: - -.. _debug_java_lang_Throwable_: - -.. _debug_Throwable_: - -.. _RealmLog_debug_java_lang_Throwable_: - -.. _RealmLog_debug_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`debug ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs a :ref:`LogLevel.DEBUG ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - -.. _error: - -.. _error__: - -.. _RealmLog_error: - -.. _RealmLog_error__: - -.. _io_realm_log_RealmLog_error: - -.. _io_realm_log_RealmLog_error__: - - - -error ------ - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_error_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_error_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_error_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_error_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_error_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_error_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_error_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_error_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_error_Throwable__String__Object____: - -.. _error_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _error_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _error_java_lang_Throwable_java_lang_String_Object_: - -.. _error_java_lang_Throwable__java_lang_String__Object_: - -.. _error_java_lang_Throwable_java_lang_String_Object____: - -.. _error_java_lang_Throwable__java_lang_String__Object____: - -.. _error_java_lang_Throwable_String_java_lang_Object_: - -.. _error_java_lang_Throwable__String__java_lang_Object_: - -.. _error_java_lang_Throwable_String_Object_: - -.. _error_java_lang_Throwable__String__Object_: - -.. _error_java_lang_Throwable_String_Object____: - -.. _error_java_lang_Throwable__String__Object____: - -.. _error_Throwable_java_lang_String_java_lang_Object_: - -.. _error_Throwable__java_lang_String__java_lang_Object_: - -.. _error_Throwable_java_lang_String_Object_: - -.. _error_Throwable__java_lang_String__Object_: - -.. _error_Throwable_java_lang_String_Object____: - -.. _error_Throwable__java_lang_String__Object____: - -.. _error_Throwable_String_java_lang_Object_: - -.. _error_Throwable__String__java_lang_Object_: - -.. _error_Throwable_String_Object_: - -.. _error_Throwable__String__Object_: - -.. _error_Throwable_String_Object____: - -.. _error_Throwable__String__Object____: - -.. _RealmLog_error_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_error_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_error_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_error_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_error_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_error_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_error_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_error_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_error_java_lang_Throwable_String_Object_: - -.. _RealmLog_error_java_lang_Throwable__String__Object_: - -.. _RealmLog_error_java_lang_Throwable_String_Object____: - -.. _RealmLog_error_java_lang_Throwable__String__Object____: - -.. _RealmLog_error_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_error_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_error_Throwable_java_lang_String_Object_: - -.. _RealmLog_error_Throwable__java_lang_String__Object_: - -.. _RealmLog_error_Throwable_java_lang_String_Object____: - -.. _RealmLog_error_Throwable__java_lang_String__Object____: - -.. _RealmLog_error_Throwable_String_java_lang_Object_: - -.. _RealmLog_error_Throwable__String__java_lang_Object_: - -.. _RealmLog_error_Throwable_String_Object_: - -.. _RealmLog_error_Throwable__String__Object_: - -.. _RealmLog_error_Throwable_String_Object____: - -.. _RealmLog_error_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`error ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs an :ref:`LogLevel.ERROR ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_error_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_error_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_error_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_error_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_error_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_error_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_error_String_Object_: - -.. _io_realm_log_RealmLog_error_String__Object_: - -.. _io_realm_log_RealmLog_error_String_Object____: - -.. _io_realm_log_RealmLog_error_String__Object____: - -.. _error_java_lang_String_java_lang_Object_: - -.. _error_java_lang_String__java_lang_Object_: - -.. _error_java_lang_String_Object_: - -.. _error_java_lang_String__Object_: - -.. _error_java_lang_String_Object____: - -.. _error_java_lang_String__Object____: - -.. _error_String_java_lang_Object_: - -.. _error_String__java_lang_Object_: - -.. _error_String_Object_: - -.. _error_String__Object_: - -.. _error_String_Object____: - -.. _error_String__Object____: - -.. _RealmLog_error_java_lang_String_java_lang_Object_: - -.. _RealmLog_error_java_lang_String__java_lang_Object_: - -.. _RealmLog_error_java_lang_String_Object_: - -.. _RealmLog_error_java_lang_String__Object_: - -.. _RealmLog_error_java_lang_String_Object____: - -.. _RealmLog_error_java_lang_String__Object____: - -.. _RealmLog_error_String_java_lang_Object_: - -.. _RealmLog_error_String__java_lang_Object_: - -.. _RealmLog_error_String_Object_: - -.. _RealmLog_error_String__Object_: - -.. _RealmLog_error_String_Object____: - -.. _RealmLog_error_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`error ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs an :ref:`LogLevel.ERROR ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_error_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_error_Throwable_: - -.. _error_java_lang_Throwable_: - -.. _error_Throwable_: - -.. _RealmLog_error_java_lang_Throwable_: - -.. _RealmLog_error_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`error ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs an :ref:`LogLevel.ERROR ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - -.. _fatal: - -.. _fatal__: - -.. _RealmLog_fatal: - -.. _RealmLog_fatal__: - -.. _io_realm_log_RealmLog_fatal: - -.. _io_realm_log_RealmLog_fatal__: - - - -fatal ------ - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_fatal_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_fatal_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_fatal_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_fatal_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_fatal_Throwable__String__Object____: - -.. _fatal_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _fatal_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _fatal_java_lang_Throwable_java_lang_String_Object_: - -.. _fatal_java_lang_Throwable__java_lang_String__Object_: - -.. _fatal_java_lang_Throwable_java_lang_String_Object____: - -.. _fatal_java_lang_Throwable__java_lang_String__Object____: - -.. _fatal_java_lang_Throwable_String_java_lang_Object_: - -.. _fatal_java_lang_Throwable__String__java_lang_Object_: - -.. _fatal_java_lang_Throwable_String_Object_: - -.. _fatal_java_lang_Throwable__String__Object_: - -.. _fatal_java_lang_Throwable_String_Object____: - -.. _fatal_java_lang_Throwable__String__Object____: - -.. _fatal_Throwable_java_lang_String_java_lang_Object_: - -.. _fatal_Throwable__java_lang_String__java_lang_Object_: - -.. _fatal_Throwable_java_lang_String_Object_: - -.. _fatal_Throwable__java_lang_String__Object_: - -.. _fatal_Throwable_java_lang_String_Object____: - -.. _fatal_Throwable__java_lang_String__Object____: - -.. _fatal_Throwable_String_java_lang_Object_: - -.. _fatal_Throwable__String__java_lang_Object_: - -.. _fatal_Throwable_String_Object_: - -.. _fatal_Throwable__String__Object_: - -.. _fatal_Throwable_String_Object____: - -.. _fatal_Throwable__String__Object____: - -.. _RealmLog_fatal_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_fatal_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_fatal_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_fatal_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_fatal_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_fatal_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_fatal_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_fatal_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_fatal_java_lang_Throwable_String_Object_: - -.. _RealmLog_fatal_java_lang_Throwable__String__Object_: - -.. _RealmLog_fatal_java_lang_Throwable_String_Object____: - -.. _RealmLog_fatal_java_lang_Throwable__String__Object____: - -.. _RealmLog_fatal_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_fatal_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_fatal_Throwable_java_lang_String_Object_: - -.. _RealmLog_fatal_Throwable__java_lang_String__Object_: - -.. _RealmLog_fatal_Throwable_java_lang_String_Object____: - -.. _RealmLog_fatal_Throwable__java_lang_String__Object____: - -.. _RealmLog_fatal_Throwable_String_java_lang_Object_: - -.. _RealmLog_fatal_Throwable__String__java_lang_Object_: - -.. _RealmLog_fatal_Throwable_String_Object_: - -.. _RealmLog_fatal_Throwable__String__Object_: - -.. _RealmLog_fatal_Throwable_String_Object____: - -.. _RealmLog_fatal_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`fatal ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.FATAL ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_fatal_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_fatal_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_fatal_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_fatal_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_fatal_String_Object_: - -.. _io_realm_log_RealmLog_fatal_String__Object_: - -.. _io_realm_log_RealmLog_fatal_String_Object____: - -.. _io_realm_log_RealmLog_fatal_String__Object____: - -.. _fatal_java_lang_String_java_lang_Object_: - -.. _fatal_java_lang_String__java_lang_Object_: - -.. _fatal_java_lang_String_Object_: - -.. _fatal_java_lang_String__Object_: - -.. _fatal_java_lang_String_Object____: - -.. _fatal_java_lang_String__Object____: - -.. _fatal_String_java_lang_Object_: - -.. _fatal_String__java_lang_Object_: - -.. _fatal_String_Object_: - -.. _fatal_String__Object_: - -.. _fatal_String_Object____: - -.. _fatal_String__Object____: - -.. _RealmLog_fatal_java_lang_String_java_lang_Object_: - -.. _RealmLog_fatal_java_lang_String__java_lang_Object_: - -.. _RealmLog_fatal_java_lang_String_Object_: - -.. _RealmLog_fatal_java_lang_String__Object_: - -.. _RealmLog_fatal_java_lang_String_Object____: - -.. _RealmLog_fatal_java_lang_String__Object____: - -.. _RealmLog_fatal_String_java_lang_Object_: - -.. _RealmLog_fatal_String__java_lang_Object_: - -.. _RealmLog_fatal_String_Object_: - -.. _RealmLog_fatal_String__Object_: - -.. _RealmLog_fatal_String_Object____: - -.. _RealmLog_fatal_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`fatal ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs an :ref:`LogLevel.FATAL ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_fatal_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_fatal_Throwable_: - -.. _fatal_java_lang_Throwable_: - -.. _fatal_Throwable_: - -.. _RealmLog_fatal_java_lang_Throwable_: - -.. _RealmLog_fatal_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`fatal ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs a :ref:`LogLevel.FATAL ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - -.. _getLevel: - -.. _getLevel__: - -.. _RealmLog_getLevel: - -.. _RealmLog_getLevel__: - -.. _io_realm_log_RealmLog_getLevel: - -.. _io_realm_log_RealmLog_getLevel__: - - - -getLevel --------- - -.. list-table:: - :header-rows: 1 - - * - | public static **int** :ref:`getLevel ` () - | - - - - - * - Get the current :ref:`LogLevel ` . - - - - - - - - - **Returns** - - the current :ref:`LogLevel ` . - - - - - - - - - - - - - -.. _info: - -.. _info__: - -.. _RealmLog_info: - -.. _RealmLog_info__: - -.. _io_realm_log_RealmLog_info: - -.. _io_realm_log_RealmLog_info__: - - - -info ----- - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_info_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_info_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_info_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_info_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_info_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_info_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_info_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_info_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_info_Throwable__String__Object____: - -.. _info_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _info_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _info_java_lang_Throwable_java_lang_String_Object_: - -.. _info_java_lang_Throwable__java_lang_String__Object_: - -.. _info_java_lang_Throwable_java_lang_String_Object____: - -.. _info_java_lang_Throwable__java_lang_String__Object____: - -.. _info_java_lang_Throwable_String_java_lang_Object_: - -.. _info_java_lang_Throwable__String__java_lang_Object_: - -.. _info_java_lang_Throwable_String_Object_: - -.. _info_java_lang_Throwable__String__Object_: - -.. _info_java_lang_Throwable_String_Object____: - -.. _info_java_lang_Throwable__String__Object____: - -.. _info_Throwable_java_lang_String_java_lang_Object_: - -.. _info_Throwable__java_lang_String__java_lang_Object_: - -.. _info_Throwable_java_lang_String_Object_: - -.. _info_Throwable__java_lang_String__Object_: - -.. _info_Throwable_java_lang_String_Object____: - -.. _info_Throwable__java_lang_String__Object____: - -.. _info_Throwable_String_java_lang_Object_: - -.. _info_Throwable__String__java_lang_Object_: - -.. _info_Throwable_String_Object_: - -.. _info_Throwable__String__Object_: - -.. _info_Throwable_String_Object____: - -.. _info_Throwable__String__Object____: - -.. _RealmLog_info_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_info_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_info_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_info_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_info_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_info_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_info_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_info_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_info_java_lang_Throwable_String_Object_: - -.. _RealmLog_info_java_lang_Throwable__String__Object_: - -.. _RealmLog_info_java_lang_Throwable_String_Object____: - -.. _RealmLog_info_java_lang_Throwable__String__Object____: - -.. _RealmLog_info_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_info_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_info_Throwable_java_lang_String_Object_: - -.. _RealmLog_info_Throwable__java_lang_String__Object_: - -.. _RealmLog_info_Throwable_java_lang_String_Object____: - -.. _RealmLog_info_Throwable__java_lang_String__Object____: - -.. _RealmLog_info_Throwable_String_java_lang_Object_: - -.. _RealmLog_info_Throwable__String__java_lang_Object_: - -.. _RealmLog_info_Throwable_String_Object_: - -.. _RealmLog_info_Throwable__String__Object_: - -.. _RealmLog_info_Throwable_String_Object____: - -.. _RealmLog_info_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`info ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs an :ref:`LogLevel.INFO ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_info_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_info_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_info_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_info_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_info_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_info_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_info_String_Object_: - -.. _io_realm_log_RealmLog_info_String__Object_: - -.. _io_realm_log_RealmLog_info_String_Object____: - -.. _io_realm_log_RealmLog_info_String__Object____: - -.. _info_java_lang_String_java_lang_Object_: - -.. _info_java_lang_String__java_lang_Object_: - -.. _info_java_lang_String_Object_: - -.. _info_java_lang_String__Object_: - -.. _info_java_lang_String_Object____: - -.. _info_java_lang_String__Object____: - -.. _info_String_java_lang_Object_: - -.. _info_String__java_lang_Object_: - -.. _info_String_Object_: - -.. _info_String__Object_: - -.. _info_String_Object____: - -.. _info_String__Object____: - -.. _RealmLog_info_java_lang_String_java_lang_Object_: - -.. _RealmLog_info_java_lang_String__java_lang_Object_: - -.. _RealmLog_info_java_lang_String_Object_: - -.. _RealmLog_info_java_lang_String__Object_: - -.. _RealmLog_info_java_lang_String_Object____: - -.. _RealmLog_info_java_lang_String__Object____: - -.. _RealmLog_info_String_java_lang_Object_: - -.. _RealmLog_info_String__java_lang_Object_: - -.. _RealmLog_info_String_Object_: - -.. _RealmLog_info_String__Object_: - -.. _RealmLog_info_String_Object____: - -.. _RealmLog_info_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`info ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs an :ref:`LogLevel.INFO ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_info_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_info_Throwable_: - -.. _info_java_lang_Throwable_: - -.. _info_Throwable_: - -.. _RealmLog_info_java_lang_Throwable_: - -.. _RealmLog_info_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`info ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs an :ref:`LogLevel.INFO ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - -.. _registerDefaultLogger: - -.. _registerDefaultLogger__: - -.. _RealmLog_registerDefaultLogger: - -.. _RealmLog_registerDefaultLogger__: - -.. _io_realm_log_RealmLog_registerDefaultLogger: - -.. _io_realm_log_RealmLog_registerDefaultLogger__: - - - -registerDefaultLogger ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`registerDefaultLogger ` () - | - - - - - * - Adds default native logger if it has been removed before. If the default logger has been registered already, it won't be added again. The default logger on Android will log to logcat. - - - - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _RealmLog_remove: - -.. _RealmLog_remove__: - -.. _io_realm_log_RealmLog_remove: - -.. _io_realm_log_RealmLog_remove__: - - - -remove ------- - -.. _io_realm_log_RealmLog_remove_io_realm_log_RealmLogger_: - -.. _io_realm_log_RealmLog_remove_RealmLogger_: - -.. _remove_io_realm_log_RealmLogger_: - -.. _remove_RealmLogger_: - -.. _RealmLog_remove_io_realm_log_RealmLogger_: - -.. _RealmLog_remove_RealmLogger_: - -.. list-table:: - :header-rows: 1 - - * - | public static **boolean** :ref:`remove ` ( - | :ref:`RealmLogger ` logger - | ) - - - - - * - Removes the given logger if it is currently added. - - - - - - - **Returns** - - ``true`` if the logger was removed, ``false`` otherwise. - - - - - - - - - - - - - -.. _setLevel: - -.. _setLevel__: - -.. _RealmLog_setLevel: - -.. _RealmLog_setLevel__: - -.. _io_realm_log_RealmLog_setLevel: - -.. _io_realm_log_RealmLog_setLevel__: - - - -setLevel --------- - -.. _io_realm_log_RealmLog_setLevel_int_: - -.. _setLevel_int_: - -.. _RealmLog_setLevel_int_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`setLevel ` ( - | **int** level - | ) - - - - - * - Sets the current :ref:`LogLevel ` . Setting this will affect all registered loggers. - - - - - - - **Parameters** - - - ``level`` - see :ref:`LogLevel ` . - - - - - - - - - - - - - - - - - - -.. _trace: - -.. _trace__: - -.. _RealmLog_trace: - -.. _RealmLog_trace__: - -.. _io_realm_log_RealmLog_trace: - -.. _io_realm_log_RealmLog_trace__: - - - -trace ------ - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_trace_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_trace_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_trace_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_trace_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_trace_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_trace_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_trace_Throwable__String__Object____: - -.. _trace_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _trace_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _trace_java_lang_Throwable_java_lang_String_Object_: - -.. _trace_java_lang_Throwable__java_lang_String__Object_: - -.. _trace_java_lang_Throwable_java_lang_String_Object____: - -.. _trace_java_lang_Throwable__java_lang_String__Object____: - -.. _trace_java_lang_Throwable_String_java_lang_Object_: - -.. _trace_java_lang_Throwable__String__java_lang_Object_: - -.. _trace_java_lang_Throwable_String_Object_: - -.. _trace_java_lang_Throwable__String__Object_: - -.. _trace_java_lang_Throwable_String_Object____: - -.. _trace_java_lang_Throwable__String__Object____: - -.. _trace_Throwable_java_lang_String_java_lang_Object_: - -.. _trace_Throwable__java_lang_String__java_lang_Object_: - -.. _trace_Throwable_java_lang_String_Object_: - -.. _trace_Throwable__java_lang_String__Object_: - -.. _trace_Throwable_java_lang_String_Object____: - -.. _trace_Throwable__java_lang_String__Object____: - -.. _trace_Throwable_String_java_lang_Object_: - -.. _trace_Throwable__String__java_lang_Object_: - -.. _trace_Throwable_String_Object_: - -.. _trace_Throwable__String__Object_: - -.. _trace_Throwable_String_Object____: - -.. _trace_Throwable__String__Object____: - -.. _RealmLog_trace_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_trace_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_trace_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_trace_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_trace_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_trace_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_trace_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_trace_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_trace_java_lang_Throwable_String_Object_: - -.. _RealmLog_trace_java_lang_Throwable__String__Object_: - -.. _RealmLog_trace_java_lang_Throwable_String_Object____: - -.. _RealmLog_trace_java_lang_Throwable__String__Object____: - -.. _RealmLog_trace_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_trace_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_trace_Throwable_java_lang_String_Object_: - -.. _RealmLog_trace_Throwable__java_lang_String__Object_: - -.. _RealmLog_trace_Throwable_java_lang_String_Object____: - -.. _RealmLog_trace_Throwable__java_lang_String__Object____: - -.. _RealmLog_trace_Throwable_String_java_lang_Object_: - -.. _RealmLog_trace_Throwable__String__java_lang_Object_: - -.. _RealmLog_trace_Throwable_String_Object_: - -.. _RealmLog_trace_Throwable__String__Object_: - -.. _RealmLog_trace_Throwable_String_Object____: - -.. _RealmLog_trace_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`trace ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.TRACE ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_trace_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_trace_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_trace_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_trace_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_trace_String_Object_: - -.. _io_realm_log_RealmLog_trace_String__Object_: - -.. _io_realm_log_RealmLog_trace_String_Object____: - -.. _io_realm_log_RealmLog_trace_String__Object____: - -.. _trace_java_lang_String_java_lang_Object_: - -.. _trace_java_lang_String__java_lang_Object_: - -.. _trace_java_lang_String_Object_: - -.. _trace_java_lang_String__Object_: - -.. _trace_java_lang_String_Object____: - -.. _trace_java_lang_String__Object____: - -.. _trace_String_java_lang_Object_: - -.. _trace_String__java_lang_Object_: - -.. _trace_String_Object_: - -.. _trace_String__Object_: - -.. _trace_String_Object____: - -.. _trace_String__Object____: - -.. _RealmLog_trace_java_lang_String_java_lang_Object_: - -.. _RealmLog_trace_java_lang_String__java_lang_Object_: - -.. _RealmLog_trace_java_lang_String_Object_: - -.. _RealmLog_trace_java_lang_String__Object_: - -.. _RealmLog_trace_java_lang_String_Object____: - -.. _RealmLog_trace_java_lang_String__Object____: - -.. _RealmLog_trace_String_java_lang_Object_: - -.. _RealmLog_trace_String__java_lang_Object_: - -.. _RealmLog_trace_String_Object_: - -.. _RealmLog_trace_String__Object_: - -.. _RealmLog_trace_String_Object____: - -.. _RealmLog_trace_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`trace ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.TRACE ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_trace_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_trace_Throwable_: - -.. _trace_java_lang_Throwable_: - -.. _trace_Throwable_: - -.. _RealmLog_trace_java_lang_Throwable_: - -.. _RealmLog_trace_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`trace ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs a :ref:`LogLevel.TRACE ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - -.. _warn: - -.. _warn__: - -.. _RealmLog_warn: - -.. _RealmLog_warn__: - -.. _io_realm_log_RealmLog_warn: - -.. _io_realm_log_RealmLog_warn__: - - - -warn ----- - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable__String__Object____: - -.. _io_realm_log_RealmLog_warn_Throwable_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable__java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable__java_lang_String__Object_: - -.. _io_realm_log_RealmLog_warn_Throwable_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_warn_Throwable__java_lang_String__Object____: - -.. _io_realm_log_RealmLog_warn_Throwable_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable__String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable_String_Object_: - -.. _io_realm_log_RealmLog_warn_Throwable__String__Object_: - -.. _io_realm_log_RealmLog_warn_Throwable_String_Object____: - -.. _io_realm_log_RealmLog_warn_Throwable__String__Object____: - -.. _warn_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _warn_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _warn_java_lang_Throwable_java_lang_String_Object_: - -.. _warn_java_lang_Throwable__java_lang_String__Object_: - -.. _warn_java_lang_Throwable_java_lang_String_Object____: - -.. _warn_java_lang_Throwable__java_lang_String__Object____: - -.. _warn_java_lang_Throwable_String_java_lang_Object_: - -.. _warn_java_lang_Throwable__String__java_lang_Object_: - -.. _warn_java_lang_Throwable_String_Object_: - -.. _warn_java_lang_Throwable__String__Object_: - -.. _warn_java_lang_Throwable_String_Object____: - -.. _warn_java_lang_Throwable__String__Object____: - -.. _warn_Throwable_java_lang_String_java_lang_Object_: - -.. _warn_Throwable__java_lang_String__java_lang_Object_: - -.. _warn_Throwable_java_lang_String_Object_: - -.. _warn_Throwable__java_lang_String__Object_: - -.. _warn_Throwable_java_lang_String_Object____: - -.. _warn_Throwable__java_lang_String__Object____: - -.. _warn_Throwable_String_java_lang_Object_: - -.. _warn_Throwable__String__java_lang_Object_: - -.. _warn_Throwable_String_Object_: - -.. _warn_Throwable__String__Object_: - -.. _warn_Throwable_String_Object____: - -.. _warn_Throwable__String__Object____: - -.. _RealmLog_warn_java_lang_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_warn_java_lang_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_warn_java_lang_Throwable_java_lang_String_Object_: - -.. _RealmLog_warn_java_lang_Throwable__java_lang_String__Object_: - -.. _RealmLog_warn_java_lang_Throwable_java_lang_String_Object____: - -.. _RealmLog_warn_java_lang_Throwable__java_lang_String__Object____: - -.. _RealmLog_warn_java_lang_Throwable_String_java_lang_Object_: - -.. _RealmLog_warn_java_lang_Throwable__String__java_lang_Object_: - -.. _RealmLog_warn_java_lang_Throwable_String_Object_: - -.. _RealmLog_warn_java_lang_Throwable__String__Object_: - -.. _RealmLog_warn_java_lang_Throwable_String_Object____: - -.. _RealmLog_warn_java_lang_Throwable__String__Object____: - -.. _RealmLog_warn_Throwable_java_lang_String_java_lang_Object_: - -.. _RealmLog_warn_Throwable__java_lang_String__java_lang_Object_: - -.. _RealmLog_warn_Throwable_java_lang_String_Object_: - -.. _RealmLog_warn_Throwable__java_lang_String__Object_: - -.. _RealmLog_warn_Throwable_java_lang_String_Object____: - -.. _RealmLog_warn_Throwable__java_lang_String__Object____: - -.. _RealmLog_warn_Throwable_String_java_lang_Object_: - -.. _RealmLog_warn_Throwable__String__java_lang_Object_: - -.. _RealmLog_warn_Throwable_String_Object_: - -.. _RealmLog_warn_Throwable__String__Object_: - -.. _RealmLog_warn_Throwable_String_Object____: - -.. _RealmLog_warn_Throwable__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`warn ` ( - | `Throwable `__ throwable, - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.WARN ` event. - - - - - - - **Parameters** - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional message. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_warn_java_lang_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_String_Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_String__Object_: - -.. _io_realm_log_RealmLog_warn_java_lang_String_Object____: - -.. _io_realm_log_RealmLog_warn_java_lang_String__Object____: - -.. _io_realm_log_RealmLog_warn_String_java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_String__java_lang_Object_: - -.. _io_realm_log_RealmLog_warn_String_Object_: - -.. _io_realm_log_RealmLog_warn_String__Object_: - -.. _io_realm_log_RealmLog_warn_String_Object____: - -.. _io_realm_log_RealmLog_warn_String__Object____: - -.. _warn_java_lang_String_java_lang_Object_: - -.. _warn_java_lang_String__java_lang_Object_: - -.. _warn_java_lang_String_Object_: - -.. _warn_java_lang_String__Object_: - -.. _warn_java_lang_String_Object____: - -.. _warn_java_lang_String__Object____: - -.. _warn_String_java_lang_Object_: - -.. _warn_String__java_lang_Object_: - -.. _warn_String_Object_: - -.. _warn_String__Object_: - -.. _warn_String_Object____: - -.. _warn_String__Object____: - -.. _RealmLog_warn_java_lang_String_java_lang_Object_: - -.. _RealmLog_warn_java_lang_String__java_lang_Object_: - -.. _RealmLog_warn_java_lang_String_Object_: - -.. _RealmLog_warn_java_lang_String__Object_: - -.. _RealmLog_warn_java_lang_String_Object____: - -.. _RealmLog_warn_java_lang_String__Object____: - -.. _RealmLog_warn_String_java_lang_Object_: - -.. _RealmLog_warn_String__java_lang_Object_: - -.. _RealmLog_warn_String_Object_: - -.. _RealmLog_warn_String__Object_: - -.. _RealmLog_warn_String_Object____: - -.. _RealmLog_warn_String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`warn ` ( - | `String `__ message, - | `java.lang.Object[] `__ args - | ) - - - - - * - Logs a :ref:`LogLevel.WARN ` event. - - - - - - - **Parameters** - - - ``message`` - message to log. - - - - - ``args`` - optional args used to format the message using `String.format(String, Object...) `__ . - - - - - - - - - - - - - - - - -.. _io_realm_log_RealmLog_warn_java_lang_Throwable_: - -.. _io_realm_log_RealmLog_warn_Throwable_: - -.. _warn_java_lang_Throwable_: - -.. _warn_Throwable_: - -.. _RealmLog_warn_java_lang_Throwable_: - -.. _RealmLog_warn_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`warn ` ( - | `Throwable `__ throwable - | ) - - - - - * - Logs a :ref:`LogLevel.WARN ` exception. - - - - - - - **Parameters** - - - ``throwable`` - exception to log. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/log/RealmLogger.txt b/source/sdk/java/api/io/realm/log/RealmLogger.txt deleted file mode 100644 index 3c78aae4e5..0000000000 --- a/source/sdk/java/api/io/realm/log/RealmLogger.txt +++ /dev/null @@ -1,221 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmLogger -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_log_RealmLogger: - - - -io.realm.log -============ - -Interface for custom loggers that can be registered at :ref:`RealmLog.add(RealmLogger) ` . The different log levels are described in :ref:`LogLevel ` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`log ` ( - | **int** level, - | `String `__ tag, - | `Throwable `__ throwable, - | `String `__ message - | ) - - - Handles a log event. - - - - - - - -Method Detail -============= - -.. _log: - -.. _log__: - -.. _RealmLogger_log: - -.. _RealmLogger_log__: - -.. _io_realm_log_RealmLogger_log: - -.. _io_realm_log_RealmLogger_log__: - - - -log ----- - -.. _io_realm_log_RealmLogger_log_int_java_lang_String_java_lang_Throwable_java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int__java_lang_String__java_lang_Throwable__java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int_java_lang_String_java_lang_Throwable_String_: - -.. _io_realm_log_RealmLogger_log_int__java_lang_String__java_lang_Throwable__String_: - -.. _io_realm_log_RealmLogger_log_int_java_lang_String_Throwable_java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int__java_lang_String__Throwable__java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int_java_lang_String_Throwable_String_: - -.. _io_realm_log_RealmLogger_log_int__java_lang_String__Throwable__String_: - -.. _io_realm_log_RealmLogger_log_int_String_java_lang_Throwable_java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int__String__java_lang_Throwable__java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int_String_java_lang_Throwable_String_: - -.. _io_realm_log_RealmLogger_log_int__String__java_lang_Throwable__String_: - -.. _io_realm_log_RealmLogger_log_int_String_Throwable_java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int__String__Throwable__java_lang_String_: - -.. _io_realm_log_RealmLogger_log_int_String_Throwable_String_: - -.. _io_realm_log_RealmLogger_log_int__String__Throwable__String_: - -.. _log_int_java_lang_String_java_lang_Throwable_java_lang_String_: - -.. _log_int__java_lang_String__java_lang_Throwable__java_lang_String_: - -.. _log_int_java_lang_String_java_lang_Throwable_String_: - -.. _log_int__java_lang_String__java_lang_Throwable__String_: - -.. _log_int_java_lang_String_Throwable_java_lang_String_: - -.. _log_int__java_lang_String__Throwable__java_lang_String_: - -.. _log_int_java_lang_String_Throwable_String_: - -.. _log_int__java_lang_String__Throwable__String_: - -.. _log_int_String_java_lang_Throwable_java_lang_String_: - -.. _log_int__String__java_lang_Throwable__java_lang_String_: - -.. _log_int_String_java_lang_Throwable_String_: - -.. _log_int__String__java_lang_Throwable__String_: - -.. _log_int_String_Throwable_java_lang_String_: - -.. _log_int__String__Throwable__java_lang_String_: - -.. _log_int_String_Throwable_String_: - -.. _log_int__String__Throwable__String_: - -.. _RealmLogger_log_int_java_lang_String_java_lang_Throwable_java_lang_String_: - -.. _RealmLogger_log_int__java_lang_String__java_lang_Throwable__java_lang_String_: - -.. _RealmLogger_log_int_java_lang_String_java_lang_Throwable_String_: - -.. _RealmLogger_log_int__java_lang_String__java_lang_Throwable__String_: - -.. _RealmLogger_log_int_java_lang_String_Throwable_java_lang_String_: - -.. _RealmLogger_log_int__java_lang_String__Throwable__java_lang_String_: - -.. _RealmLogger_log_int_java_lang_String_Throwable_String_: - -.. _RealmLogger_log_int__java_lang_String__Throwable__String_: - -.. _RealmLogger_log_int_String_java_lang_Throwable_java_lang_String_: - -.. _RealmLogger_log_int__String__java_lang_Throwable__java_lang_String_: - -.. _RealmLogger_log_int_String_java_lang_Throwable_String_: - -.. _RealmLogger_log_int__String__java_lang_Throwable__String_: - -.. _RealmLogger_log_int_String_Throwable_java_lang_String_: - -.. _RealmLogger_log_int__String__Throwable__java_lang_String_: - -.. _RealmLogger_log_int_String_Throwable_String_: - -.. _RealmLogger_log_int__String__Throwable__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`log ` ( - | **int** level, - | `String `__ tag, - | `Throwable `__ throwable, - | `String `__ message - | ) - - - - - * - Handles a log event. - - - - - **Parameters** - - - ``level`` - for this log event. It can only be a value between :ref:`LogLevel.TRACE ` and :ref:`LogLevel.FATAL ` - - - - - - - ``tag`` - for this log event. - - - - - ``throwable`` - optional exception to log. - - - - - ``message`` - optional additional message. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb.txt b/source/sdk/java/api/io/realm/mongodb.txt deleted file mode 100644 index b73258da1a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb.txt +++ /dev/null @@ -1,39 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb -^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - App - App.Callback - App.Result - AppConfiguration - AppConfiguration.Builder - AuthenticationListener - Credentials - Credentials.Provider - ErrorCode - ErrorCode.Category - ErrorCode.Type - RealmEventStreamAsyncTask - RealmEventStreamTask - RealmResultTask - User - User.State - UserIdentity - UserProfile - AppException diff --git a/source/sdk/java/api/io/realm/mongodb/App.txt b/source/sdk/java/api/io/realm/mongodb/App.txt deleted file mode 100644 index cc76c27cda..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/App.txt +++ /dev/null @@ -1,1626 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class App -^^^^^^^^^ - -.. _io_realm_mongodb_App: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.App - - -An *App* is the main client-side entry point for interacting with a *MongoDB Realm App*.The *App* can be used to: - - - -- Register uses and perform various user-related operations through authentication providers (:ref:`io.realm.mongodb.auth.ApiKeyAuth ` , **EmailPasswordAuthImpl**) - - - - -- Synchronize data between the local device and a remote Realm App with Synchronized Realms - - -- Invoke Realm App functions with :ref:`Functions ` - - - - -- Access remote data from MongoDB databases with a :ref:`io.realm.mongodb.mongo.MongoClient ` - - - - - - -To create an app that is linked with a remote *Realm App* initialize Realm and configure the *App* as shown below: - - - -.. code-block:: java - - class MyApplication extends Application { - - App APP; // The App instance should be a global singleton - - @Override - public void onCreate() { - super.onCreate(); - - Realm.init(this); - - AppConfiguration appConfiguration = new AppConfiguration.Builder(BuildConfig.MONGODB_REALM_APP_ID) - .appName(BuildConfig.VERSION_NAME) - .appVersion(Integer.toString(BuildConfig.VERSION_CODE)) - .build(); - - APP = new App(appConfiguration); - } - - } - - -After configuring the *App* you can start managing users, configure Synchronized -Realms, call remote Realm Functions and access remote data through Mongo Collections. -The examples below show the synchronized APIs which cannot be used from the main -thread. For the equivalent asynchronous counterparts, see -https://github.com/realm/realm-java/tree/main/examples/mongoDbRealmExample . - -To register a new user and/or login with an existing user do as shown below: - - - -.. code-block:: java - - // Register new user - APP.getEmailPassword().registerUser(username, password); - - // Login with existing user - User user = APP.login(Credentials.emailPassword(username, password)) - - -With an authorized user you can synchronize data between the local device and the remote Realm App by opening a Realm with a :ref:`io.realm.mongodb.sync.SyncConfiguration ` as indicated below: - - - - - -.. code-block:: java - - SyncConfiguration syncConfiguration = new SyncConfiguration.Builder(user, "") - .build(); - - Realm instance = Realm.getInstance(syncConfiguration); - SyncSession session = APP.getSync().getSession(syncConfiguration); - - instance.executeTransaction(realm -> { - realm.insert(...); - }); - session.uploadAllLocalChanges(); - instance.close(); - - -You can call remote Realm functions as shown below: - - - -.. code-block:: java - - Functions functions = user.getFunctions(); - Integer sum = functions.callFunction("sum", Arrays.asList(1, 2, 3, 4), Integer.class); - - -And access collections from the remote Realm App as shown here: - - - -.. code-block:: java - - MongoClient client = user.getMongoClient(SERVICE_NAME) - MongoDatabase database = client.getDatabase(DATABASE_NAME) - MongoCollection collection = database.getCollection(COLLECTION_NAME); - Long count = collection.count().get() - - - - - -.. seealso:: - - - - - :ref:`AppConfiguration.Builder ` - - - - - :ref:`EmailPasswordAuth ` - - - - - :ref:`io.realm.mongodb.sync.SyncConfiguration ` - - - - - :ref:`User.getFunctions() ` - - - - - :ref:`User.getMongoClient(String) ` - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`App ` ( - | `String `__ appId - | ) - - - - - - - - * - | :ref:`App ` ( - | :ref:`AppConfiguration ` config - | ) - - - Constructor for creating an *App* according to the given *AppConfiguration*. - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`App.Result ` - - - * - ``public static interface`` - - :ref:`App.Callback ` - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static `ThreadPoolExecutor `__ - - - - :ref:`NETWORK_POOL_EXECUTOR ` - - Thread pool used when doing network requests against MongoDB Realm.This pool is only exposed for testing purposes and replacing it while the queue is not empty will result in undefined behaviour. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`addAuthenticationListener ` ( - | :ref:`AuthenticationListener ` listener - | ) - - - Sets a global authentication listener that will be notified about User events like login and logout. - - - - - * - public `Map `__ - - | :ref:`allUsers ` () - | - - - Returns all known users that are either :ref:`User.State.LOGGED_IN ` or :ref:`User.State.LOGGED_OUT ` . - - - - - - - * - public :ref:`User ` - - | :ref:`currentUser ` () - | - - - Returns the current user that is logged in and still valid. - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - Two Apps are considered equal and will share their underlying state if they both refer to the same :ref:`AppConfiguration.getAppId() ` . - - - - - - - * - public :ref:`AppConfiguration ` - - | :ref:`getConfiguration ` () - | - - - Returns the configuration object for this app. - - - - - * - public :ref:`EmailPasswordAuth ` - - | :ref:`getEmailPassword ` () - | - - - Returns a wrapper for interacting with functionality related to users either being created or logged in using the :ref:`Credentials.Provider.EMAIL_PASSWORD ` identity provider. - - - - - - - * - public :ref:`Functions ` - - | :ref:`getFunctions ` ( - | :ref:`User ` user, - | **CodecRegistry** codecRegistry - | ) - - - Returns a *Functions* manager for invoking the Realm App's Realm Functions with a custom codec registry for encoding and decoding arguments and results. - - - - - * - public :ref:`Functions ` - - | :ref:`getFunctions ` ( - | :ref:`User ` user - | ) - - - Returns a *Functions* manager for invoking the Realm App's Realm Functions. - - - - - * - public :ref:`Sync ` - - | :ref:`getSync ` () - | - - - Returns the *Sync* instance managing the ongoing *Realm Sync* sessions synchronizing data between the local and the remote *Realm App* associated with this app. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public :ref:`User ` - - | :ref:`login ` ( - | :ref:`Credentials ` credentials - | ) - - - Logs in as a user with the given credentials associated with an authentication provider. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`loginAsync ` ( - | :ref:`Credentials ` credentials, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Logs in as a user with the given credentials associated with an authentication provider. - - - - - * - public **void** - - | :ref:`removeAuthenticationListener ` ( - | :ref:`AuthenticationListener ` listener - | ) - - - Removes the provided global authentication listener. - - - - - * - public :ref:`User ` - - | :ref:`removeUser ` ( - | :ref:`User ` user - | ) - - - Removes a users credentials from this device. - - - - - * - protected **void** - - | :ref:`setNetworkTransport ` ( - | **OsJavaNetworkTransport** transport - | ) - - - Exposed for testing. - - - - - * - public :ref:`User ` - - | :ref:`switchUser ` ( - | :ref:`User ` user - | ) - - - Switch current user. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_mongodb_App_NETWORK_POOL_EXECUTOR: - - - -``NETWORK_POOL_EXECUTOR`` --------------------------- - -Thread pool used when doing network requests against MongoDB Realm.This pool is only exposed for testing purposes and replacing it while the queue is not empty will result in undefined behaviour. - - - - - - -Constructor Detail -================== - -.. _App: - -.. _App__: - -.. _io_realm_mongodb_App: - -.. _io_realm_mongodb_App__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`App ` ( - | `String `__ appId - | ) - - - - - * - - - - - - - - - - - - -.. _App: - -.. _App__: - -.. _io_realm_mongodb_App: - -.. _io_realm_mongodb_App__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`App ` ( - | :ref:`AppConfiguration ` config - | ) - - - - - * - Constructor for creating an *App* according to the given *AppConfiguration*. - - - - - **Parameters** - - - ``config`` - The configuration to use for this *App* instance. - - - - - - - - - - .. seealso:: - - - - - :ref:`AppConfiguration.Builder ` - - - - - - - - - - - - - - -Method Detail -============= - -.. _addAuthenticationListener: - -.. _addAuthenticationListener__: - -.. _App_addAuthenticationListener: - -.. _App_addAuthenticationListener__: - -.. _io_realm_mongodb_App_addAuthenticationListener: - -.. _io_realm_mongodb_App_addAuthenticationListener__: - - - -addAuthenticationListener -------------------------- - -.. _io_realm_mongodb_App_addAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _io_realm_mongodb_App_addAuthenticationListener_AuthenticationListener_: - -.. _addAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _addAuthenticationListener_AuthenticationListener_: - -.. _App_addAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _App_addAuthenticationListener_AuthenticationListener_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`addAuthenticationListener ` ( - | :ref:`AuthenticationListener ` listener - | ) - - - - - * - Sets a global authentication listener that will be notified about User events like login and logout.Callbacks to authentication listeners will happen on the UI thread. - - - - - - - **Parameters** - - - ``listener`` - listener to register. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``listener`` is ``null`` . - - - - - - - - - - - - - - -.. _allUsers: - -.. _allUsers__: - -.. _App_allUsers: - -.. _App_allUsers__: - -.. _io_realm_mongodb_App_allUsers: - -.. _io_realm_mongodb_App_allUsers__: - - - -allUsers --------- - -.. list-table:: - :header-rows: 1 - - * - | public `Map `__ :ref:`allUsers ` () - | - - - - - * - Returns all known users that are either :ref:`User.State.LOGGED_IN ` or :ref:`User.State.LOGGED_OUT ` . - - Only users that at some point logged into this device will be returned. - - - - - - - - - **Returns** - - a map of user identifiers and users known locally. - - - - - - - - - - - -.. _currentUser: - -.. _currentUser__: - -.. _App_currentUser: - -.. _App_currentUser__: - -.. _io_realm_mongodb_App_currentUser: - -.. _io_realm_mongodb_App_currentUser__: - - - -currentUser ------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`currentUser ` () - | - - - - - * - Returns the current user that is logged in and still valid.A user is invalidated when he/she logs out or the user's refresh token expires or is revoked. - - If two or more users are logged in, it is the last valid user that is returned by this method. - - - - - - - - - **Returns** - - current :ref:`User ` that has logged in and is still valid. ``null`` if no user is logged in or the user has expired. - - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _App_equals: - -.. _App_equals__: - -.. _io_realm_mongodb_App_equals: - -.. _io_realm_mongodb_App_equals__: - - - -equals ------- - -.. _io_realm_mongodb_App_equals_java_lang_Object_: - -.. _io_realm_mongodb_App_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _App_equals_java_lang_Object_: - -.. _App_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - Two Apps are considered equal and will share their underlying state if they both refer to the same :ref:`AppConfiguration.getAppId() ` . - - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getConfiguration: - -.. _getConfiguration__: - -.. _App_getConfiguration: - -.. _App_getConfiguration__: - -.. _io_realm_mongodb_App_getConfiguration: - -.. _io_realm_mongodb_App_getConfiguration__: - - - -getConfiguration ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration ` :ref:`getConfiguration ` () - | - - - - - * - Returns the configuration object for this app. - - - - - - - **Returns** - - the configuration for this app. - - - - - - - - - - - -.. _getEmailPassword: - -.. _getEmailPassword__: - -.. _App_getEmailPassword: - -.. _App_getEmailPassword__: - -.. _io_realm_mongodb_App_getEmailPassword: - -.. _io_realm_mongodb_App_getEmailPassword__: - - - -getEmailPassword ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`EmailPasswordAuth ` :ref:`getEmailPassword ` () - | - - - - - * - Returns a wrapper for interacting with functionality related to users either being created or logged in using the :ref:`Credentials.Provider.EMAIL_PASSWORD ` identity provider. - - - - - - - - - **Returns** - - wrapper for interacting with the :ref:`Credentials.Provider.EMAIL_PASSWORD ` identity provider. - - - - - - - - - - - - - -.. _getFunctions: - -.. _getFunctions__: - -.. _App_getFunctions: - -.. _App_getFunctions__: - -.. _io_realm_mongodb_App_getFunctions: - -.. _io_realm_mongodb_App_getFunctions__: - - - -getFunctions ------------- - -.. _io_realm_mongodb_App_getFunctions_io_realm_mongodb_User_CodecRegistry_: - -.. _io_realm_mongodb_App_getFunctions_io_realm_mongodb_User__CodecRegistry_: - -.. _io_realm_mongodb_App_getFunctions_User_CodecRegistry_: - -.. _io_realm_mongodb_App_getFunctions_User__CodecRegistry_: - -.. _getFunctions_io_realm_mongodb_User_CodecRegistry_: - -.. _getFunctions_io_realm_mongodb_User__CodecRegistry_: - -.. _getFunctions_User_CodecRegistry_: - -.. _getFunctions_User__CodecRegistry_: - -.. _App_getFunctions_io_realm_mongodb_User_CodecRegistry_: - -.. _App_getFunctions_io_realm_mongodb_User__CodecRegistry_: - -.. _App_getFunctions_User_CodecRegistry_: - -.. _App_getFunctions_User__CodecRegistry_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Functions ` :ref:`getFunctions ` ( - | :ref:`User ` user, - | **CodecRegistry** codecRegistry - | ) - - - - - * - Returns a *Functions* manager for invoking the Realm App's Realm Functions with a custom codec registry for encoding and decoding arguments and results. - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Functions ` - - - - - - - - - - -.. _io_realm_mongodb_App_getFunctions_io_realm_mongodb_User_: - -.. _io_realm_mongodb_App_getFunctions_User_: - -.. _getFunctions_io_realm_mongodb_User_: - -.. _getFunctions_User_: - -.. _App_getFunctions_io_realm_mongodb_User_: - -.. _App_getFunctions_User_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Functions ` :ref:`getFunctions ` ( - | :ref:`User ` user - | ) - - - - - * - Returns a *Functions* manager for invoking the Realm App's Realm Functions.This will use the app's default codec registry to encode and decode arguments and results. - - - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Functions ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - - - -.. _getSync: - -.. _getSync__: - -.. _App_getSync: - -.. _App_getSync__: - -.. _io_realm_mongodb_App_getSync: - -.. _io_realm_mongodb_App_getSync__: - - - -getSync -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Sync ` :ref:`getSync ` () - | - - - - - * - Returns the *Sync* instance managing the ongoing *Realm Sync* sessions synchronizing data between the local and the remote *Realm App* associated with this app. - - - - - - - **Returns** - - the *Sync* instance associated with this *App*. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _App_hashCode: - -.. _App_hashCode__: - -.. _io_realm_mongodb_App_hashCode: - -.. _io_realm_mongodb_App_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _login: - -.. _login__: - -.. _App_login: - -.. _App_login__: - -.. _io_realm_mongodb_App_login: - -.. _io_realm_mongodb_App_login__: - - - -login ------ - -.. _io_realm_mongodb_App_login_io_realm_mongodb_Credentials_: - -.. _io_realm_mongodb_App_login_Credentials_: - -.. _login_io_realm_mongodb_Credentials_: - -.. _login_Credentials_: - -.. _App_login_io_realm_mongodb_Credentials_: - -.. _App_login_Credentials_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`login ` ( - | :ref:`Credentials ` credentials - | ) - - - - - * - Logs in as a user with the given credentials associated with an authentication provider.The user who logs in becomes the current user. Other App functionality acts on behalf of the current user. - - If there was already a current user, that user is still logged in and can be found in the list returned by :ref:`allUsers() ` . - - - - It is also possible to switch between which user is considered the current user by using :ref:`switchUser(User) ` . - - - - - - - - - **Parameters** - - - ``credentials`` - the credentials representing the type of login. - - - - - - - - **Returns** - - a :ref:`User ` representing the logged in user. - - - - - - - **Throws** - - - :ref:`AppException ` - if the user could not be logged in. - - - - - - - - - - - - -.. _loginAsync: - -.. _loginAsync__: - -.. _App_loginAsync: - -.. _App_loginAsync__: - -.. _io_realm_mongodb_App_loginAsync: - -.. _io_realm_mongodb_App_loginAsync__: - - - -loginAsync ----------- - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials_Callback_: - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials__Callback_: - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials__Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials_App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials__App_Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials_Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials__Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _loginAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _loginAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _loginAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _loginAsync_Credentials_Callback_: - -.. _loginAsync_Credentials__Callback_: - -.. _loginAsync_Credentials_App_Callback_: - -.. _loginAsync_Credentials__App_Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials_Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials__Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _App_loginAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _App_loginAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _App_loginAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _App_loginAsync_Credentials_Callback_: - -.. _App_loginAsync_Credentials__Callback_: - -.. _App_loginAsync_Credentials_App_Callback_: - -.. _App_loginAsync_Credentials__App_Callback_: - -.. _io_realm_mongodb_App_loginAsync_Credentials__App_Callback_User__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`loginAsync ` ( - | :ref:`Credentials ` credentials, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Logs in as a user with the given credentials associated with an authentication provider.The user who logs in becomes the current user. Other App functionality acts on behalf of the current user. - - If there was already a current user, that user is still logged in and can be found in the list returned by :ref:`allUsers() ` . - - - - It is also possible to switch between which user is considered the current user by using :ref:`switchUser(User) ` . - - - - - - - - - **Parameters** - - - ``credentials`` - the credentials representing the type of login. - - - - - ``callback`` - callback when logging in has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if not called on a looper thread. - - - - - - - - - - - - -.. _removeAuthenticationListener: - -.. _removeAuthenticationListener__: - -.. _App_removeAuthenticationListener: - -.. _App_removeAuthenticationListener__: - -.. _io_realm_mongodb_App_removeAuthenticationListener: - -.. _io_realm_mongodb_App_removeAuthenticationListener__: - - - -removeAuthenticationListener ----------------------------- - -.. _io_realm_mongodb_App_removeAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _io_realm_mongodb_App_removeAuthenticationListener_AuthenticationListener_: - -.. _removeAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _removeAuthenticationListener_AuthenticationListener_: - -.. _App_removeAuthenticationListener_io_realm_mongodb_AuthenticationListener_: - -.. _App_removeAuthenticationListener_AuthenticationListener_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`removeAuthenticationListener ` ( - | :ref:`AuthenticationListener ` listener - | ) - - - - - * - Removes the provided global authentication listener. - - - - - **Parameters** - - - ``listener`` - listener to remove. - - - - - - - - - - - - - - - - -.. _removeUser: - -.. _removeUser__: - -.. _App_removeUser: - -.. _App_removeUser__: - -.. _io_realm_mongodb_App_removeUser: - -.. _io_realm_mongodb_App_removeUser__: - - - -removeUser ----------- - -.. _io_realm_mongodb_App_removeUser_io_realm_mongodb_User_: - -.. _io_realm_mongodb_App_removeUser_User_: - -.. _removeUser_io_realm_mongodb_User_: - -.. _removeUser_User_: - -.. _App_removeUser_io_realm_mongodb_User_: - -.. _App_removeUser_User_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`removeUser ` ( - | :ref:`User ` user - | ) - - - - - * - Removes a users credentials from this device. If the user was currently logged in, they will be logged out as part of the process. This is only a local change and does not affect the user state on the server. - - - - - **Parameters** - - - ``user`` - to remove - - - - - - - - **Returns** - - user that was removed. - - - - - **Throws** - - - :ref:`AppException ` - if called from the UI thread or if the user was logged in, but could not be logged out. - - - - - - - - - - - - -.. _setNetworkTransport: - -.. _setNetworkTransport__: - -.. _App_setNetworkTransport: - -.. _App_setNetworkTransport__: - -.. _io_realm_mongodb_App_setNetworkTransport: - -.. _io_realm_mongodb_App_setNetworkTransport__: - - - -setNetworkTransport -------------------- - -.. _io_realm_mongodb_App_setNetworkTransport_OsJavaNetworkTransport_: - -.. _setNetworkTransport_OsJavaNetworkTransport_: - -.. _App_setNetworkTransport_OsJavaNetworkTransport_: - -.. list-table:: - :header-rows: 1 - - * - | protected **void** :ref:`setNetworkTransport ` ( - | **OsJavaNetworkTransport** transport - | ) - - - - - * - Exposed for testing.Swap the currently configured network transport with the provided one. This should only be done if no network requests are currently running. - - - - - - - - - - - - - - - - - -.. _switchUser: - -.. _switchUser__: - -.. _App_switchUser: - -.. _App_switchUser__: - -.. _io_realm_mongodb_App_switchUser: - -.. _io_realm_mongodb_App_switchUser__: - - - -switchUser ----------- - -.. _io_realm_mongodb_App_switchUser_io_realm_mongodb_User_: - -.. _io_realm_mongodb_App_switchUser_User_: - -.. _switchUser_io_realm_mongodb_User_: - -.. _switchUser_User_: - -.. _App_switchUser_io_realm_mongodb_User_: - -.. _App_switchUser_User_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`switchUser ` ( - | :ref:`User ` user - | ) - - - - - * - Switch current user.The current user is the user returned by :ref:`currentUser() ` . - - - - - - - - - **Parameters** - - - ``user`` - the new current user. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the user is is not :ref:`User.State.LOGGED_IN ` . - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/App/Callback.txt b/source/sdk/java/api/io/realm/mongodb/App/Callback.txt deleted file mode 100644 index 28853fc516..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/App/Callback.txt +++ /dev/null @@ -1,137 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface App.Callback -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_App_Callback: - - - -io.realm.mongodb -================ - - - -**Enclosing class:** - -:ref:`App ` - - - -Callback for async methods available to the :ref:`App ` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onResult ` ( - | :ref:`io.realm.mongodb.App.Result\ ` result - | ) - - - Returns the result of the request when available. - - - - - - - -Method Detail -============= - -.. _onResult: - -.. _onResult__: - -.. _Callback_onResult: - -.. _Callback_onResult__: - -.. _App_Callback_onResult: - -.. _App_Callback_onResult__: - -.. _io_realm_mongodb_App_Callback_onResult: - -.. _io_realm_mongodb_App_Callback_onResult__: - - - -onResult --------- - -.. _io_realm_mongodb_App_Callback_onResult_io_realm_mongodb_App_Result_: - -.. _io_realm_mongodb_App_Callback_onResult_Result_: - -.. _io_realm_mongodb_App_Callback_onResult_App_Result_: - -.. _onResult_io_realm_mongodb_App_Result_: - -.. _onResult_Result_: - -.. _onResult_App_Result_: - -.. _App_Callback_onResult_io_realm_mongodb_App_Result_: - -.. _App_Callback_onResult_Result_: - -.. _App_Callback_onResult_App_Result_: - -.. _io_realm_mongodb_App_Callback_onResult_App_Result_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onResult ` ( - | :ref:`io.realm.mongodb.App.Result\ ` result - | ) - - - - - * - Returns the result of the request when available. - - - - - **Parameters** - - - ``result`` - the request response. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/App/Result.txt b/source/sdk/java/api/io/realm/mongodb/App/Result.txt deleted file mode 100644 index 641f0e2785..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/App/Result.txt +++ /dev/null @@ -1,609 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class App.Result -^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_App_Result: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.App.Result - - - - -**Enclosing class:** - -:ref:`App ` - - - -Result class representing the result of an async request from this app towards MongoDB Realm. - - -.. seealso:: - - - - - :ref:`Callback ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **T** - - | :ref:`get ` () - | - - - Returns the response in case the request was a success. - - - - - * - public :ref:`AppException ` - - | :ref:`getError ` () - | - - - Returns the error in case of a failed request. - - - - - * - public **T** - - | :ref:`getOrDefault ` ( - | **T** defaultValue - | ) - - - Returns the response if the request was a success. - - - - - * - public **T** - - | :ref:`getOrThrow ` () - | - - - If the request was successful the response is returned, otherwise the provided error is thrown. - - - - - * - public **boolean** - - | :ref:`isSuccess ` () - | - - - Returns whether or not request was successful - - - - - * - public static :ref:`App.Result ` - - | :ref:`success ` <**T** >() - | - - - Creates a successful request result with no return value. - - - - - * - public static :ref:`App.Result ` - - | :ref:`withError ` <**T** >( - | :ref:`AppException ` exception - | ) - - - Creates a failed request result. - - - - - * - public static :ref:`App.Result ` - - | :ref:`withResult ` <**T** >( - | **T** result - | ) - - - Creates a successful request result with a return value. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _get: - -.. _get__: - -.. _Result_get: - -.. _Result_get__: - -.. _App_Result_get: - -.. _App_Result_get__: - -.. _io_realm_mongodb_App_Result_get: - -.. _io_realm_mongodb_App_Result_get__: - - - -get ----- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`get ` () - | - - - - - * - Returns the response in case the request was a success. - - - - - - - **Returns** - - the response value in case of a successful request. - - - - - - - - - - - -.. _getError: - -.. _getError__: - -.. _Result_getError: - -.. _Result_getError__: - -.. _App_Result_getError: - -.. _App_Result_getError__: - -.. _io_realm_mongodb_App_Result_getError: - -.. _io_realm_mongodb_App_Result_getError__: - - - -getError --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` :ref:`getError ` () - | - - - - - * - Returns the error in case of a failed request. - - - - - - - **Returns** - - the :ref:`AppException ` in case of a failed request. - - - - - - - - - - - - - -.. _getOrDefault: - -.. _getOrDefault__: - -.. _Result_getOrDefault: - -.. _Result_getOrDefault__: - -.. _App_Result_getOrDefault: - -.. _App_Result_getOrDefault__: - -.. _io_realm_mongodb_App_Result_getOrDefault: - -.. _io_realm_mongodb_App_Result_getOrDefault__: - - - -getOrDefault ------------- - -.. _io_realm_mongodb_App_Result_getOrDefault_T_: - -.. _getOrDefault_T_: - -.. _App_Result_getOrDefault_T_: - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`getOrDefault ` ( - | **T** defaultValue - | ) - - - - - * - Returns the response if the request was a success. If it failed, the default value is returned instead. - - - - - - - **Returns** - - the response value in case of a successful request. If the request failed, the default value is returned instead. - - - - - - - - - - - -.. _getOrThrow: - -.. _getOrThrow__: - -.. _Result_getOrThrow: - -.. _Result_getOrThrow__: - -.. _App_Result_getOrThrow: - -.. _App_Result_getOrThrow__: - -.. _io_realm_mongodb_App_Result_getOrThrow: - -.. _io_realm_mongodb_App_Result_getOrThrow__: - - - -getOrThrow ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`getOrThrow ` () - | - - - - - * - If the request was successful the response is returned, otherwise the provided error is thrown. - - - - - - - **Returns** - - the response object in case the request was a success. - - - - - **Throws** - - - :ref:`AppException ` - provided error in case the request failed. - - - - - - - - - - - - -.. _isSuccess: - -.. _isSuccess__: - -.. _Result_isSuccess: - -.. _Result_isSuccess__: - -.. _App_Result_isSuccess: - -.. _App_Result_isSuccess__: - -.. _io_realm_mongodb_App_Result_isSuccess: - -.. _io_realm_mongodb_App_Result_isSuccess__: - - - -isSuccess ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isSuccess ` () - | - - - - - * - Returns whether or not request was successful - - - - - - - **Returns** - - ``true`` if the request was a success, ``false`` if not. - - - - - - - - - - - - - -.. _success: - -.. _success__: - -.. _Result_success: - -.. _Result_success__: - -.. _App_Result_success: - -.. _App_Result_success__: - -.. _io_realm_mongodb_App_Result_success: - -.. _io_realm_mongodb_App_Result_success__: - - - -success -------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`App.Result ` :ref:`success ` <**T** >() - | - - - - - * - Creates a successful request result with no return value. - - - - - - - - - - - - - - - -.. _withError: - -.. _withError__: - -.. _Result_withError: - -.. _Result_withError__: - -.. _App_Result_withError: - -.. _App_Result_withError__: - -.. _io_realm_mongodb_App_Result_withError: - -.. _io_realm_mongodb_App_Result_withError__: - - - -withError ---------- - -.. _io_realm_mongodb_App_Result_withError_io_realm_mongodb_AppException_: - -.. _io_realm_mongodb_App_Result_withError_AppException_: - -.. _withError_io_realm_mongodb_AppException_: - -.. _withError_AppException_: - -.. _App_Result_withError_io_realm_mongodb_AppException_: - -.. _App_Result_withError_AppException_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`App.Result ` :ref:`withError ` <**T** >( - | :ref:`AppException ` exception - | ) - - - - - * - Creates a failed request result. The request failed for some reason, either because there was a network error or the Realm Object Server returned an error. - - - - - **Parameters** - - - ``exception`` - error that occurred. - - - - - - - - - - - - - - - - -.. _withResult: - -.. _withResult__: - -.. _Result_withResult: - -.. _Result_withResult__: - -.. _App_Result_withResult: - -.. _App_Result_withResult__: - -.. _io_realm_mongodb_App_Result_withResult: - -.. _io_realm_mongodb_App_Result_withResult__: - - - -withResult ----------- - -.. _io_realm_mongodb_App_Result_withResult_T_: - -.. _withResult_T_: - -.. _App_Result_withResult_T_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`App.Result ` :ref:`withResult ` <**T** >( - | **T** result - | ) - - - - - * - Creates a successful request result with a return value. - - - - - **Parameters** - - - ``result`` - the result value. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt b/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt deleted file mode 100644 index 78dd602ea9..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/AppConfiguration.txt +++ /dev/null @@ -1,1273 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class AppConfiguration -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_AppConfiguration: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.AppConfiguration - - -An AppConfiguration is used to setup a MongoDB Realm application.Instances of an AppConfiguration can only created by using the :ref:`AppConfiguration.Builder ` and calling its :ref:`AppConfiguration.Builder.build() ` method. - - - -Configuring an App is only required if the default settings are not enough. Otherwise calling ``new App("app-id")`` is sufficient. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`AppConfiguration.Builder ` - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`DEFAULT_AUTHORIZATION_HEADER_NAME ` - - The default header name used to carry authorization data when making network requests towards MongoDB Realm. - - - * - public static final `String `__ - - - - :ref:`DEFAULT_BASE_URL ` - - The default url for MongoDB Realm applications. - - - * - public static final **CodecRegistry** - - - - :ref:`DEFAULT_BSON_CODEC_REGISTRY ` - - Default BSON codec registry for encoding/decoding arguments and results to/from MongoDB App Services backend.This will encode/decode most primitive types, list and map types and BsonValues. - - - - - * - public static final **long** - - - - :ref:`DEFAULT_REQUEST_TIMEOUT ` - - The default request timeout for network requests towards MongoDB Realm in seconds. - - - * - public static final `Map `__ - - - - :ref:`loginObfuscators ` - - Default obfuscators for login requests used in a MongoDB Realm app.This map is needed to instantiate the default :ref:`HttpLogObfuscator ` , which will keep all login-sensitive information from being shown in Logcat. - - - - This map's keys represent the different login identity providers which can be used to authenticate against an app and the values are the concrete obfuscators used for that provider. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public `String `__ - - | :ref:`getAppId ` () - | - - - Returns the unique app id that identities the Realm application. - - - - - * - public `String `__ - - | :ref:`getAppName ` () - | - - - Returns the name used to describe the Realm application. - - - - - * - public `String `__ - - | :ref:`getAppVersion ` () - | - - - Returns the version of this Realm application. - - - - - * - public `String `__ - - | :ref:`getAuthorizationHeaderName ` () - | - - - Returns the name of the header used to carry authentication data when making network requests towards MongoDB Realm. - - - - - * - public `URL `__ - - | :ref:`getBaseUrl ` () - | - - - Returns the base url for this Realm application. - - - - - * - public `Map `__ - - | :ref:`getCustomRequestHeaders ` () - | - - - Returns any custom configured headers that will be sent alongside other headers when making network requests towards MongoDB Realm. - - - - - * - public :ref:`SyncSession.ClientResetHandler ` - - | :ref:`getDefaultClientResetHandler ` () - | - - - Returns the default Client Reset handler used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - * - public **CodecRegistry** - - | :ref:`getDefaultCodecRegistry ` () - | - - - Returns the default codec registry used to encode and decode BSON arguments and results when calling remote Realm :ref:`io.realm.mongodb.functions.Functions ` and accessing a remote :ref:`io.realm.mongodb.mongo.MongoDatabase ` . - - - - - - - * - public :ref:`SyncSession.ErrorHandler ` - - | :ref:`getDefaultErrorHandler ` () - | - - - Returns the default error handler used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - * - public :ref:`SyncClientResetStrategy ` - - | :ref:`getDefaultSyncClientResetStrategy ` () - | - - - Returns the default sync client reset strategy used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - * - public **byte** - - | :ref:`getEncryptionKey ` () - | - - - Returns the encryption key, if any, that is used to encrypt Realm users meta data on this device. - - - - - * - public :ref:`HttpLogObfuscator ` - - | :ref:`getHttpLogObfuscator ` () - | - - - Returns the :ref:`HttpLogObfuscator ` used in the app, which keeps sensitive information in HTTP requests from being displayed in the logcat. - - - - - - - * - public **long** - - | :ref:`getRequestTimeoutMs ` () - | - - - Returns the default timeout for network requests against the Realm application in milliseconds. - - - - - * - public `File `__ - - | :ref:`getSyncRootDirectory ` () - | - - - Returns the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_mongodb_AppConfiguration_DEFAULT_AUTHORIZATION_HEADER_NAME: - - - -``DEFAULT_AUTHORIZATION_HEADER_NAME`` --------------------------------------- - -The default header name used to carry authorization data when making network requests towards MongoDB Realm. - - -.. _io_realm_mongodb_AppConfiguration_DEFAULT_BASE_URL: - - - -``DEFAULT_BASE_URL`` ---------------------- - -The default url for MongoDB Realm applications. - - -.. seealso:: - - - - - :ref:`Builder.baseUrl(String) ` - - - - - - - - - -.. _io_realm_mongodb_AppConfiguration_DEFAULT_BSON_CODEC_REGISTRY: - - - -``DEFAULT_BSON_CODEC_REGISTRY`` --------------------------------- - -Default BSON codec registry for encoding/decoding arguments and results to/from MongoDB App Services backend.This will encode/decode most primitive types, list and map types and BsonValues. - - - - -.. seealso:: - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - :ref:`AppConfiguration.Builder.codecRegistry(CodecRegistry) ` - - - - - **ValueCodecProvider** - - - - - **BsonValueCodecProvider** - - - - - **IterableCodecProvider** - - - - - **MapCodecProvider** - - - - - **DocumentCodecProvider** - - - - - - - - - -.. _io_realm_mongodb_AppConfiguration_DEFAULT_REQUEST_TIMEOUT: - - - -``DEFAULT_REQUEST_TIMEOUT`` ----------------------------- - -The default request timeout for network requests towards MongoDB Realm in seconds. - - -.. seealso:: - - - - - :ref:`Builder.requestTimeout(long, TimeUnit) ` - - - - - - - - - -.. _io_realm_mongodb_AppConfiguration_loginObfuscators: - - - -``loginObfuscators`` ---------------------- - -Default obfuscators for login requests used in a MongoDB Realm app.This map is needed to instantiate the default :ref:`HttpLogObfuscator ` , which will keep all login-sensitive information from being shown in Logcat. - - - -This map's keys represent the different login identity providers which can be used to authenticate against an app and the values are the concrete obfuscators used for that provider. - - - - -.. seealso:: - - - - - :ref:`Credentials.Provider ` - - - - - **RegexPatternObfuscator** - - - - - **ApiKeyObfuscator** - - - - - **TokenObfuscator** - - - - - **CustomFunctionObfuscator** - - - - - **EmailPasswordObfuscator** - - - - - :ref:`HttpLogObfuscator ` - - - - - - - - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _AppConfiguration_equals: - -.. _AppConfiguration_equals__: - -.. _io_realm_mongodb_AppConfiguration_equals: - -.. _io_realm_mongodb_AppConfiguration_equals__: - - - -equals ------- - -.. _io_realm_mongodb_AppConfiguration_equals_java_lang_Object_: - -.. _io_realm_mongodb_AppConfiguration_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _AppConfiguration_equals_java_lang_Object_: - -.. _AppConfiguration_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getAppId: - -.. _getAppId__: - -.. _AppConfiguration_getAppId: - -.. _AppConfiguration_getAppId__: - -.. _io_realm_mongodb_AppConfiguration_getAppId: - -.. _io_realm_mongodb_AppConfiguration_getAppId__: - - - -getAppId --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAppId ` () - | - - - - - * - Returns the unique app id that identities the Realm application. - - - - - - - **Returns** - - the app unique identifier. - - - - - - - - - - - -.. _getAppName: - -.. _getAppName__: - -.. _AppConfiguration_getAppName: - -.. _AppConfiguration_getAppName__: - -.. _io_realm_mongodb_AppConfiguration_getAppName: - -.. _io_realm_mongodb_AppConfiguration_getAppName__: - - - -getAppName ----------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAppName ` () - | - - - - - * - Returns the name used to describe the Realm application. This is only used as debug information. - - - - - - - **Returns** - - the app name. - - - - - - - - - - - -.. _getAppVersion: - -.. _getAppVersion__: - -.. _AppConfiguration_getAppVersion: - -.. _AppConfiguration_getAppVersion__: - -.. _io_realm_mongodb_AppConfiguration_getAppVersion: - -.. _io_realm_mongodb_AppConfiguration_getAppVersion__: - - - -getAppVersion -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAppVersion ` () - | - - - - - * - Returns the version of this Realm application. This is only used as debug information. - - - - - - - **Returns** - - the app version. - - - - - - - - - - - -.. _getAuthorizationHeaderName: - -.. _getAuthorizationHeaderName__: - -.. _AppConfiguration_getAuthorizationHeaderName: - -.. _AppConfiguration_getAuthorizationHeaderName__: - -.. _io_realm_mongodb_AppConfiguration_getAuthorizationHeaderName: - -.. _io_realm_mongodb_AppConfiguration_getAuthorizationHeaderName__: - - - -getAuthorizationHeaderName --------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAuthorizationHeaderName ` () - | - - - - - * - Returns the name of the header used to carry authentication data when making network requests towards MongoDB Realm. - - - - - - - **Returns** - - the authentication header name. - - - - - - - - - - - -.. _getBaseUrl: - -.. _getBaseUrl__: - -.. _AppConfiguration_getBaseUrl: - -.. _AppConfiguration_getBaseUrl__: - -.. _io_realm_mongodb_AppConfiguration_getBaseUrl: - -.. _io_realm_mongodb_AppConfiguration_getBaseUrl__: - - - -getBaseUrl ----------- - -.. list-table:: - :header-rows: 1 - - * - | public `URL `__ :ref:`getBaseUrl ` () - | - - - - - * - Returns the base url for this Realm application. - - - - - - - **Returns** - - the app base url. - - - - - - - - - - - -.. _getCustomRequestHeaders: - -.. _getCustomRequestHeaders__: - -.. _AppConfiguration_getCustomRequestHeaders: - -.. _AppConfiguration_getCustomRequestHeaders__: - -.. _io_realm_mongodb_AppConfiguration_getCustomRequestHeaders: - -.. _io_realm_mongodb_AppConfiguration_getCustomRequestHeaders__: - - - -getCustomRequestHeaders ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public `Map `__ :ref:`getCustomRequestHeaders ` () - | - - - - - * - Returns any custom configured headers that will be sent alongside other headers when making network requests towards MongoDB Realm. - - - - - - - **Returns** - - a ``Map`` of custom configured headers. - - - - - - - - - - - - - -.. _getDefaultClientResetHandler: - -.. _getDefaultClientResetHandler__: - -.. _AppConfiguration_getDefaultClientResetHandler: - -.. _AppConfiguration_getDefaultClientResetHandler__: - -.. _io_realm_mongodb_AppConfiguration_getDefaultClientResetHandler: - -.. _io_realm_mongodb_AppConfiguration_getDefaultClientResetHandler__: - - - -getDefaultClientResetHandler ----------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncSession.ClientResetHandler ` :ref:`getDefaultClientResetHandler ` () - | - - - - - * - Returns the default Client Reset handler used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - - - **Returns** - - the app default error handler. - - - - - - - - - - - -.. _getDefaultCodecRegistry: - -.. _getDefaultCodecRegistry__: - -.. _AppConfiguration_getDefaultCodecRegistry: - -.. _AppConfiguration_getDefaultCodecRegistry__: - -.. _io_realm_mongodb_AppConfiguration_getDefaultCodecRegistry: - -.. _io_realm_mongodb_AppConfiguration_getDefaultCodecRegistry__: - - - -getDefaultCodecRegistry ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **CodecRegistry** :ref:`getDefaultCodecRegistry ` () - | - - - - - * - Returns the default codec registry used to encode and decode BSON arguments and results when calling remote Realm :ref:`io.realm.mongodb.functions.Functions ` and accessing a remote :ref:`io.realm.mongodb.mongo.MongoDatabase ` . - - - - - - - - - **Returns** - - The default codec registry for the App. - - - - - - - - - .. seealso:: - - - - - :ref:`DEFAULT_BSON_CODEC_REGISTRY ` - - - - - **Builder.getDefaultCodecRegistry()** - - - - - - - - - - - - -.. _getDefaultErrorHandler: - -.. _getDefaultErrorHandler__: - -.. _AppConfiguration_getDefaultErrorHandler: - -.. _AppConfiguration_getDefaultErrorHandler__: - -.. _io_realm_mongodb_AppConfiguration_getDefaultErrorHandler: - -.. _io_realm_mongodb_AppConfiguration_getDefaultErrorHandler__: - - - -getDefaultErrorHandler ----------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncSession.ErrorHandler ` :ref:`getDefaultErrorHandler ` () - | - - - - - * - Returns the default error handler used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - - - **Returns** - - the app default error handler. - - - - - - - - - - - -.. _getDefaultSyncClientResetStrategy: - -.. _getDefaultSyncClientResetStrategy__: - -.. _AppConfiguration_getDefaultSyncClientResetStrategy: - -.. _AppConfiguration_getDefaultSyncClientResetStrategy__: - -.. _io_realm_mongodb_AppConfiguration_getDefaultSyncClientResetStrategy: - -.. _io_realm_mongodb_AppConfiguration_getDefaultSyncClientResetStrategy__: - - - -getDefaultSyncClientResetStrategy ---------------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncClientResetStrategy ` :ref:`getDefaultSyncClientResetStrategy ` () - | - - - - - * - Returns the default sync client reset strategy used by synced Realms if there are problems with their :ref:`SyncSession ` . - - - - - - - - - **Returns** - - the app default error handler. - - - - - - - - - - - -.. _getEncryptionKey: - -.. _getEncryptionKey__: - -.. _AppConfiguration_getEncryptionKey: - -.. _AppConfiguration_getEncryptionKey__: - -.. _io_realm_mongodb_AppConfiguration_getEncryptionKey: - -.. _io_realm_mongodb_AppConfiguration_getEncryptionKey__: - - - -getEncryptionKey ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **byte** :ref:`getEncryptionKey ` () - | - - - - - * - Returns the encryption key, if any, that is used to encrypt Realm users meta data on this device. If no key is returned, the data is not encrypted. - - - - - - - **Returns** - - the encryption key if exists, or ``null`` otherwise. - - - - - - - - - - - - - -.. _getHttpLogObfuscator: - -.. _getHttpLogObfuscator__: - -.. _AppConfiguration_getHttpLogObfuscator: - -.. _AppConfiguration_getHttpLogObfuscator__: - -.. _io_realm_mongodb_AppConfiguration_getHttpLogObfuscator: - -.. _io_realm_mongodb_AppConfiguration_getHttpLogObfuscator__: - - - -getHttpLogObfuscator --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`HttpLogObfuscator ` :ref:`getHttpLogObfuscator ` () - | - - - - - * - Returns the :ref:`HttpLogObfuscator ` used in the app, which keeps sensitive information in HTTP requests from being displayed in the logcat. - - - - - - - - - **Returns** - - the HTTP log obfuscator. - - - - - - - - - - - -.. _getRequestTimeoutMs: - -.. _getRequestTimeoutMs__: - -.. _AppConfiguration_getRequestTimeoutMs: - -.. _AppConfiguration_getRequestTimeoutMs__: - -.. _io_realm_mongodb_AppConfiguration_getRequestTimeoutMs: - -.. _io_realm_mongodb_AppConfiguration_getRequestTimeoutMs__: - - - -getRequestTimeoutMs -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getRequestTimeoutMs ` () - | - - - - - * - Returns the default timeout for network requests against the Realm application in milliseconds. - - - - - - - **Returns** - - the default timeout for network requests in milliseconds. - - - - - - - - - - - -.. _getSyncRootDirectory: - -.. _getSyncRootDirectory__: - -.. _AppConfiguration_getSyncRootDirectory: - -.. _AppConfiguration_getSyncRootDirectory__: - -.. _io_realm_mongodb_AppConfiguration_getSyncRootDirectory: - -.. _io_realm_mongodb_AppConfiguration_getSyncRootDirectory__: - - - -getSyncRootDirectory --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public `File `__ :ref:`getSyncRootDirectory ` () - | - - - - - * - Returns the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm. - - - - - - - **Returns** - - the sync root directory. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _AppConfiguration_hashCode: - -.. _AppConfiguration_hashCode__: - -.. _io_realm_mongodb_AppConfiguration_hashCode: - -.. _io_realm_mongodb_AppConfiguration_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt b/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt deleted file mode 100644 index e81e601e08..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/AppConfiguration/Builder.txt +++ /dev/null @@ -1,1506 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class AppConfiguration.Builder -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_AppConfiguration_Builder: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.AppConfiguration.Builder - - - - -**Enclosing class:** - -:ref:`AppConfiguration ` - - - -Builder used to construct instances of a :ref:`AppConfiguration ` in a fluent manner. - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Builder ` ( - | `String `__ appId - | ) - - - Creates an instance of the Builder for the AppConfiguration. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`addCustomRequestHeader ` ( - | `String `__ headerName, - | `String `__ headerValue - | ) - - - Adds an extra HTTP header to append to every request to a Realm Object Server. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`addCustomRequestHeaders ` ( - | `java.util.Map\ `__ headers - | ) - - - Adds extra HTTP headers to append to every request to a Realm Object Server. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`appName ` ( - | `String `__ appName - | ) - - - Sets the apps name. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`appVersion ` ( - | `String `__ appVersion - | ) - - - Sets the apps version. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`authorizationHeaderName ` ( - | `String `__ headerName - | ) - - - Sets the name of the HTTP header used to send authorization data in when making requests to MongoDB Realm. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`baseUrl ` ( - | `String `__ baseUrl - | ) - - - Sets the base url for the MongoDB Realm Application. - - - - - * - public :ref:`AppConfiguration ` - - | :ref:`build ` () - | - - - Creates the AppConfiguration. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`codecRegistry ` ( - | **CodecRegistry** codecRegistry - | ) - - - Set the default codec registry used to encode and decode BSON arguments and results when calling remote Realm :ref:`io.realm.mongodb.functions.Functions ` and accessing a remote :ref:`io.realm.mongodb.mongo.MongoDatabase ` . - - - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`defaultClientResetHandler ` ( - | :ref:`SyncSession.ClientResetHandler ` handler - | ) - - - Sets the default Client Reset handler used by Synced Realms when they report a Client Reset. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`defaultSyncClientResetStrategy ` ( - | :ref:`DiscardUnsyncedChangesStrategy ` strategy - | ) - - - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`defaultSyncClientResetStrategy ` ( - | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` strategy - | ) - - - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`defaultSyncErrorHandler ` ( - | :ref:`SyncSession.ErrorHandler ` errorHandler - | ) - - - Sets the default error handler used by Synced Realms when reporting errors with their session. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - Sets the encryption key used to encrypt user meta data only. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`httpLogObfuscator ` ( - | :ref:`HttpLogObfuscator ` httpLogObfuscator - | ) - - - Sets the :ref:`HttpLogObfuscator ` used to keep sensitive information in HTTP requests from being displayed in the logcat. - - - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`requestTimeout ` ( - | **long** time, - | `TimeUnit `__ unit - | ) - - - Sets the default timeout used by network requests against the MongoDB Realm application. - - - - - * - public :ref:`AppConfiguration.Builder ` - - | :ref:`syncRootDirectory ` ( - | `File `__ rootDir - | ) - - - Configures the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Builder: - -.. _Builder__: - -.. _io_realm_mongodb_AppConfiguration_Builder: - -.. _io_realm_mongodb_AppConfiguration_Builder__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Builder ` ( - | `String `__ appId - | ) - - - - - * - Creates an instance of the Builder for the AppConfiguration. - - - - - **Parameters** - - - ``appId`` - the application id of the MongoDB Realm Application. - - - - - - - - - - - - - - -Method Detail -============= - -.. _addCustomRequestHeader: - -.. _addCustomRequestHeader__: - -.. _Builder_addCustomRequestHeader: - -.. _Builder_addCustomRequestHeader__: - -.. _AppConfiguration_Builder_addCustomRequestHeader: - -.. _AppConfiguration_Builder_addCustomRequestHeader__: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader__: - - - -addCustomRequestHeader ----------------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_java_lang_String_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_java_lang_String__String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_String_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_String__java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_String_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeader_String__String_: - -.. _addCustomRequestHeader_java_lang_String_java_lang_String_: - -.. _addCustomRequestHeader_java_lang_String__java_lang_String_: - -.. _addCustomRequestHeader_java_lang_String_String_: - -.. _addCustomRequestHeader_java_lang_String__String_: - -.. _addCustomRequestHeader_String_java_lang_String_: - -.. _addCustomRequestHeader_String__java_lang_String_: - -.. _addCustomRequestHeader_String_String_: - -.. _addCustomRequestHeader_String__String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_java_lang_String_java_lang_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_java_lang_String__java_lang_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_java_lang_String_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_java_lang_String__String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_String_java_lang_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_String__java_lang_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_String_String_: - -.. _AppConfiguration_Builder_addCustomRequestHeader_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`addCustomRequestHeader ` ( - | `String `__ headerName, - | `String `__ headerValue - | ) - - - - - * - Adds an extra HTTP header to append to every request to a Realm Object Server. - - - - - **Parameters** - - - ``headerName`` - the name of the header. - - - - - ``headerValue`` - the value of header. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a non-empty ``headerName`` is provided or a null ``headerValue`` . - - - - - - - - - - - - - - -.. _addCustomRequestHeaders: - -.. _addCustomRequestHeaders__: - -.. _Builder_addCustomRequestHeaders: - -.. _Builder_addCustomRequestHeaders__: - -.. _AppConfiguration_Builder_addCustomRequestHeaders: - -.. _AppConfiguration_Builder_addCustomRequestHeaders__: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeaders: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeaders__: - - - -addCustomRequestHeaders ------------------------ - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeaders_java_util_Map_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeaders_Map_: - -.. _addCustomRequestHeaders_java_util_Map_: - -.. _addCustomRequestHeaders_Map_: - -.. _AppConfiguration_Builder_addCustomRequestHeaders_java_util_Map_: - -.. _AppConfiguration_Builder_addCustomRequestHeaders_Map_: - -.. _io_realm_mongodb_AppConfiguration_Builder_addCustomRequestHeaders_Map_String__String__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`addCustomRequestHeaders ` ( - | `java.util.Map\ `__ headers - | ) - - - - - * - Adds extra HTTP headers to append to every request to a Realm Object Server. - - - - - **Parameters** - - - ``headers`` - map of (headerName, headerValue) pairs. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - If any of the headers provided are illegal. - - - - - - - - - - - - -.. _appName: - -.. _appName__: - -.. _Builder_appName: - -.. _Builder_appName__: - -.. _AppConfiguration_Builder_appName: - -.. _AppConfiguration_Builder_appName__: - -.. _io_realm_mongodb_AppConfiguration_Builder_appName: - -.. _io_realm_mongodb_AppConfiguration_Builder_appName__: - - - -appName -------- - -.. _io_realm_mongodb_AppConfiguration_Builder_appName_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_appName_String_: - -.. _appName_java_lang_String_: - -.. _appName_String_: - -.. _AppConfiguration_Builder_appName_java_lang_String_: - -.. _AppConfiguration_Builder_appName_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`appName ` ( - | `String `__ appName - | ) - - - - - * - Sets the apps name. This is only used as part of debug headers sent when making network requests at the MongoDB Realm application. - - - - - **Parameters** - - - ``appName`` - app name used to identify the application. - - - - - - - - - - - - - - - - -.. _appVersion: - -.. _appVersion__: - -.. _Builder_appVersion: - -.. _Builder_appVersion__: - -.. _AppConfiguration_Builder_appVersion: - -.. _AppConfiguration_Builder_appVersion__: - -.. _io_realm_mongodb_AppConfiguration_Builder_appVersion: - -.. _io_realm_mongodb_AppConfiguration_Builder_appVersion__: - - - -appVersion ----------- - -.. _io_realm_mongodb_AppConfiguration_Builder_appVersion_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_appVersion_String_: - -.. _appVersion_java_lang_String_: - -.. _appVersion_String_: - -.. _AppConfiguration_Builder_appVersion_java_lang_String_: - -.. _AppConfiguration_Builder_appVersion_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`appVersion ` ( - | `String `__ appVersion - | ) - - - - - * - Sets the apps version. This is only used as part of debug headers sent when making network requests at the MongoDB Realm application. - - - - - **Parameters** - - - ``appVersion`` - app version used to identify the application. - - - - - - - - - - - - - - - - -.. _authorizationHeaderName: - -.. _authorizationHeaderName__: - -.. _Builder_authorizationHeaderName: - -.. _Builder_authorizationHeaderName__: - -.. _AppConfiguration_Builder_authorizationHeaderName: - -.. _AppConfiguration_Builder_authorizationHeaderName__: - -.. _io_realm_mongodb_AppConfiguration_Builder_authorizationHeaderName: - -.. _io_realm_mongodb_AppConfiguration_Builder_authorizationHeaderName__: - - - -authorizationHeaderName ------------------------ - -.. _io_realm_mongodb_AppConfiguration_Builder_authorizationHeaderName_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_authorizationHeaderName_String_: - -.. _authorizationHeaderName_java_lang_String_: - -.. _authorizationHeaderName_String_: - -.. _AppConfiguration_Builder_authorizationHeaderName_java_lang_String_: - -.. _AppConfiguration_Builder_authorizationHeaderName_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`authorizationHeaderName ` ( - | `String `__ headerName - | ) - - - - - * - Sets the name of the HTTP header used to send authorization data in when making requests to MongoDB Realm. The MongoDB server or firewall must have been configured to expect a custom authorization header.The default authorization header is named **DEFAULT_AUTHORIZATION_HEADER_NAME**. - - - - - - - - - **Parameters** - - - ``headerName`` - name of the header. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if a null or empty header is provided. - - - - - - - - - - - - -.. _baseUrl: - -.. _baseUrl__: - -.. _Builder_baseUrl: - -.. _Builder_baseUrl__: - -.. _AppConfiguration_Builder_baseUrl: - -.. _AppConfiguration_Builder_baseUrl__: - -.. _io_realm_mongodb_AppConfiguration_Builder_baseUrl: - -.. _io_realm_mongodb_AppConfiguration_Builder_baseUrl__: - - - -baseUrl -------- - -.. _io_realm_mongodb_AppConfiguration_Builder_baseUrl_java_lang_String_: - -.. _io_realm_mongodb_AppConfiguration_Builder_baseUrl_String_: - -.. _baseUrl_java_lang_String_: - -.. _baseUrl_String_: - -.. _AppConfiguration_Builder_baseUrl_java_lang_String_: - -.. _AppConfiguration_Builder_baseUrl_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`baseUrl ` ( - | `String `__ baseUrl - | ) - - - - - * - Sets the base url for the MongoDB Realm Application. The default value is **DEFAULT_BASE_URL**. - - - - - - - **Parameters** - - - ``baseUrl`` - the base url for the MongoDB Realm application. - - - - - - - - - - - - - - - - -.. _build: - -.. _build__: - -.. _Builder_build: - -.. _Builder_build__: - -.. _AppConfiguration_Builder_build: - -.. _AppConfiguration_Builder_build__: - -.. _io_realm_mongodb_AppConfiguration_Builder_build: - -.. _io_realm_mongodb_AppConfiguration_Builder_build__: - - - -build ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration ` :ref:`build ` () - | - - - - - * - Creates the AppConfiguration. - - - - - - - **Returns** - - the AppConfiguration that can be used to create a :ref:`App ` . - - - - - - - - - - - - - -.. _codecRegistry: - -.. _codecRegistry__: - -.. _Builder_codecRegistry: - -.. _Builder_codecRegistry__: - -.. _AppConfiguration_Builder_codecRegistry: - -.. _AppConfiguration_Builder_codecRegistry__: - -.. _io_realm_mongodb_AppConfiguration_Builder_codecRegistry: - -.. _io_realm_mongodb_AppConfiguration_Builder_codecRegistry__: - - - -codecRegistry -------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_codecRegistry_CodecRegistry_: - -.. _codecRegistry_CodecRegistry_: - -.. _AppConfiguration_Builder_codecRegistry_CodecRegistry_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`codecRegistry ` ( - | **CodecRegistry** codecRegistry - | ) - - - - - * - Set the default codec registry used to encode and decode BSON arguments and results when calling remote Realm :ref:`io.realm.mongodb.functions.Functions ` and accessing a remote :ref:`io.realm.mongodb.mongo.MongoDatabase ` . - - Will default to **DEFAULT_BSON_CODEC_REGISTRY** if not specified. - - - - - - - - - **Parameters** - - - ``codecRegistry`` - The default codec registry for the App. - - - - - - - - - - - - - - .. seealso:: - - - - - **DEFAULT_BSON_CODEC_REGISTRY** - - - - - **Builder.getDefaultCodecRegistry()** - - - - - - - - - - - - -.. _defaultClientResetHandler: - -.. _defaultClientResetHandler__: - -.. _Builder_defaultClientResetHandler: - -.. _Builder_defaultClientResetHandler__: - -.. _AppConfiguration_Builder_defaultClientResetHandler: - -.. _AppConfiguration_Builder_defaultClientResetHandler__: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultClientResetHandler: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultClientResetHandler__: - - - -defaultClientResetHandler -------------------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultClientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultClientResetHandler_ClientResetHandler_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultClientResetHandler_SyncSession_ClientResetHandler_: - -.. _defaultClientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _defaultClientResetHandler_ClientResetHandler_: - -.. _defaultClientResetHandler_SyncSession_ClientResetHandler_: - -.. _AppConfiguration_Builder_defaultClientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _AppConfiguration_Builder_defaultClientResetHandler_ClientResetHandler_: - -.. _AppConfiguration_Builder_defaultClientResetHandler_SyncSession_ClientResetHandler_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultClientResetHandler ` ( - | :ref:`SyncSession.ClientResetHandler ` handler - | ) - - - - - * - Sets the default Client Reset handler used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . - - - - - - - - - **Parameters** - - - ``handler`` - the default Client Reset handler. - - - - - - - - - - - - - - - - -.. _defaultSyncClientResetStrategy: - -.. _defaultSyncClientResetStrategy__: - -.. _Builder_defaultSyncClientResetStrategy: - -.. _Builder_defaultSyncClientResetStrategy__: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy__: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy__: - - - -defaultSyncClientResetStrategy ------------------------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. _defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultSyncClientResetStrategy ` ( - | :ref:`DiscardUnsyncedChangesStrategy ` strategy - | ) - - - - - * - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` or :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . - - - - - - - - - **Parameters** - - - ``strategy`` - the default sync client reset strategy. - - - - - - - - - - - - - - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _AppConfiguration_Builder_defaultSyncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultSyncClientResetStrategy ` ( - | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` strategy - | ) - - - - - * - Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` or :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . - - - - - - - - - **Parameters** - - - ``strategy`` - the default sync client reset strategy. - - - - - - - - - - - - - - - - -.. _defaultSyncErrorHandler: - -.. _defaultSyncErrorHandler__: - -.. _Builder_defaultSyncErrorHandler: - -.. _Builder_defaultSyncErrorHandler__: - -.. _AppConfiguration_Builder_defaultSyncErrorHandler: - -.. _AppConfiguration_Builder_defaultSyncErrorHandler__: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncErrorHandler: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncErrorHandler__: - - - -defaultSyncErrorHandler ------------------------ - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncErrorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncErrorHandler_ErrorHandler_: - -.. _io_realm_mongodb_AppConfiguration_Builder_defaultSyncErrorHandler_SyncSession_ErrorHandler_: - -.. _defaultSyncErrorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _defaultSyncErrorHandler_ErrorHandler_: - -.. _defaultSyncErrorHandler_SyncSession_ErrorHandler_: - -.. _AppConfiguration_Builder_defaultSyncErrorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _AppConfiguration_Builder_defaultSyncErrorHandler_ErrorHandler_: - -.. _AppConfiguration_Builder_defaultSyncErrorHandler_SyncSession_ErrorHandler_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`defaultSyncErrorHandler ` ( - | :ref:`SyncSession.ErrorHandler ` errorHandler - | ) - - - - - * - Sets the default error handler used by Synced Realms when reporting errors with their session.This default can be overridden by calling :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) ` when creating the :ref:`io.realm.mongodb.sync.SyncConfiguration ` . - - - - - - - - - **Parameters** - - - ``errorHandler`` - the default error handler. - - - - - - - - - - - - - - - - -.. _encryptionKey: - -.. _encryptionKey__: - -.. _Builder_encryptionKey: - -.. _Builder_encryptionKey__: - -.. _AppConfiguration_Builder_encryptionKey: - -.. _AppConfiguration_Builder_encryptionKey__: - -.. _io_realm_mongodb_AppConfiguration_Builder_encryptionKey: - -.. _io_realm_mongodb_AppConfiguration_Builder_encryptionKey__: - - - -encryptionKey -------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_encryptionKey_byte_: - -.. _io_realm_mongodb_AppConfiguration_Builder_encryptionKey_byte____: - -.. _encryptionKey_byte_: - -.. _encryptionKey_byte____: - -.. _AppConfiguration_Builder_encryptionKey_byte_: - -.. _AppConfiguration_Builder_encryptionKey_byte____: - -.. _io_realm_mongodb_AppConfiguration_Builder_encryptionKey_byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - - - * - Sets the encryption key used to encrypt user meta data only. Individual Realms needs to use :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder.encryptionKey(byte[]) ` to make them encrypted. - - - - - - - **Parameters** - - - ``key`` - a 64 byte encryption key. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the key is not 64 bytes long. - - - - - - - - - - - - -.. _httpLogObfuscator: - -.. _httpLogObfuscator__: - -.. _Builder_httpLogObfuscator: - -.. _Builder_httpLogObfuscator__: - -.. _AppConfiguration_Builder_httpLogObfuscator: - -.. _AppConfiguration_Builder_httpLogObfuscator__: - -.. _io_realm_mongodb_AppConfiguration_Builder_httpLogObfuscator: - -.. _io_realm_mongodb_AppConfiguration_Builder_httpLogObfuscator__: - - - -httpLogObfuscator ------------------ - -.. _io_realm_mongodb_AppConfiguration_Builder_httpLogObfuscator_io_realm_mongodb_log_obfuscator_HttpLogObfuscator_: - -.. _io_realm_mongodb_AppConfiguration_Builder_httpLogObfuscator_HttpLogObfuscator_: - -.. _httpLogObfuscator_io_realm_mongodb_log_obfuscator_HttpLogObfuscator_: - -.. _httpLogObfuscator_HttpLogObfuscator_: - -.. _AppConfiguration_Builder_httpLogObfuscator_io_realm_mongodb_log_obfuscator_HttpLogObfuscator_: - -.. _AppConfiguration_Builder_httpLogObfuscator_HttpLogObfuscator_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`httpLogObfuscator ` ( - | :ref:`HttpLogObfuscator ` httpLogObfuscator - | ) - - - - - * - Sets the :ref:`HttpLogObfuscator ` used to keep sensitive information in HTTP requests from being displayed in the logcat. - - If left unspecified, it will default to obfuscating HTTP login requests. - - - - - - - **Parameters** - - - ``httpLogObfuscator`` - the default HTTP log obfuscator for the app. - - - - - - - - - - - - - - - - -.. _requestTimeout: - -.. _requestTimeout__: - -.. _Builder_requestTimeout: - -.. _Builder_requestTimeout__: - -.. _AppConfiguration_Builder_requestTimeout: - -.. _AppConfiguration_Builder_requestTimeout__: - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout: - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout__: - - - -requestTimeout --------------- - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout_long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout_long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout_long_TimeUnit_: - -.. _io_realm_mongodb_AppConfiguration_Builder_requestTimeout_long__TimeUnit_: - -.. _requestTimeout_long_java_util_concurrent_TimeUnit_: - -.. _requestTimeout_long__java_util_concurrent_TimeUnit_: - -.. _requestTimeout_long_TimeUnit_: - -.. _requestTimeout_long__TimeUnit_: - -.. _AppConfiguration_Builder_requestTimeout_long_java_util_concurrent_TimeUnit_: - -.. _AppConfiguration_Builder_requestTimeout_long__java_util_concurrent_TimeUnit_: - -.. _AppConfiguration_Builder_requestTimeout_long_TimeUnit_: - -.. _AppConfiguration_Builder_requestTimeout_long__TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`requestTimeout ` ( - | **long** time, - | `TimeUnit `__ unit - | ) - - - - - * - Sets the default timeout used by network requests against the MongoDB Realm application. Requests will terminate with a failure if they exceed this limit. The default value is :ref:`AppConfiguration.DEFAULT_REQUEST_TIMEOUT ` seconds. - - - - - - - **Parameters** - - - ``time`` - the timeout value for network requests. - - - - - ``unit`` - the unit of time used to define the timeout. - - - - - - - - - - - - - - - - -.. _syncRootDirectory: - -.. _syncRootDirectory__: - -.. _Builder_syncRootDirectory: - -.. _Builder_syncRootDirectory__: - -.. _AppConfiguration_Builder_syncRootDirectory: - -.. _AppConfiguration_Builder_syncRootDirectory__: - -.. _io_realm_mongodb_AppConfiguration_Builder_syncRootDirectory: - -.. _io_realm_mongodb_AppConfiguration_Builder_syncRootDirectory__: - - - -syncRootDirectory ------------------ - -.. _io_realm_mongodb_AppConfiguration_Builder_syncRootDirectory_java_io_File_: - -.. _io_realm_mongodb_AppConfiguration_Builder_syncRootDirectory_File_: - -.. _syncRootDirectory_java_io_File_: - -.. _syncRootDirectory_File_: - -.. _AppConfiguration_Builder_syncRootDirectory_java_io_File_: - -.. _AppConfiguration_Builder_syncRootDirectory_File_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppConfiguration.Builder ` :ref:`syncRootDirectory ` ( - | `File `__ rootDir - | ) - - - - - * - Configures the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm.The default root dir is ``Context.getFilesDir()/mongodb-realm`` . - - - - - - - - - **Parameters** - - - ``rootDir`` - where to store sync related files. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/AppException.txt b/source/sdk/java/api/io/realm/mongodb/AppException.txt deleted file mode 100644 index d745508d79..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/AppException.txt +++ /dev/null @@ -1,858 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception AppException -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_AppException: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | io.realm.mongodb.AppException - - -This class is a wrapper for all errors happening when communicating with a MongoDB Realm app. This include both exceptions and protocol errors. Only :ref:`getErrorCode() ` is guaranteed to contain a value. If the error was caused by an underlying exception :ref:`getErrorMessage() ` is ``null`` and :ref:`getException() ` is set, while if the error was a protocol error :ref:`getErrorMessage() ` is set and :ref:`getException() ` is null. - - - - -.. seealso:: - - - - - :ref:`ErrorCode for a list of possible errors. ` - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage - | ) - - - Create an error caused by an error in the protocol when communicating with the Object Server. - - - - - * - | :ref:`AppException ` ( - | `String `__ errorType, - | **int** errorCode, - | `String `__ errorMessage - | ) - - - Creates an unknown error that could not be mapped to any known error case. - - - - - * - | :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `Throwable `__ exception - | ) - - - Create an error caused by an an exception when communicating with the Object Server. - - - - - * - | :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ title, - | `String `__ hint - | ) - - - Errors happening while trying to authenticate a user. - - - - - * - | :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage, - | `Throwable `__ exception - | ) - - - Generic error happening that could happen anywhere. - - - - - * - | :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ nativeErrorType, - | **int** nativeErrorCode, - | `String `__ errorMessage, - | `Throwable `__ exception - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`ErrorCode.Category ` - - | :ref:`getCategory ` () - | - - - Returns the :ref:`ErrorCode.Category ` category for this error. - - - - - - - * - public :ref:`ErrorCode ` - - | :ref:`getErrorCode ` () - | - - - Returns the :ref:`ErrorCode ` identifying the type of error. - - - - - - - * - public **int** - - | :ref:`getErrorIntValue ` () - | - - - Returns an integer representing this specific type of error. - - - - - * - public `String `__ - - | :ref:`getErrorMessage ` () - | - - - Returns a more detailed error message about the cause of this error. - - - - - * - public `String `__ - - | :ref:`getErrorType ` () - | - - - Returns a string describing the type of error it is. - - - - - * - public `Throwable `__ - - | :ref:`getException ` () - | - - - Returns the underlying exception causing this error, if any. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` - - - - -Constructor Detail -================== - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage - | ) - - - - - * - Create an error caused by an error in the protocol when communicating with the Object Server. - - - - - **Parameters** - - - ``errorCode`` - error code for this type of error. - - - - - ``errorMessage`` - detailed error message. - - - - - - - - - - - - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | `String `__ errorType, - | **int** errorCode, - | `String `__ errorMessage - | ) - - - - - * - Creates an unknown error that could not be mapped to any known error case.This means that :ref:`getErrorCode() ` will return :ref:`ErrorCode.UNKNOWN ` , but :ref:`getErrorType() ` and :ref:`getErrorIntValue() ` will return the underlying values which can help identify the real error. - - - - - - - - - **Parameters** - - - ``errorCode`` - error code for this type of error. - - - - - ``errorMessage`` - detailed error message. - - - - - - - - - - - - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `Throwable `__ exception - | ) - - - - - * - Create an error caused by an an exception when communicating with the Object Server. - - - - - **Parameters** - - - ``errorCode`` - error code for this type of error. - - - - - ``exception`` - underlying exception causing this error. - - - - - - - - - - - - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ title, - | `String `__ hint - | ) - - - - - * - Errors happening while trying to authenticate a user. - - - - - **Parameters** - - - ``errorCode`` - error code for this type of error. - - - - - ``title`` - title for this type of error. - - - - - ``hint`` - a hint for resolving the error. - - - - - - - - - - - - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ errorMessage, - | `Throwable `__ exception - | ) - - - - - * - Generic error happening that could happen anywhere. - - - - - **Parameters** - - - ``errorCode`` - error code for this type of error. - - - - - ``errorMessage`` - detailed error message. - - - - - ``exception`` - underlying exception if the error was caused by this. - - - - - - - - - - - - -.. _AppException: - -.. _AppException__: - -.. _io_realm_mongodb_AppException: - -.. _io_realm_mongodb_AppException__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AppException ` ( - | :ref:`ErrorCode ` errorCode, - | `String `__ nativeErrorType, - | **int** nativeErrorCode, - | `String `__ errorMessage, - | `Throwable `__ exception - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getCategory: - -.. _getCategory__: - -.. _AppException_getCategory: - -.. _AppException_getCategory__: - -.. _io_realm_mongodb_AppException_getCategory: - -.. _io_realm_mongodb_AppException_getCategory__: - - - -getCategory ------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ErrorCode.Category ` :ref:`getCategory ` () - | - - - - - * - Returns the :ref:`ErrorCode.Category ` category for this error. Errors that are :ref:`ErrorCode.Category.RECOVERABLE ` mean that it is still possible for a given :ref:`SyncSession ` to resume synchronization. :ref:`ErrorCode.Category.FATAL ` errors means that session has stopped and cannot be recovered. - - - - - - - - - **Returns** - - the error category. - - - - - - - - - - - -.. _getErrorCode: - -.. _getErrorCode__: - -.. _AppException_getErrorCode: - -.. _AppException_getErrorCode__: - -.. _io_realm_mongodb_AppException_getErrorCode: - -.. _io_realm_mongodb_AppException_getErrorCode__: - - - -getErrorCode ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ErrorCode ` :ref:`getErrorCode ` () - | - - - - - * - Returns the :ref:`ErrorCode ` identifying the type of error. - - If :ref:`ErrorCode.UNKNOWN ` is returned, it means that the error could not be mapped to any known errors. In that case :ref:`getErrorType() ` and :ref:`getErrorIntValue() ` will return the underlying error information which can better identify the type of error. - - - - - - - - - - - **Returns** - - the error code identifying the type of error. - - - - - - - - - .. seealso:: - - - - - :ref:`ErrorCode ` - - - - - - - - - - - - -.. _getErrorIntValue: - -.. _getErrorIntValue__: - -.. _AppException_getErrorIntValue: - -.. _AppException_getErrorIntValue__: - -.. _io_realm_mongodb_AppException_getErrorIntValue: - -.. _io_realm_mongodb_AppException_getErrorIntValue__: - - - -getErrorIntValue ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getErrorIntValue ` () - | - - - - - * - Returns an integer representing this specific type of error. This value is only unique within the value provided by :ref:`getErrorType() ` . - - - - - - - - - **Returns** - - the integer value representing this type of error. - - - - - - - - - - - -.. _getErrorMessage: - -.. _getErrorMessage__: - -.. _AppException_getErrorMessage: - -.. _AppException_getErrorMessage__: - -.. _io_realm_mongodb_AppException_getErrorMessage: - -.. _io_realm_mongodb_AppException_getErrorMessage__: - - - -getErrorMessage ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getErrorMessage ` () - | - - - - - * - Returns a more detailed error message about the cause of this error. - - - - - - - **Returns** - - a detailed error message or ``null`` if one was not available. - - - - - - - - - - - - - -.. _getErrorType: - -.. _getErrorType__: - -.. _AppException_getErrorType: - -.. _AppException_getErrorType__: - -.. _io_realm_mongodb_AppException_getErrorType: - -.. _io_realm_mongodb_AppException_getErrorType__: - - - -getErrorType ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getErrorType ` () - | - - - - - * - Returns a string describing the type of error it is. - - - - - - - **Returns** - - - - - - - - - - - - - -.. _getException: - -.. _getException__: - -.. _AppException_getException: - -.. _AppException_getException__: - -.. _io_realm_mongodb_AppException_getException: - -.. _io_realm_mongodb_AppException_getException__: - - - -getException ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Throwable `__ :ref:`getException ` () - | - - - - - * - Returns the underlying exception causing this error, if any. - - - - - - - **Returns** - - the underlying exception causing this error, or ``null`` if not caused by an exception. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _AppException_toString: - -.. _AppException_toString__: - -.. _io_realm_mongodb_AppException_toString: - -.. _io_realm_mongodb_AppException_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Throwable `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/AuthenticationListener.txt b/source/sdk/java/api/io/realm/mongodb/AuthenticationListener.txt deleted file mode 100644 index c169477c2e..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/AuthenticationListener.txt +++ /dev/null @@ -1,193 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface AuthenticationListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_AuthenticationListener: - - - -io.realm.mongodb -================ - -Interface describing events related to Users and their authentication - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`loggedIn ` ( - | :ref:`User ` user - | ) - - - A user was logged into the Object Server - - - - - * - public **void** - - | :ref:`loggedOut ` ( - | :ref:`User ` user - | ) - - - A user was successfully logged out from the Object Server. - - - - - - - -Method Detail -============= - -.. _loggedIn: - -.. _loggedIn__: - -.. _AuthenticationListener_loggedIn: - -.. _AuthenticationListener_loggedIn__: - -.. _io_realm_mongodb_AuthenticationListener_loggedIn: - -.. _io_realm_mongodb_AuthenticationListener_loggedIn__: - - - -loggedIn --------- - -.. _io_realm_mongodb_AuthenticationListener_loggedIn_io_realm_mongodb_User_: - -.. _io_realm_mongodb_AuthenticationListener_loggedIn_User_: - -.. _loggedIn_io_realm_mongodb_User_: - -.. _loggedIn_User_: - -.. _AuthenticationListener_loggedIn_io_realm_mongodb_User_: - -.. _AuthenticationListener_loggedIn_User_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`loggedIn ` ( - | :ref:`User ` user - | ) - - - - - * - A user was logged into the Object Server - - - - - **Parameters** - - - ``user`` - :ref:`User ` that is now logged in. - - - - - - - - - - - - - - - - - - -.. _loggedOut: - -.. _loggedOut__: - -.. _AuthenticationListener_loggedOut: - -.. _AuthenticationListener_loggedOut__: - -.. _io_realm_mongodb_AuthenticationListener_loggedOut: - -.. _io_realm_mongodb_AuthenticationListener_loggedOut__: - - - -loggedOut ---------- - -.. _io_realm_mongodb_AuthenticationListener_loggedOut_io_realm_mongodb_User_: - -.. _io_realm_mongodb_AuthenticationListener_loggedOut_User_: - -.. _loggedOut_io_realm_mongodb_User_: - -.. _loggedOut_User_: - -.. _AuthenticationListener_loggedOut_io_realm_mongodb_User_: - -.. _AuthenticationListener_loggedOut_User_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`loggedOut ` ( - | :ref:`User ` user - | ) - - - - - * - A user was successfully logged out from the Object Server. - - - - - **Parameters** - - - ``user`` - :ref:`User ` that was successfully logged out. - - - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/Credentials.txt b/source/sdk/java/api/io/realm/mongodb/Credentials.txt deleted file mode 100644 index a8fb4d5f8d..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/Credentials.txt +++ /dev/null @@ -1,1027 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Credentials -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_Credentials: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.Credentials - - -Credentials represent a login with a given login provider, and are used by the MongoDB Realm to verify the user and grant access. The :ref:`Provider.EMAIL_PASSWORD ` provider is enabled by default. All other providers must be enabled on MongoDB Realm to work. - -Note that users wanting to login using Email/Password must register first using :ref:`EmailPasswordAuth.registerUser(String, String) ` . - - - -Credentials are used the following way: - -.. code-block:: java - - - // Example - App app = new App("app-id"); - Credentials credentials = Credentials.emailPassword("email", "password"); - User user = app.loginAsync(credentials, new App.Callback() { - @Override - public void onResult(Result result) { - if (result.isSuccess() { - handleLogin(result.get()); - } else { - handleError(result.getError()); - } - } - )); - } - - - - - - - - -.. seealso:: - - - - - `Authentication Providers `__ - - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`Credentials.Provider ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`Credentials ` - - | :ref:`anonymous ` () - | - - - Creates credentials representing an anonymous user. - - - - - * - public static :ref:`Credentials ` - - | :ref:`apiKey ` ( - | `String `__ key - | ) - - - Creates credentials representing a login using a user API key. - - - - - * - public static :ref:`Credentials ` - - | :ref:`apple ` ( - | `String `__ idToken - | ) - - - Creates credentials representing a login using an Apple ID token. - - - - - * - public `String `__ - - | :ref:`asJson ` () - | - - - Returns the credentials object serialized as a json string. - - - - - * - public static :ref:`Credentials ` - - | :ref:`customFunction ` ( - | **Document** arguments - | ) - - - Creates credentials representing a remote function from MongoDB Realm using a **Document** which will be parsed as an argument to the remote function, so the keys must match the format and names the function expects. - - - - - - - * - public static :ref:`Credentials ` - - | :ref:`emailPassword ` ( - | `String `__ email, - | `String `__ password - | ) - - - Creates credentials representing a login using email and password. - - - - - * - public static :ref:`Credentials ` - - | :ref:`facebook ` ( - | `String `__ accessToken - | ) - - - Creates credentials representing a login using a Facebook access token. - - - - - * - public :ref:`Credentials.Provider ` - - | :ref:`getIdentityProvider ` () - | - - - Returns the identity provider used to authenticate with. - - - - - * - public static :ref:`Credentials ` - - | :ref:`google ` ( - | `String `__ authorizationCode - | ) - - - Creates credentials representing a login using a :ref:`GoogleAuthType.AUTH_CODE ` Google access token. - - - - - - - * - public static :ref:`Credentials ` - - | :ref:`google ` ( - | `String `__ token, - | :ref:`GoogleAuthType ` type - | ) - - - Creates credentials representing a login using a Google access token of a given :ref:`GoogleAuthType ` . - - - - - - - * - public static :ref:`Credentials ` - - | :ref:`jwt ` ( - | `String `__ jwtToken - | ) - - - Creates credentials representing a login using a JWT Token. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _anonymous: - -.. _anonymous__: - -.. _Credentials_anonymous: - -.. _Credentials_anonymous__: - -.. _io_realm_mongodb_Credentials_anonymous: - -.. _io_realm_mongodb_Credentials_anonymous__: - - - -anonymous ---------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`anonymous ` () - | - - - - - * - Creates credentials representing an anonymous user.Logging the user out again means that data is lost with no means of recovery and it isn't possible to share the user details across devices. - - The anonymous user must be linked to another real user to preserve data after a log out. - - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _apiKey: - -.. _apiKey__: - -.. _Credentials_apiKey: - -.. _Credentials_apiKey__: - -.. _io_realm_mongodb_Credentials_apiKey: - -.. _io_realm_mongodb_Credentials_apiKey__: - - - -apiKey ------- - -.. _io_realm_mongodb_Credentials_apiKey_java_lang_String_: - -.. _io_realm_mongodb_Credentials_apiKey_String_: - -.. _apiKey_java_lang_String_: - -.. _apiKey_String_: - -.. _Credentials_apiKey_java_lang_String_: - -.. _Credentials_apiKey_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`apiKey ` ( - | `String `__ key - | ) - - - - - * - Creates credentials representing a login using a user API key.This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``key`` - the API key to use for login. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _apple: - -.. _apple__: - -.. _Credentials_apple: - -.. _Credentials_apple__: - -.. _io_realm_mongodb_Credentials_apple: - -.. _io_realm_mongodb_Credentials_apple__: - - - -apple ------ - -.. _io_realm_mongodb_Credentials_apple_java_lang_String_: - -.. _io_realm_mongodb_Credentials_apple_String_: - -.. _apple_java_lang_String_: - -.. _apple_String_: - -.. _Credentials_apple_java_lang_String_: - -.. _Credentials_apple_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`apple ` ( - | `String `__ idToken - | ) - - - - - * - Creates credentials representing a login using an Apple ID token.This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``idToken`` - the ID token generated when using your Apple login. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _asJson: - -.. _asJson__: - -.. _Credentials_asJson: - -.. _Credentials_asJson__: - -.. _io_realm_mongodb_Credentials_asJson: - -.. _io_realm_mongodb_Credentials_asJson__: - - - -asJson ------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`asJson ` () - | - - - - - * - Returns the credentials object serialized as a json string. - - - - - - - **Returns** - - a json serialized string of the credentials object. - - - - - - - - - - - -.. _customFunction: - -.. _customFunction__: - -.. _Credentials_customFunction: - -.. _Credentials_customFunction__: - -.. _io_realm_mongodb_Credentials_customFunction: - -.. _io_realm_mongodb_Credentials_customFunction__: - - - -customFunction --------------- - -.. _io_realm_mongodb_Credentials_customFunction_Document_: - -.. _customFunction_Document_: - -.. _Credentials_customFunction_Document_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`customFunction ` ( - | **Document** arguments - | ) - - - - - * - Creates credentials representing a remote function from MongoDB Realm using a **Document** which will be parsed as an argument to the remote function, so the keys must match the format and names the function expects. - - This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``arguments`` - document containing the function arguments. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _emailPassword: - -.. _emailPassword__: - -.. _Credentials_emailPassword: - -.. _Credentials_emailPassword__: - -.. _io_realm_mongodb_Credentials_emailPassword: - -.. _io_realm_mongodb_Credentials_emailPassword__: - - - -emailPassword -------------- - -.. _io_realm_mongodb_Credentials_emailPassword_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_java_lang_String_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_java_lang_String__String_: - -.. _io_realm_mongodb_Credentials_emailPassword_String_java_lang_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_String__java_lang_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_String_String_: - -.. _io_realm_mongodb_Credentials_emailPassword_String__String_: - -.. _emailPassword_java_lang_String_java_lang_String_: - -.. _emailPassword_java_lang_String__java_lang_String_: - -.. _emailPassword_java_lang_String_String_: - -.. _emailPassword_java_lang_String__String_: - -.. _emailPassword_String_java_lang_String_: - -.. _emailPassword_String__java_lang_String_: - -.. _emailPassword_String_String_: - -.. _emailPassword_String__String_: - -.. _Credentials_emailPassword_java_lang_String_java_lang_String_: - -.. _Credentials_emailPassword_java_lang_String__java_lang_String_: - -.. _Credentials_emailPassword_java_lang_String_String_: - -.. _Credentials_emailPassword_java_lang_String__String_: - -.. _Credentials_emailPassword_String_java_lang_String_: - -.. _Credentials_emailPassword_String__java_lang_String_: - -.. _Credentials_emailPassword_String_String_: - -.. _Credentials_emailPassword_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`emailPassword ` ( - | `String `__ email, - | `String `__ password - | ) - - - - - * - Creates credentials representing a login using email and password. - - - - - **Parameters** - - - ``email`` - email of the user logging in. - - - - - ``password`` - password of the user logging in. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _facebook: - -.. _facebook__: - -.. _Credentials_facebook: - -.. _Credentials_facebook__: - -.. _io_realm_mongodb_Credentials_facebook: - -.. _io_realm_mongodb_Credentials_facebook__: - - - -facebook --------- - -.. _io_realm_mongodb_Credentials_facebook_java_lang_String_: - -.. _io_realm_mongodb_Credentials_facebook_String_: - -.. _facebook_java_lang_String_: - -.. _facebook_String_: - -.. _Credentials_facebook_java_lang_String_: - -.. _Credentials_facebook_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`facebook ` ( - | `String `__ accessToken - | ) - - - - - * - Creates credentials representing a login using a Facebook access token.This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``accessToken`` - the access token returned when logging in to Facebook. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _getIdentityProvider: - -.. _getIdentityProvider__: - -.. _Credentials_getIdentityProvider: - -.. _Credentials_getIdentityProvider__: - -.. _io_realm_mongodb_Credentials_getIdentityProvider: - -.. _io_realm_mongodb_Credentials_getIdentityProvider__: - - - -getIdentityProvider -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Credentials.Provider ` :ref:`getIdentityProvider ` () - | - - - - - * - Returns the identity provider used to authenticate with. - - - - - - - **Returns** - - the provider identifying the chosen credentials. - - - - - - - - - - - -.. _google: - -.. _google__: - -.. _Credentials_google: - -.. _Credentials_google__: - -.. _io_realm_mongodb_Credentials_google: - -.. _io_realm_mongodb_Credentials_google__: - - - -google ------- - -.. _io_realm_mongodb_Credentials_google_java_lang_String_: - -.. _io_realm_mongodb_Credentials_google_String_: - -.. _google_java_lang_String_: - -.. _google_String_: - -.. _Credentials_google_java_lang_String_: - -.. _Credentials_google_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`google ` ( - | `String `__ authorizationCode - | ) - - - - - * - Creates credentials representing a login using a :ref:`GoogleAuthType.AUTH_CODE ` Google access token. - - This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``authorizationCode`` - the authorization code returned when logging in to Google. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - -.. _io_realm_mongodb_Credentials_google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_java_lang_String_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_java_lang_String__GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_String_GoogleAuthType_: - -.. _io_realm_mongodb_Credentials_google_String__GoogleAuthType_: - -.. _google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _google_java_lang_String_GoogleAuthType_: - -.. _google_java_lang_String__GoogleAuthType_: - -.. _google_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _google_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _google_String_GoogleAuthType_: - -.. _google_String__GoogleAuthType_: - -.. _Credentials_google_java_lang_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _Credentials_google_java_lang_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _Credentials_google_java_lang_String_GoogleAuthType_: - -.. _Credentials_google_java_lang_String__GoogleAuthType_: - -.. _Credentials_google_String_io_realm_mongodb_auth_GoogleAuthType_: - -.. _Credentials_google_String__io_realm_mongodb_auth_GoogleAuthType_: - -.. _Credentials_google_String_GoogleAuthType_: - -.. _Credentials_google_String__GoogleAuthType_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`google ` ( - | `String `__ token, - | :ref:`GoogleAuthType ` type - | ) - - - - - * - Creates credentials representing a login using a Google access token of a given :ref:`GoogleAuthType ` . - - This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``token`` - the access token returned when logging in to Google. - - - - - ``type`` - the access token type - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - -.. _jwt: - -.. _jwt__: - -.. _Credentials_jwt: - -.. _Credentials_jwt__: - -.. _io_realm_mongodb_Credentials_jwt: - -.. _io_realm_mongodb_Credentials_jwt__: - - - -jwt ----- - -.. _io_realm_mongodb_Credentials_jwt_java_lang_String_: - -.. _io_realm_mongodb_Credentials_jwt_String_: - -.. _jwt_java_lang_String_: - -.. _jwt_String_: - -.. _Credentials_jwt_java_lang_String_: - -.. _Credentials_jwt_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials ` :ref:`jwt ` ( - | `String `__ jwtToken - | ) - - - - - * - Creates credentials representing a login using a JWT Token. This token is normally generated after a custom OAuth2 login flow.This provider must be enabled on MongoDB Realm to work. - - - - - - - **Parameters** - - - ``jwtToken`` - the jwt token returned after a custom login to a another service. - - - - - - - - **Returns** - - a set of credentials that can be used to log into MongoDB Realm using :ref:`App.loginAsync(Credentials, App.Callback) ` . - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt b/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt deleted file mode 100644 index 964b4cd064..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/Credentials/Provider.txt +++ /dev/null @@ -1,564 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum Credentials.Provider -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_Credentials_Provider: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.Credentials.Provider - - - - -**Enclosing class:** - -:ref:`Credentials ` - - - -This enum contains the list of identity providers supported by MongoDB Realm. All of these except :ref:`EMAIL_PASSWORD ` must be enabled manually on MongoDB Realm to work. - - - - -.. seealso:: - - - - - `Authentication Providers `__ - - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ANONYMOUS ` - - - - - - - * - :ref:`API_KEY ` - - - - - - - * - :ref:`APPLE ` - - - - - - - * - :ref:`CUSTOM_FUNCTION ` - - - - - - - * - :ref:`EMAIL_PASSWORD ` - - - - - - - * - :ref:`FACEBOOK ` - - - - - - - * - :ref:`GOOGLE ` - - - - - - - * - :ref:`JWT ` - - - - - - - * - :ref:`UNKNOWN ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`Credentials.Provider ` - - | :ref:`fromId ` ( - | `String `__ id - | ) - - - Create the identity provider from the ID string returned by MongoDB Realm. - - - - - * - public `String `__ - - | :ref:`getId ` () - | - - - Return the string presentation of this identity provider. - - - - - * - public static :ref:`Credentials.Provider ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`Credentials.Provider ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_Credentials_Provider_ANONYMOUS: - -.. _Credentials_Provider_ANONYMOUS: - - - -``ANONYMOUS`` --------------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_API_KEY: - -.. _Credentials_Provider_API_KEY: - - - -``API_KEY`` ------------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_APPLE: - -.. _Credentials_Provider_APPLE: - - - -``APPLE`` ----------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_CUSTOM_FUNCTION: - -.. _Credentials_Provider_CUSTOM_FUNCTION: - - - -``CUSTOM_FUNCTION`` --------------------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_EMAIL_PASSWORD: - -.. _Credentials_Provider_EMAIL_PASSWORD: - - - -``EMAIL_PASSWORD`` -------------------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_FACEBOOK: - -.. _Credentials_Provider_FACEBOOK: - - - -``FACEBOOK`` -------------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_GOOGLE: - -.. _Credentials_Provider_GOOGLE: - - - -``GOOGLE`` ------------ - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_JWT: - -.. _Credentials_Provider_JWT: - - - -``JWT`` --------- - -public static final :ref:`Credentials.Provider ` - - - - - -.. _io_realm_mongodb_Credentials_Provider_UNKNOWN: - -.. _Credentials_Provider_UNKNOWN: - - - -``UNKNOWN`` ------------- - -public static final :ref:`Credentials.Provider ` - - - - - - -Method Detail -============= - -.. _fromId: - -.. _fromId__: - -.. _Provider_fromId: - -.. _Provider_fromId__: - -.. _Credentials_Provider_fromId: - -.. _Credentials_Provider_fromId__: - -.. _io_realm_mongodb_Credentials_Provider_fromId: - -.. _io_realm_mongodb_Credentials_Provider_fromId__: - - - -fromId ------- - -.. _io_realm_mongodb_Credentials_Provider_fromId_java_lang_String_: - -.. _io_realm_mongodb_Credentials_Provider_fromId_String_: - -.. _fromId_java_lang_String_: - -.. _fromId_String_: - -.. _Credentials_Provider_fromId_java_lang_String_: - -.. _Credentials_Provider_fromId_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials.Provider ` :ref:`fromId ` ( - | `String `__ id - | ) - - - - - * - Create the identity provider from the ID string returned by MongoDB Realm. - - - - - **Parameters** - - - ``id`` - the string identifier for the provider - - - - - - - - **Returns** - - the enum representing the provider or :ref:`UNKNOWN ` if no matching provider was found. - - - - - - - - - - - - - -.. _getId: - -.. _getId__: - -.. _Provider_getId: - -.. _Provider_getId__: - -.. _Credentials_Provider_getId: - -.. _Credentials_Provider_getId__: - -.. _io_realm_mongodb_Credentials_Provider_getId: - -.. _io_realm_mongodb_Credentials_Provider_getId__: - - - -getId ------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getId ` () - | - - - - - * - Return the string presentation of this identity provider. - - - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _Provider_valueOf: - -.. _Provider_valueOf__: - -.. _Credentials_Provider_valueOf: - -.. _Credentials_Provider_valueOf__: - -.. _io_realm_mongodb_Credentials_Provider_valueOf: - -.. _io_realm_mongodb_Credentials_Provider_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_Credentials_Provider_valueOf_java_lang_String_: - -.. _io_realm_mongodb_Credentials_Provider_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _Credentials_Provider_valueOf_java_lang_String_: - -.. _Credentials_Provider_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials.Provider ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Provider_values: - -.. _Provider_values__: - -.. _Credentials_Provider_values: - -.. _Credentials_Provider_values__: - -.. _io_realm_mongodb_Credentials_Provider_values: - -.. _io_realm_mongodb_Credentials_Provider_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Credentials.Provider ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt deleted file mode 100644 index 41713e0a39..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode.txt +++ /dev/null @@ -1,4754 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum ErrorCode -^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_ErrorCode: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.ErrorCode - - -This class enumerate all potential errors related to using the Object Server or synchronizing data. - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`ErrorCode.Type ` - - - * - ``public static final`` - - :ref:`ErrorCode.Category ` - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ACCOUNT_NAME_IN_USE ` - - - - - - - * - :ref:`API_KEY_ALREADY_EXISTS ` - - - - - - - * - :ref:`API_KEY_NOT_FOUND ` - - - - - - - * - :ref:`ARGUMENTS_NOT_ALLOWED ` - - - - - - - * - :ref:`AUTH_ERROR ` - - - - - - - * - :ref:`AUTH_PROVIDER_ALREADY_EXISTS ` - - - - - - - * - :ref:`AUTH_PROVIDER_DUPLICATE_NAME ` - - - - - - - * - :ref:`AUTH_PROVIDER_NOT_FOUND ` - - - - - - - * - :ref:`AUTO_CLIENT_RESET_FAILURE ` - - - - - - - * - :ref:`AWS_ERROR ` - - - - - - - * - :ref:`BAD_AUTHENTICATION ` - - - - - - - * - :ref:`BAD_CHANGESET ` - - - - - - - * - :ref:`BAD_CHANGESETS ` - - - - - - - * - :ref:`BAD_CHANGESET_HEADER_SYNTAX ` - - - - - - - * - :ref:`BAD_CHANGESET_SIZE ` - - - - - - - * - :ref:`BAD_CLIENT_FILE ` - - - - - - - * - :ref:`BAD_CLIENT_FILE_IDENT ` - - - - - - - * - :ref:`BAD_CLIENT_VERSION ` - - - - - - - * - :ref:`BAD_DECOMPRESSION ` - - - - - - - * - :ref:`BAD_GATEWAY ` - - - - - - - * - :ref:`BAD_MESSAGE_ORDER ` - - - - - - - * - :ref:`BAD_ORIGIN_FILE_IDENT ` - - - - - - - * - :ref:`BAD_QUERY ` - - - - - - - * - :ref:`BAD_REQUEST ` - - - - - - - * - :ref:`BAD_SERVER_FILE_IDENT ` - - - - - - - * - :ref:`BAD_SERVER_VERSION ` - - - - - - - * - :ref:`BAD_SESSION_IDENT ` - - - - - - - * - :ref:`BAD_SYNTAX ` - - - - - - - * - :ref:`BOUND_IN_OTHER_SESSION ` - - - - - - - * - :ref:`BSON_CODEC_NOT_FOUND ` - - - - - - - * - :ref:`BSON_DECODING ` - - - - - - - * - :ref:`BSON_ENCODING ` - - - - - - - * - :ref:`CLIENT_BAD_CHANGESET ` - - - - - - - * - :ref:`CLIENT_BAD_CHANGESET_HEADER_SYNTAX ` - - - - - - - * - :ref:`CLIENT_BAD_CHANGESET_SIZE ` - - - - - - - * - :ref:`CLIENT_BAD_CLIENT_FILE_IDENT ` - - - - - - - * - :ref:`CLIENT_BAD_CLIENT_FILE_IDENT_SALT ` - - - - - - - * - :ref:`CLIENT_BAD_CLIENT_VERSION_DOWNLOAD ` - - - - - - - * - :ref:`CLIENT_BAD_COMPRESSION ` - - - - - - - * - :ref:`CLIENT_BAD_ERROR_CODE ` - - - - - - - * - :ref:`CLIENT_BAD_MESSAGE_ORDER ` - - - - - - - * - :ref:`CLIENT_BAD_OBJECT_ID_SUBSTITUTIONS ` - - - - - - - * - :ref:`CLIENT_BAD_ORIGIN_FILE_IDENT ` - - - - - - - * - :ref:`CLIENT_BAD_PROGRESS ` - - - - - - - * - :ref:`CLIENT_BAD_PROTOCOL_FROM_SERVER ` - - - - - - - * - :ref:`CLIENT_BAD_REQUEST_IDENT ` - - - - - - - * - :ref:`CLIENT_BAD_SERIAL_TRANSACT_STATUS ` - - - - - - - * - :ref:`CLIENT_BAD_SERVER_VERSION ` - - - - - - - * - :ref:`CLIENT_BAD_SESSION_IDENT ` - - - - - - - * - :ref:`CLIENT_BAD_STATE_MESSAGE ` - - - - - - - * - :ref:`CLIENT_BAD_TIMESTAMP ` - - - - - - - * - :ref:`CLIENT_CONNECTION_CLOSED ` - - - - - - - * - :ref:`CLIENT_CONNECT_TIMEOUT ` - - - - - - - * - :ref:`CLIENT_FILE_BLACKLISTED ` - - - - - - - * - :ref:`CLIENT_FILE_EXPIRED ` - - - - - - - * - :ref:`CLIENT_FILE_IDENT ` - - - - - - - * - :ref:`CLIENT_HTTP_TUNNEL_FAILED ` - - - - - - - * - :ref:`CLIENT_LIMITS_EXCEEDED ` - - - - - - - * - :ref:`CLIENT_MISSING_PROTOCOL_FEATURE ` - - - - - - - * - :ref:`CLIENT_PONG_TIMEOUT ` - - - - - - - * - :ref:`CLIENT_PROTOCOL_MISMATCH ` - - - - - - - * - :ref:`CLIENT_RESET ` - - - - - - - * - :ref:`CLIENT_SSL_SERVER_CERT_REJECTED ` - - - - - - - * - :ref:`CLIENT_TOO_NEW_FOR_SERVER ` - - - - - - - * - :ref:`CLIENT_TOO_OLD_FOR_SERVER ` - - - - - - - * - :ref:`CLIENT_UNKNOWN_MESSAGE ` - - - - - - - * - :ref:`CONFLICT ` - - - - - - - * - :ref:`CONNECTION_ADDRESS_IN_USE ` - - - - - - - * - :ref:`CONNECTION_CLOSED ` - - - - - - - * - :ref:`CONNECTION_CONNECTION_ABORTED ` - - - - - - - * - :ref:`CONNECTION_REFUSED ` - - - - - - - * - :ref:`CONNECTION_RESET_BY_PEER ` - - - - - - - * - :ref:`CONNECTION_SOCKET_SHUTDOWN ` - - - - - - - * - :ref:`DISABLED_SESSION ` - - - - - - - * - :ref:`DIVERGING_HISTORIES ` - - - - - - - * - :ref:`DOMAIN_NOT_ALLOWED ` - - - - - - - * - :ref:`EVENT_DESERIALIZING ` - - - - - - - * - :ref:`EXECUTION_TIME_LIMIT_EXCEEDED ` - - - - - - - * - :ref:`EXPECTATION_FAILED ` - - - - - - - * - :ref:`FAILED_DEPENDENCY ` - - - - - - - * - :ref:`FORBIDDEN ` - - - - - - - * - :ref:`FOUND ` - - - - - - - * - :ref:`FUNCTION_ALREADY_EXISTS ` - - - - - - - * - :ref:`FUNCTION_DUPLICATE_NAME ` - - - - - - - * - :ref:`FUNCTION_EXECUTION_ERROR ` - - - - - - - * - :ref:`FUNCTION_INVALID ` - - - - - - - * - :ref:`FUNCTION_NOT_FOUND ` - - - - - - - * - :ref:`FUNCTION_SYNTAX_ERROR ` - - - - - - - * - :ref:`GATEWAY_TIMEOUT ` - - - - - - - * - :ref:`GCM_ERROR ` - - - - - - - * - :ref:`GONE ` - - - - - - - * - :ref:`HTTP_BAD_REQUEST ` - - - - - - - * - :ref:`HTTP_ERROR ` - - - - - - - * - :ref:`HTTP_VERSION_NOT_SUPPORTED ` - - - - - - - * - :ref:`ILLEGAL_REALM_PATH ` - - - - - - - * - :ref:`INCOMING_WEBHOOK_ALREADY_EXISTS ` - - - - - - - * - :ref:`INCOMING_WEBHOOK_AUTH_FAILED ` - - - - - - - * - :ref:`INCOMING_WEBHOOK_DUPLICATE_NAME ` - - - - - - - * - :ref:`INCOMING_WEBHOOK_NOT_FOUND ` - - - - - - - * - :ref:`INITIAL_SYNC_NOT_COMPLETE ` - - - - - - - * - :ref:`INSUFFICIENT_STORAGE ` - - - - - - - * - :ref:`INTERNAL_SERVER_ERROR ` - - - - - - - * - :ref:`INVALID_EMAIL_PASSWORD ` - - - - - - - * - :ref:`INVALID_PARAMETER ` - - - - - - - * - :ref:`INVALID_SCHEMA_CHANGE ` - - - - - - - * - :ref:`INVALID_SESSION ` - - - - - - - * - :ref:`LENGTH_REQUIRED ` - - - - - - - * - :ref:`LIMITS_EXCEEDED ` - - - - - - - * - :ref:`LOCKED ` - - - - - - - * - :ref:`LOOP_DETECTED ` - - - - - - - * - :ref:`METHOD_NOT_ALLOWED ` - - - - - - - * - :ref:`MISC_DELIMITER_NOT_FOUND ` - - - - - - - * - :ref:`MISC_END_OF_INPUT ` - - - - - - - * - :ref:`MISC_PREMATURE_END_OF_INPUT ` - - - - - - - * - :ref:`MISDIRECTED_REQUEST ` - - - - - - - * - :ref:`MISSING_PARAMETER ` - - - - - - - * - :ref:`MONGODB_ERROR ` - - - - - - - * - :ref:`MOVED_PERMANENTLY ` - - - - - - - * - :ref:`MULTIPLE_CHOICES ` - - - - - - - * - :ref:`NETWORK_AUTHENTICATION_REQUIRED ` - - - - - - - * - :ref:`NETWORK_INTERRUPTED ` - - - - - - - * - :ref:`NETWORK_IO_EXCEPTION ` - - - - - - - * - :ref:`NETWORK_UNKNOWN ` - - - - - - - * - :ref:`NOT_ACCEPTABLE ` - - - - - - - * - :ref:`NOT_CALLABLE ` - - - - - - - * - :ref:`NOT_EXTENDED ` - - - - - - - * - :ref:`NOT_FOUND ` - - - - - - - * - :ref:`NOT_IMPLEMENTED ` - - - - - - - * - :ref:`NOT_MODIFIED ` - - - - - - - * - :ref:`NO_MATCHING_RULE_FOUND ` - - - - - - - * - :ref:`NO_SUCH_PATH ` - - - - - - - * - :ref:`OBJECT_ALREADY_EXISTS ` - - - - - - - * - :ref:`OTHER_ERROR ` - - - - - - - * - :ref:`OTHER_SESSION_ERROR ` - - - - - - - * - :ref:`PARTIAL_SYNC_DISABLED ` - - - - - - - * - :ref:`PAYLOAD_TOO_LARGE ` - - - - - - - * - :ref:`PAYMENT_REQUIRED ` - - - - - - - * - :ref:`PERMANENT_REDIRECT ` - - - - - - - * - :ref:`PERMISSION_DENIED ` - - - - - - - * - :ref:`PRECONDITION_FAILED ` - - - - - - - * - :ref:`PRECONDITION_REQUIRED ` - - - - - - - * - :ref:`PROXY_AUTHENTICATION_REQUIRED ` - - - - - - - * - :ref:`RANGE_NOT_SATISFIABLE ` - - - - - - - * - :ref:`READ_SIZE_LIMIT_EXCEEDED ` - - - - - - - * - :ref:`REQUEST_HEADER_FIELDS_TOO_LARGE ` - - - - - - - * - :ref:`REQUEST_TIMEOUT ` - - - - - - - * - :ref:`RESTRICTED_HOST ` - - - - - - - * - :ref:`REUSE_OF_SESSION_IDENT ` - - - - - - - * - :ref:`RULE_ALREADY_EXISTS ` - - - - - - - * - :ref:`RULE_DUPLICATE_NAME ` - - - - - - - * - :ref:`RULE_NOT_FOUND ` - - - - - - - * - :ref:`SEE_OTHER ` - - - - - - - * - :ref:`SERVER_FILE_DELETED ` - - - - - - - * - :ref:`SERVER_PERMISSIONS_CHANGED ` - - - - - - - * - :ref:`SERVICE_ALREADY_EXISTS ` - - - - - - - * - :ref:`SERVICE_COMMAND_NOT_FOUND ` - - - - - - - * - :ref:`SERVICE_INTERNAL_SERVER_ERROR ` - - - - - - - * - :ref:`SERVICE_NONE ` - - - - - - - * - :ref:`SERVICE_NOT_FOUND ` - - - - - - - * - :ref:`SERVICE_TYPE_NOT_FOUND ` - - - - - - - * - :ref:`SERVICE_UNAVAILABLE ` - - - - - - - * - :ref:`SERVICE_UNKNOWN ` - - - - - - - * - :ref:`SESSION_CLOSED ` - - - - - - - * - :ref:`TEMPORARY_REDIRECT ` - - - - - - - * - :ref:`TOKEN_EXPIRED ` - - - - - - - * - :ref:`TOO_MANY_REQUESTS ` - - - - - - - * - :ref:`TOO_MANY_SESSIONS ` - - - - - - - * - :ref:`TRANSACT_BEFORE_UPLOAD ` - - - - - - - * - :ref:`TWILIO_ERROR ` - - - - - - - * - :ref:`UNAUTHORIZED ` - - - - - - - * - :ref:`UNAVAILABLE_FOR_LEGAL_REASONS ` - - - - - - - * - :ref:`UNKNOWN ` - - - - - - - * - :ref:`UNKNOWN_MESSAGE ` - - - - - - - * - :ref:`UNPROCESSABLE_ENTITY ` - - - - - - - * - :ref:`UNSUPPORTED_MEDIA_TYPE ` - - - - - - - * - :ref:`UNSUPPORTED_SESSION_FEATURE ` - - - - - - - * - :ref:`UPGRADE_REQUIRED ` - - - - - - - * - :ref:`URI_TOO_LONG ` - - - - - - - * - :ref:`USER_ALREADY_CONFIRMED ` - - - - - - - * - :ref:`USER_APP_DOMAIN_MISMATCH ` - - - - - - - * - :ref:`USER_BLACKLISTED ` - - - - - - - * - :ref:`USER_DISABLED ` - - - - - - - * - :ref:`USER_MISMATCH ` - - - - - - - * - :ref:`USER_NOT_FOUND ` - - - - - - - * - :ref:`USE_PROXY ` - - - - - - - * - :ref:`VALUE_ALREADY_EXISTS ` - - - - - - - * - :ref:`VALUE_DUPLICATE_NAME ` - - - - - - - * - :ref:`VALUE_NOT_FOUND ` - - - - - - - * - :ref:`VARIANT_ALSO_NEGOTIATES ` - - - - - - - * - :ref:`WRITE_NOT_ALLOWED ` - - - - - - - * - :ref:`WRONG_PROTOCOL_VERSION ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`ErrorCode ` - - | :ref:`fromNativeError ` ( - | `String `__ type, - | **int** errorCode - | ) - - - Converts a native error to the appropriate Java equivalent - - - - - * - public :ref:`ErrorCode.Category ` - - | :ref:`getCategory ` () - | - - - Returns the getCategory of the error. - - - - - * - public `String `__ - - | :ref:`getType ` () - | - - - Returns the type of error. - - - - - * - public **int** - - | :ref:`intValue ` () - | - - - Returns the numerical value for this error code. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - * - public static :ref:`ErrorCode ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`ErrorCode ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_ErrorCode_ACCOUNT_NAME_IN_USE: - -.. _ErrorCode_ACCOUNT_NAME_IN_USE: - - - -``ACCOUNT_NAME_IN_USE`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_API_KEY_ALREADY_EXISTS: - -.. _ErrorCode_API_KEY_ALREADY_EXISTS: - - - -``API_KEY_ALREADY_EXISTS`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_API_KEY_NOT_FOUND: - -.. _ErrorCode_API_KEY_NOT_FOUND: - - - -``API_KEY_NOT_FOUND`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_ARGUMENTS_NOT_ALLOWED: - -.. _ErrorCode_ARGUMENTS_NOT_ALLOWED: - - - -``ARGUMENTS_NOT_ALLOWED`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AUTH_ERROR: - -.. _ErrorCode_AUTH_ERROR: - - - -``AUTH_ERROR`` ---------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AUTH_PROVIDER_ALREADY_EXISTS: - -.. _ErrorCode_AUTH_PROVIDER_ALREADY_EXISTS: - - - -``AUTH_PROVIDER_ALREADY_EXISTS`` ---------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AUTH_PROVIDER_DUPLICATE_NAME: - -.. _ErrorCode_AUTH_PROVIDER_DUPLICATE_NAME: - - - -``AUTH_PROVIDER_DUPLICATE_NAME`` ---------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AUTH_PROVIDER_NOT_FOUND: - -.. _ErrorCode_AUTH_PROVIDER_NOT_FOUND: - - - -``AUTH_PROVIDER_NOT_FOUND`` ----------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AUTO_CLIENT_RESET_FAILURE: - -.. _ErrorCode_AUTO_CLIENT_RESET_FAILURE: - - - -``AUTO_CLIENT_RESET_FAILURE`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_AWS_ERROR: - -.. _ErrorCode_AWS_ERROR: - - - -``AWS_ERROR`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_AUTHENTICATION: - -.. _ErrorCode_BAD_AUTHENTICATION: - - - -``BAD_AUTHENTICATION`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CHANGESET: - -.. _ErrorCode_BAD_CHANGESET: - - - -``BAD_CHANGESET`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CHANGESETS: - -.. _ErrorCode_BAD_CHANGESETS: - - - -``BAD_CHANGESETS`` -------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CHANGESET_HEADER_SYNTAX: - -.. _ErrorCode_BAD_CHANGESET_HEADER_SYNTAX: - - - -``BAD_CHANGESET_HEADER_SYNTAX`` --------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CHANGESET_SIZE: - -.. _ErrorCode_BAD_CHANGESET_SIZE: - - - -``BAD_CHANGESET_SIZE`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CLIENT_FILE: - -.. _ErrorCode_BAD_CLIENT_FILE: - - - -``BAD_CLIENT_FILE`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CLIENT_FILE_IDENT: - -.. _ErrorCode_BAD_CLIENT_FILE_IDENT: - - - -``BAD_CLIENT_FILE_IDENT`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_CLIENT_VERSION: - -.. _ErrorCode_BAD_CLIENT_VERSION: - - - -``BAD_CLIENT_VERSION`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_DECOMPRESSION: - -.. _ErrorCode_BAD_DECOMPRESSION: - - - -``BAD_DECOMPRESSION`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_GATEWAY: - -.. _ErrorCode_BAD_GATEWAY: - - - -``BAD_GATEWAY`` ----------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_MESSAGE_ORDER: - -.. _ErrorCode_BAD_MESSAGE_ORDER: - - - -``BAD_MESSAGE_ORDER`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_ORIGIN_FILE_IDENT: - -.. _ErrorCode_BAD_ORIGIN_FILE_IDENT: - - - -``BAD_ORIGIN_FILE_IDENT`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_QUERY: - -.. _ErrorCode_BAD_QUERY: - - - -``BAD_QUERY`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_REQUEST: - -.. _ErrorCode_BAD_REQUEST: - - - -``BAD_REQUEST`` ----------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_SERVER_FILE_IDENT: - -.. _ErrorCode_BAD_SERVER_FILE_IDENT: - - - -``BAD_SERVER_FILE_IDENT`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_SERVER_VERSION: - -.. _ErrorCode_BAD_SERVER_VERSION: - - - -``BAD_SERVER_VERSION`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_SESSION_IDENT: - -.. _ErrorCode_BAD_SESSION_IDENT: - - - -``BAD_SESSION_IDENT`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BAD_SYNTAX: - -.. _ErrorCode_BAD_SYNTAX: - - - -``BAD_SYNTAX`` ---------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BOUND_IN_OTHER_SESSION: - -.. _ErrorCode_BOUND_IN_OTHER_SESSION: - - - -``BOUND_IN_OTHER_SESSION`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BSON_CODEC_NOT_FOUND: - -.. _ErrorCode_BSON_CODEC_NOT_FOUND: - - - -``BSON_CODEC_NOT_FOUND`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BSON_DECODING: - -.. _ErrorCode_BSON_DECODING: - - - -``BSON_DECODING`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_BSON_ENCODING: - -.. _ErrorCode_BSON_ENCODING: - - - -``BSON_ENCODING`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CHANGESET: - -.. _ErrorCode_CLIENT_BAD_CHANGESET: - - - -``CLIENT_BAD_CHANGESET`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CHANGESET_HEADER_SYNTAX: - -.. _ErrorCode_CLIENT_BAD_CHANGESET_HEADER_SYNTAX: - - - -``CLIENT_BAD_CHANGESET_HEADER_SYNTAX`` ---------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CHANGESET_SIZE: - -.. _ErrorCode_CLIENT_BAD_CHANGESET_SIZE: - - - -``CLIENT_BAD_CHANGESET_SIZE`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CLIENT_FILE_IDENT: - -.. _ErrorCode_CLIENT_BAD_CLIENT_FILE_IDENT: - - - -``CLIENT_BAD_CLIENT_FILE_IDENT`` ---------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CLIENT_FILE_IDENT_SALT: - -.. _ErrorCode_CLIENT_BAD_CLIENT_FILE_IDENT_SALT: - - - -``CLIENT_BAD_CLIENT_FILE_IDENT_SALT`` --------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_CLIENT_VERSION_DOWNLOAD: - -.. _ErrorCode_CLIENT_BAD_CLIENT_VERSION_DOWNLOAD: - - - -``CLIENT_BAD_CLIENT_VERSION_DOWNLOAD`` ---------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_COMPRESSION: - -.. _ErrorCode_CLIENT_BAD_COMPRESSION: - - - -``CLIENT_BAD_COMPRESSION`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_ERROR_CODE: - -.. _ErrorCode_CLIENT_BAD_ERROR_CODE: - - - -``CLIENT_BAD_ERROR_CODE`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_MESSAGE_ORDER: - -.. _ErrorCode_CLIENT_BAD_MESSAGE_ORDER: - - - -``CLIENT_BAD_MESSAGE_ORDER`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_OBJECT_ID_SUBSTITUTIONS: - -.. _ErrorCode_CLIENT_BAD_OBJECT_ID_SUBSTITUTIONS: - - - -``CLIENT_BAD_OBJECT_ID_SUBSTITUTIONS`` ---------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_ORIGIN_FILE_IDENT: - -.. _ErrorCode_CLIENT_BAD_ORIGIN_FILE_IDENT: - - - -``CLIENT_BAD_ORIGIN_FILE_IDENT`` ---------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_PROGRESS: - -.. _ErrorCode_CLIENT_BAD_PROGRESS: - - - -``CLIENT_BAD_PROGRESS`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_PROTOCOL_FROM_SERVER: - -.. _ErrorCode_CLIENT_BAD_PROTOCOL_FROM_SERVER: - - - -``CLIENT_BAD_PROTOCOL_FROM_SERVER`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_REQUEST_IDENT: - -.. _ErrorCode_CLIENT_BAD_REQUEST_IDENT: - - - -``CLIENT_BAD_REQUEST_IDENT`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_SERIAL_TRANSACT_STATUS: - -.. _ErrorCode_CLIENT_BAD_SERIAL_TRANSACT_STATUS: - - - -``CLIENT_BAD_SERIAL_TRANSACT_STATUS`` --------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_SERVER_VERSION: - -.. _ErrorCode_CLIENT_BAD_SERVER_VERSION: - - - -``CLIENT_BAD_SERVER_VERSION`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_SESSION_IDENT: - -.. _ErrorCode_CLIENT_BAD_SESSION_IDENT: - - - -``CLIENT_BAD_SESSION_IDENT`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_STATE_MESSAGE: - -.. _ErrorCode_CLIENT_BAD_STATE_MESSAGE: - - - -``CLIENT_BAD_STATE_MESSAGE`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_BAD_TIMESTAMP: - -.. _ErrorCode_CLIENT_BAD_TIMESTAMP: - - - -``CLIENT_BAD_TIMESTAMP`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_CONNECTION_CLOSED: - -.. _ErrorCode_CLIENT_CONNECTION_CLOSED: - - - -``CLIENT_CONNECTION_CLOSED`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_CONNECT_TIMEOUT: - -.. _ErrorCode_CLIENT_CONNECT_TIMEOUT: - - - -``CLIENT_CONNECT_TIMEOUT`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_FILE_BLACKLISTED: - -.. _ErrorCode_CLIENT_FILE_BLACKLISTED: - - - -``CLIENT_FILE_BLACKLISTED`` ----------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_FILE_EXPIRED: - -.. _ErrorCode_CLIENT_FILE_EXPIRED: - - - -``CLIENT_FILE_EXPIRED`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_FILE_IDENT: - -.. _ErrorCode_CLIENT_FILE_IDENT: - - - -``CLIENT_FILE_IDENT`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_HTTP_TUNNEL_FAILED: - -.. _ErrorCode_CLIENT_HTTP_TUNNEL_FAILED: - - - -``CLIENT_HTTP_TUNNEL_FAILED`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_LIMITS_EXCEEDED: - -.. _ErrorCode_CLIENT_LIMITS_EXCEEDED: - - - -``CLIENT_LIMITS_EXCEEDED`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_MISSING_PROTOCOL_FEATURE: - -.. _ErrorCode_CLIENT_MISSING_PROTOCOL_FEATURE: - - - -``CLIENT_MISSING_PROTOCOL_FEATURE`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_PONG_TIMEOUT: - -.. _ErrorCode_CLIENT_PONG_TIMEOUT: - - - -``CLIENT_PONG_TIMEOUT`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_PROTOCOL_MISMATCH: - -.. _ErrorCode_CLIENT_PROTOCOL_MISMATCH: - - - -``CLIENT_PROTOCOL_MISMATCH`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_RESET: - -.. _ErrorCode_CLIENT_RESET: - - - -``CLIENT_RESET`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_SSL_SERVER_CERT_REJECTED: - -.. _ErrorCode_CLIENT_SSL_SERVER_CERT_REJECTED: - - - -``CLIENT_SSL_SERVER_CERT_REJECTED`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_TOO_NEW_FOR_SERVER: - -.. _ErrorCode_CLIENT_TOO_NEW_FOR_SERVER: - - - -``CLIENT_TOO_NEW_FOR_SERVER`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_TOO_OLD_FOR_SERVER: - -.. _ErrorCode_CLIENT_TOO_OLD_FOR_SERVER: - - - -``CLIENT_TOO_OLD_FOR_SERVER`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CLIENT_UNKNOWN_MESSAGE: - -.. _ErrorCode_CLIENT_UNKNOWN_MESSAGE: - - - -``CLIENT_UNKNOWN_MESSAGE`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONFLICT: - -.. _ErrorCode_CONFLICT: - - - -``CONFLICT`` -------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_ADDRESS_IN_USE: - -.. _ErrorCode_CONNECTION_ADDRESS_IN_USE: - - - -``CONNECTION_ADDRESS_IN_USE`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_CLOSED: - -.. _ErrorCode_CONNECTION_CLOSED: - - - -``CONNECTION_CLOSED`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_CONNECTION_ABORTED: - -.. _ErrorCode_CONNECTION_CONNECTION_ABORTED: - - - -``CONNECTION_CONNECTION_ABORTED`` ----------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_REFUSED: - -.. _ErrorCode_CONNECTION_REFUSED: - - - -``CONNECTION_REFUSED`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_RESET_BY_PEER: - -.. _ErrorCode_CONNECTION_RESET_BY_PEER: - - - -``CONNECTION_RESET_BY_PEER`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_CONNECTION_SOCKET_SHUTDOWN: - -.. _ErrorCode_CONNECTION_SOCKET_SHUTDOWN: - - - -``CONNECTION_SOCKET_SHUTDOWN`` -------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_DISABLED_SESSION: - -.. _ErrorCode_DISABLED_SESSION: - - - -``DISABLED_SESSION`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_DIVERGING_HISTORIES: - -.. _ErrorCode_DIVERGING_HISTORIES: - - - -``DIVERGING_HISTORIES`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_DOMAIN_NOT_ALLOWED: - -.. _ErrorCode_DOMAIN_NOT_ALLOWED: - - - -``DOMAIN_NOT_ALLOWED`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_EVENT_DESERIALIZING: - -.. _ErrorCode_EVENT_DESERIALIZING: - - - -``EVENT_DESERIALIZING`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_EXECUTION_TIME_LIMIT_EXCEEDED: - -.. _ErrorCode_EXECUTION_TIME_LIMIT_EXCEEDED: - - - -``EXECUTION_TIME_LIMIT_EXCEEDED`` ----------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_EXPECTATION_FAILED: - -.. _ErrorCode_EXPECTATION_FAILED: - - - -``EXPECTATION_FAILED`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FAILED_DEPENDENCY: - -.. _ErrorCode_FAILED_DEPENDENCY: - - - -``FAILED_DEPENDENCY`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FORBIDDEN: - -.. _ErrorCode_FORBIDDEN: - - - -``FORBIDDEN`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FOUND: - -.. _ErrorCode_FOUND: - - - -``FOUND`` ----------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_ALREADY_EXISTS: - -.. _ErrorCode_FUNCTION_ALREADY_EXISTS: - - - -``FUNCTION_ALREADY_EXISTS`` ----------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_DUPLICATE_NAME: - -.. _ErrorCode_FUNCTION_DUPLICATE_NAME: - - - -``FUNCTION_DUPLICATE_NAME`` ----------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_EXECUTION_ERROR: - -.. _ErrorCode_FUNCTION_EXECUTION_ERROR: - - - -``FUNCTION_EXECUTION_ERROR`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_INVALID: - -.. _ErrorCode_FUNCTION_INVALID: - - - -``FUNCTION_INVALID`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_NOT_FOUND: - -.. _ErrorCode_FUNCTION_NOT_FOUND: - - - -``FUNCTION_NOT_FOUND`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_FUNCTION_SYNTAX_ERROR: - -.. _ErrorCode_FUNCTION_SYNTAX_ERROR: - - - -``FUNCTION_SYNTAX_ERROR`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_GATEWAY_TIMEOUT: - -.. _ErrorCode_GATEWAY_TIMEOUT: - - - -``GATEWAY_TIMEOUT`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_GCM_ERROR: - -.. _ErrorCode_GCM_ERROR: - - - -``GCM_ERROR`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_GONE: - -.. _ErrorCode_GONE: - - - -``GONE`` ---------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_HTTP_BAD_REQUEST: - -.. _ErrorCode_HTTP_BAD_REQUEST: - - - -``HTTP_BAD_REQUEST`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_HTTP_ERROR: - -.. _ErrorCode_HTTP_ERROR: - - - -``HTTP_ERROR`` ---------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_HTTP_VERSION_NOT_SUPPORTED: - -.. _ErrorCode_HTTP_VERSION_NOT_SUPPORTED: - - - -``HTTP_VERSION_NOT_SUPPORTED`` -------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_ILLEGAL_REALM_PATH: - -.. _ErrorCode_ILLEGAL_REALM_PATH: - - - -``ILLEGAL_REALM_PATH`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INCOMING_WEBHOOK_ALREADY_EXISTS: - -.. _ErrorCode_INCOMING_WEBHOOK_ALREADY_EXISTS: - - - -``INCOMING_WEBHOOK_ALREADY_EXISTS`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INCOMING_WEBHOOK_AUTH_FAILED: - -.. _ErrorCode_INCOMING_WEBHOOK_AUTH_FAILED: - - - -``INCOMING_WEBHOOK_AUTH_FAILED`` ---------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INCOMING_WEBHOOK_DUPLICATE_NAME: - -.. _ErrorCode_INCOMING_WEBHOOK_DUPLICATE_NAME: - - - -``INCOMING_WEBHOOK_DUPLICATE_NAME`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INCOMING_WEBHOOK_NOT_FOUND: - -.. _ErrorCode_INCOMING_WEBHOOK_NOT_FOUND: - - - -``INCOMING_WEBHOOK_NOT_FOUND`` -------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INITIAL_SYNC_NOT_COMPLETE: - -.. _ErrorCode_INITIAL_SYNC_NOT_COMPLETE: - - - -``INITIAL_SYNC_NOT_COMPLETE`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INSUFFICIENT_STORAGE: - -.. _ErrorCode_INSUFFICIENT_STORAGE: - - - -``INSUFFICIENT_STORAGE`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INTERNAL_SERVER_ERROR: - -.. _ErrorCode_INTERNAL_SERVER_ERROR: - - - -``INTERNAL_SERVER_ERROR`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INVALID_EMAIL_PASSWORD: - -.. _ErrorCode_INVALID_EMAIL_PASSWORD: - - - -``INVALID_EMAIL_PASSWORD`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INVALID_PARAMETER: - -.. _ErrorCode_INVALID_PARAMETER: - - - -``INVALID_PARAMETER`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INVALID_SCHEMA_CHANGE: - -.. _ErrorCode_INVALID_SCHEMA_CHANGE: - - - -``INVALID_SCHEMA_CHANGE`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_INVALID_SESSION: - -.. _ErrorCode_INVALID_SESSION: - - - -``INVALID_SESSION`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_LENGTH_REQUIRED: - -.. _ErrorCode_LENGTH_REQUIRED: - - - -``LENGTH_REQUIRED`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_LIMITS_EXCEEDED: - -.. _ErrorCode_LIMITS_EXCEEDED: - - - -``LIMITS_EXCEEDED`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_LOCKED: - -.. _ErrorCode_LOCKED: - - - -``LOCKED`` ------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_LOOP_DETECTED: - -.. _ErrorCode_LOOP_DETECTED: - - - -``LOOP_DETECTED`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_METHOD_NOT_ALLOWED: - -.. _ErrorCode_METHOD_NOT_ALLOWED: - - - -``METHOD_NOT_ALLOWED`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MISC_DELIMITER_NOT_FOUND: - -.. _ErrorCode_MISC_DELIMITER_NOT_FOUND: - - - -``MISC_DELIMITER_NOT_FOUND`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MISC_END_OF_INPUT: - -.. _ErrorCode_MISC_END_OF_INPUT: - - - -``MISC_END_OF_INPUT`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MISC_PREMATURE_END_OF_INPUT: - -.. _ErrorCode_MISC_PREMATURE_END_OF_INPUT: - - - -``MISC_PREMATURE_END_OF_INPUT`` --------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MISDIRECTED_REQUEST: - -.. _ErrorCode_MISDIRECTED_REQUEST: - - - -``MISDIRECTED_REQUEST`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MISSING_PARAMETER: - -.. _ErrorCode_MISSING_PARAMETER: - - - -``MISSING_PARAMETER`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MONGODB_ERROR: - -.. _ErrorCode_MONGODB_ERROR: - - - -``MONGODB_ERROR`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MOVED_PERMANENTLY: - -.. _ErrorCode_MOVED_PERMANENTLY: - - - -``MOVED_PERMANENTLY`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_MULTIPLE_CHOICES: - -.. _ErrorCode_MULTIPLE_CHOICES: - - - -``MULTIPLE_CHOICES`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NETWORK_AUTHENTICATION_REQUIRED: - -.. _ErrorCode_NETWORK_AUTHENTICATION_REQUIRED: - - - -``NETWORK_AUTHENTICATION_REQUIRED`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NETWORK_INTERRUPTED: - -.. _ErrorCode_NETWORK_INTERRUPTED: - - - -``NETWORK_INTERRUPTED`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NETWORK_IO_EXCEPTION: - -.. _ErrorCode_NETWORK_IO_EXCEPTION: - - - -``NETWORK_IO_EXCEPTION`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NETWORK_UNKNOWN: - -.. _ErrorCode_NETWORK_UNKNOWN: - - - -``NETWORK_UNKNOWN`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_ACCEPTABLE: - -.. _ErrorCode_NOT_ACCEPTABLE: - - - -``NOT_ACCEPTABLE`` -------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_CALLABLE: - -.. _ErrorCode_NOT_CALLABLE: - - - -``NOT_CALLABLE`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_EXTENDED: - -.. _ErrorCode_NOT_EXTENDED: - - - -``NOT_EXTENDED`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_FOUND: - -.. _ErrorCode_NOT_FOUND: - - - -``NOT_FOUND`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_IMPLEMENTED: - -.. _ErrorCode_NOT_IMPLEMENTED: - - - -``NOT_IMPLEMENTED`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NOT_MODIFIED: - -.. _ErrorCode_NOT_MODIFIED: - - - -``NOT_MODIFIED`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NO_MATCHING_RULE_FOUND: - -.. _ErrorCode_NO_MATCHING_RULE_FOUND: - - - -``NO_MATCHING_RULE_FOUND`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_NO_SUCH_PATH: - -.. _ErrorCode_NO_SUCH_PATH: - - - -``NO_SUCH_PATH`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_OBJECT_ALREADY_EXISTS: - -.. _ErrorCode_OBJECT_ALREADY_EXISTS: - - - -``OBJECT_ALREADY_EXISTS`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_OTHER_ERROR: - -.. _ErrorCode_OTHER_ERROR: - - - -``OTHER_ERROR`` ----------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_OTHER_SESSION_ERROR: - -.. _ErrorCode_OTHER_SESSION_ERROR: - - - -``OTHER_SESSION_ERROR`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PARTIAL_SYNC_DISABLED: - -.. _ErrorCode_PARTIAL_SYNC_DISABLED: - - - -``PARTIAL_SYNC_DISABLED`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PAYLOAD_TOO_LARGE: - -.. _ErrorCode_PAYLOAD_TOO_LARGE: - - - -``PAYLOAD_TOO_LARGE`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PAYMENT_REQUIRED: - -.. _ErrorCode_PAYMENT_REQUIRED: - - - -``PAYMENT_REQUIRED`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PERMANENT_REDIRECT: - -.. _ErrorCode_PERMANENT_REDIRECT: - - - -``PERMANENT_REDIRECT`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PERMISSION_DENIED: - -.. _ErrorCode_PERMISSION_DENIED: - - - -``PERMISSION_DENIED`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PRECONDITION_FAILED: - -.. _ErrorCode_PRECONDITION_FAILED: - - - -``PRECONDITION_FAILED`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PRECONDITION_REQUIRED: - -.. _ErrorCode_PRECONDITION_REQUIRED: - - - -``PRECONDITION_REQUIRED`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_PROXY_AUTHENTICATION_REQUIRED: - -.. _ErrorCode_PROXY_AUTHENTICATION_REQUIRED: - - - -``PROXY_AUTHENTICATION_REQUIRED`` ----------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_RANGE_NOT_SATISFIABLE: - -.. _ErrorCode_RANGE_NOT_SATISFIABLE: - - - -``RANGE_NOT_SATISFIABLE`` --------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_READ_SIZE_LIMIT_EXCEEDED: - -.. _ErrorCode_READ_SIZE_LIMIT_EXCEEDED: - - - -``READ_SIZE_LIMIT_EXCEEDED`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_REQUEST_HEADER_FIELDS_TOO_LARGE: - -.. _ErrorCode_REQUEST_HEADER_FIELDS_TOO_LARGE: - - - -``REQUEST_HEADER_FIELDS_TOO_LARGE`` ------------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_REQUEST_TIMEOUT: - -.. _ErrorCode_REQUEST_TIMEOUT: - - - -``REQUEST_TIMEOUT`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_RESTRICTED_HOST: - -.. _ErrorCode_RESTRICTED_HOST: - - - -``RESTRICTED_HOST`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_REUSE_OF_SESSION_IDENT: - -.. _ErrorCode_REUSE_OF_SESSION_IDENT: - - - -``REUSE_OF_SESSION_IDENT`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_RULE_ALREADY_EXISTS: - -.. _ErrorCode_RULE_ALREADY_EXISTS: - - - -``RULE_ALREADY_EXISTS`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_RULE_DUPLICATE_NAME: - -.. _ErrorCode_RULE_DUPLICATE_NAME: - - - -``RULE_DUPLICATE_NAME`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_RULE_NOT_FOUND: - -.. _ErrorCode_RULE_NOT_FOUND: - - - -``RULE_NOT_FOUND`` -------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SEE_OTHER: - -.. _ErrorCode_SEE_OTHER: - - - -``SEE_OTHER`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVER_FILE_DELETED: - -.. _ErrorCode_SERVER_FILE_DELETED: - - - -``SERVER_FILE_DELETED`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVER_PERMISSIONS_CHANGED: - -.. _ErrorCode_SERVER_PERMISSIONS_CHANGED: - - - -``SERVER_PERMISSIONS_CHANGED`` -------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_ALREADY_EXISTS: - -.. _ErrorCode_SERVICE_ALREADY_EXISTS: - - - -``SERVICE_ALREADY_EXISTS`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_COMMAND_NOT_FOUND: - -.. _ErrorCode_SERVICE_COMMAND_NOT_FOUND: - - - -``SERVICE_COMMAND_NOT_FOUND`` ------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_INTERNAL_SERVER_ERROR: - -.. _ErrorCode_SERVICE_INTERNAL_SERVER_ERROR: - - - -``SERVICE_INTERNAL_SERVER_ERROR`` ----------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_NONE: - -.. _ErrorCode_SERVICE_NONE: - - - -``SERVICE_NONE`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_NOT_FOUND: - -.. _ErrorCode_SERVICE_NOT_FOUND: - - - -``SERVICE_NOT_FOUND`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_TYPE_NOT_FOUND: - -.. _ErrorCode_SERVICE_TYPE_NOT_FOUND: - - - -``SERVICE_TYPE_NOT_FOUND`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_UNAVAILABLE: - -.. _ErrorCode_SERVICE_UNAVAILABLE: - - - -``SERVICE_UNAVAILABLE`` ------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SERVICE_UNKNOWN: - -.. _ErrorCode_SERVICE_UNKNOWN: - - - -``SERVICE_UNKNOWN`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_SESSION_CLOSED: - -.. _ErrorCode_SESSION_CLOSED: - - - -``SESSION_CLOSED`` -------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TEMPORARY_REDIRECT: - -.. _ErrorCode_TEMPORARY_REDIRECT: - - - -``TEMPORARY_REDIRECT`` ------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TOKEN_EXPIRED: - -.. _ErrorCode_TOKEN_EXPIRED: - - - -``TOKEN_EXPIRED`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TOO_MANY_REQUESTS: - -.. _ErrorCode_TOO_MANY_REQUESTS: - - - -``TOO_MANY_REQUESTS`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TOO_MANY_SESSIONS: - -.. _ErrorCode_TOO_MANY_SESSIONS: - - - -``TOO_MANY_SESSIONS`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TRANSACT_BEFORE_UPLOAD: - -.. _ErrorCode_TRANSACT_BEFORE_UPLOAD: - - - -``TRANSACT_BEFORE_UPLOAD`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_TWILIO_ERROR: - -.. _ErrorCode_TWILIO_ERROR: - - - -``TWILIO_ERROR`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNAUTHORIZED: - -.. _ErrorCode_UNAUTHORIZED: - - - -``UNAUTHORIZED`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNAVAILABLE_FOR_LEGAL_REASONS: - -.. _ErrorCode_UNAVAILABLE_FOR_LEGAL_REASONS: - - - -``UNAVAILABLE_FOR_LEGAL_REASONS`` ----------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNKNOWN: - -.. _ErrorCode_UNKNOWN: - - - -``UNKNOWN`` ------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNKNOWN_MESSAGE: - -.. _ErrorCode_UNKNOWN_MESSAGE: - - - -``UNKNOWN_MESSAGE`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNPROCESSABLE_ENTITY: - -.. _ErrorCode_UNPROCESSABLE_ENTITY: - - - -``UNPROCESSABLE_ENTITY`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNSUPPORTED_MEDIA_TYPE: - -.. _ErrorCode_UNSUPPORTED_MEDIA_TYPE: - - - -``UNSUPPORTED_MEDIA_TYPE`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UNSUPPORTED_SESSION_FEATURE: - -.. _ErrorCode_UNSUPPORTED_SESSION_FEATURE: - - - -``UNSUPPORTED_SESSION_FEATURE`` --------------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_UPGRADE_REQUIRED: - -.. _ErrorCode_UPGRADE_REQUIRED: - - - -``UPGRADE_REQUIRED`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_URI_TOO_LONG: - -.. _ErrorCode_URI_TOO_LONG: - - - -``URI_TOO_LONG`` ------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_ALREADY_CONFIRMED: - -.. _ErrorCode_USER_ALREADY_CONFIRMED: - - - -``USER_ALREADY_CONFIRMED`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_APP_DOMAIN_MISMATCH: - -.. _ErrorCode_USER_APP_DOMAIN_MISMATCH: - - - -``USER_APP_DOMAIN_MISMATCH`` ------------------------------ - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_BLACKLISTED: - -.. _ErrorCode_USER_BLACKLISTED: - - - -``USER_BLACKLISTED`` ---------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_DISABLED: - -.. _ErrorCode_USER_DISABLED: - - - -``USER_DISABLED`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_MISMATCH: - -.. _ErrorCode_USER_MISMATCH: - - - -``USER_MISMATCH`` ------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USER_NOT_FOUND: - -.. _ErrorCode_USER_NOT_FOUND: - - - -``USER_NOT_FOUND`` -------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_USE_PROXY: - -.. _ErrorCode_USE_PROXY: - - - -``USE_PROXY`` --------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_VALUE_ALREADY_EXISTS: - -.. _ErrorCode_VALUE_ALREADY_EXISTS: - - - -``VALUE_ALREADY_EXISTS`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_VALUE_DUPLICATE_NAME: - -.. _ErrorCode_VALUE_DUPLICATE_NAME: - - - -``VALUE_DUPLICATE_NAME`` -------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_VALUE_NOT_FOUND: - -.. _ErrorCode_VALUE_NOT_FOUND: - - - -``VALUE_NOT_FOUND`` --------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_VARIANT_ALSO_NEGOTIATES: - -.. _ErrorCode_VARIANT_ALSO_NEGOTIATES: - - - -``VARIANT_ALSO_NEGOTIATES`` ----------------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_WRITE_NOT_ALLOWED: - -.. _ErrorCode_WRITE_NOT_ALLOWED: - - - -``WRITE_NOT_ALLOWED`` ----------------------- - -public static final :ref:`ErrorCode ` - - - - - -.. _io_realm_mongodb_ErrorCode_WRONG_PROTOCOL_VERSION: - -.. _ErrorCode_WRONG_PROTOCOL_VERSION: - - - -``WRONG_PROTOCOL_VERSION`` ---------------------------- - -public static final :ref:`ErrorCode ` - - - - - - -Method Detail -============= - -.. _fromNativeError: - -.. _fromNativeError__: - -.. _ErrorCode_fromNativeError: - -.. _ErrorCode_fromNativeError__: - -.. _io_realm_mongodb_ErrorCode_fromNativeError: - -.. _io_realm_mongodb_ErrorCode_fromNativeError__: - - - -fromNativeError ---------------- - -.. _io_realm_mongodb_ErrorCode_fromNativeError_java_lang_String_int_: - -.. _io_realm_mongodb_ErrorCode_fromNativeError_java_lang_String__int_: - -.. _io_realm_mongodb_ErrorCode_fromNativeError_String_int_: - -.. _io_realm_mongodb_ErrorCode_fromNativeError_String__int_: - -.. _fromNativeError_java_lang_String_int_: - -.. _fromNativeError_java_lang_String__int_: - -.. _fromNativeError_String_int_: - -.. _fromNativeError_String__int_: - -.. _ErrorCode_fromNativeError_java_lang_String_int_: - -.. _ErrorCode_fromNativeError_java_lang_String__int_: - -.. _ErrorCode_fromNativeError_String_int_: - -.. _ErrorCode_fromNativeError_String__int_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ErrorCode ` :ref:`fromNativeError ` ( - | `String `__ type, - | **int** errorCode - | ) - - - - - * - Converts a native error to the appropriate Java equivalent - - - - - **Parameters** - - - ``type`` - type of error. This is normally the C++ category. - - - - - ``errorCode`` - specific code within the type - - - - - - - - **Returns** - - the Java error representing the native error. This method will never throw, so in case a Java error does not exists. :ref:`UNKNOWN ` will be returned. - - - - - - - - - - - - - -.. _getCategory: - -.. _getCategory__: - -.. _ErrorCode_getCategory: - -.. _ErrorCode_getCategory__: - -.. _io_realm_mongodb_ErrorCode_getCategory: - -.. _io_realm_mongodb_ErrorCode_getCategory__: - - - -getCategory ------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ErrorCode.Category ` :ref:`getCategory ` () - | - - - - - * - Returns the getCategory of the error.Errors come in 2 categories: FATAL, RECOVERABLE - - FATAL: The session cannot be recovered and needs to be re-created. A likely cause is that the User does not have access to this Realm. Check that the :ref:`SyncConfiguration ` is correct. - - - - RECOVERABLE: Temporary error. The session will automatically try to recover as soon as possible. - - - - - - - - - **Returns** - - the severity of the error. - - - - - - - - - - - -.. _getType: - -.. _getType__: - -.. _ErrorCode_getType: - -.. _ErrorCode_getType__: - -.. _io_realm_mongodb_ErrorCode_getType: - -.. _io_realm_mongodb_ErrorCode_getType__: - - - -getType -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getType ` () - | - - - - - * - Returns the type of error. Note that an error is only uniquely identified by the ``(type:value)`` pair. - - - - - - - - - **Returns** - - the type of error. - - - - - - - - - - - -.. _intValue: - -.. _intValue__: - -.. _ErrorCode_intValue: - -.. _ErrorCode_intValue__: - -.. _io_realm_mongodb_ErrorCode_intValue: - -.. _io_realm_mongodb_ErrorCode_intValue__: - - - -intValue --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`intValue ` () - | - - - - - * - Returns the numerical value for this error code. Note that an error is only uniquely identified by the ``(type:value)`` pair. - - - - - - - - - **Returns** - - the error code as an unique ``int`` value. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _ErrorCode_toString: - -.. _ErrorCode_toString__: - -.. _io_realm_mongodb_ErrorCode_toString: - -.. _io_realm_mongodb_ErrorCode_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Enum `__ - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _ErrorCode_valueOf: - -.. _ErrorCode_valueOf__: - -.. _io_realm_mongodb_ErrorCode_valueOf: - -.. _io_realm_mongodb_ErrorCode_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_ErrorCode_valueOf_java_lang_String_: - -.. _io_realm_mongodb_ErrorCode_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _ErrorCode_valueOf_java_lang_String_: - -.. _ErrorCode_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ErrorCode ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _ErrorCode_values: - -.. _ErrorCode_values__: - -.. _io_realm_mongodb_ErrorCode_values: - -.. _io_realm_mongodb_ErrorCode_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ErrorCode ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt deleted file mode 100644 index 8167610700..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Category.txt +++ /dev/null @@ -1,252 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum ErrorCode.Category -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_ErrorCode_Category: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.ErrorCode.Category - - - - -**Enclosing class:** - -:ref:`ErrorCode ` - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`FATAL ` - - - - - - - * - :ref:`RECOVERABLE ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`ErrorCode.Category ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`ErrorCode.Category ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_ErrorCode_Category_FATAL: - -.. _ErrorCode_Category_FATAL: - - - -``FATAL`` ----------- - -public static final :ref:`ErrorCode.Category ` - - - - - -.. _io_realm_mongodb_ErrorCode_Category_RECOVERABLE: - -.. _ErrorCode_Category_RECOVERABLE: - - - -``RECOVERABLE`` ----------------- - -public static final :ref:`ErrorCode.Category ` - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _Category_valueOf: - -.. _Category_valueOf__: - -.. _ErrorCode_Category_valueOf: - -.. _ErrorCode_Category_valueOf__: - -.. _io_realm_mongodb_ErrorCode_Category_valueOf: - -.. _io_realm_mongodb_ErrorCode_Category_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_ErrorCode_Category_valueOf_java_lang_String_: - -.. _io_realm_mongodb_ErrorCode_Category_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _ErrorCode_Category_valueOf_java_lang_String_: - -.. _ErrorCode_Category_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ErrorCode.Category ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _Category_values: - -.. _Category_values__: - -.. _ErrorCode_Category_values: - -.. _ErrorCode_Category_values__: - -.. _io_realm_mongodb_ErrorCode_Category_values: - -.. _io_realm_mongodb_ErrorCode_Category_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ErrorCode.Category ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt b/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt deleted file mode 100644 index 19b0a5a80f..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/ErrorCode/Type.txt +++ /dev/null @@ -1,316 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class ErrorCode.Type -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_ErrorCode_Type: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.ErrorCode.Type - - - - -**Enclosing class:** - -:ref:`ErrorCode ` - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Type ` () - | - - - - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`AUTH ` - - - - - * - public static final `String `__ - - - - :ref:`CONNECTION ` - - - - - * - public static final `String `__ - - - - :ref:`DEPRECATED ` - - - - - * - public static final `String `__ - - - - :ref:`HTTP ` - - - - - * - public static final `String `__ - - - - :ref:`JAVA ` - - - - - * - public static final `String `__ - - - - :ref:`JSON ` - - - - - * - public static final `String `__ - - - - :ref:`MISC ` - - - - - * - public static final `String `__ - - - - :ref:`PROTOCOL ` - - - - - * - public static final `String `__ - - - - :ref:`SERVICE ` - - - - - * - public static final `String `__ - - - - :ref:`SESSION ` - - - - - * - public static final `String `__ - - - - :ref:`UNKNOWN ` - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_mongodb_ErrorCode_Type_AUTH: - - - -``AUTH`` ---------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_CONNECTION: - - - -``CONNECTION`` ---------------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_DEPRECATED: - - - -``DEPRECATED`` ---------------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_HTTP: - - - -``HTTP`` ---------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_JAVA: - - - -``JAVA`` ---------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_JSON: - - - -``JSON`` ---------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_MISC: - - - -``MISC`` ---------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_PROTOCOL: - - - -``PROTOCOL`` -------------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_SERVICE: - - - -``SERVICE`` ------------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_SESSION: - - - -``SESSION`` ------------- - - - - -.. _io_realm_mongodb_ErrorCode_Type_UNKNOWN: - - - -``UNKNOWN`` ------------- - - - - - - -Constructor Detail -================== - -.. _Type: - -.. _Type__: - -.. _io_realm_mongodb_ErrorCode_Type: - -.. _io_realm_mongodb_ErrorCode_Type__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Type ` () - | - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt deleted file mode 100644 index 43e4395064..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamAsyncTask.txt +++ /dev/null @@ -1,204 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmEventStreamAsyncTask -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_RealmEventStreamAsyncTask: - - - -io.realm.mongodb -================ - -**Implemented interfaces:** - - - -- :ref:`io.realm.RealmAsyncTask ` - - -The RealmEventStreamAsyncTask is a specific version of :ref:`RealmAsyncTask ` that provides a non-blocking mechanism to work with asynchronous operations carried out against MongoDB Realm that yield stream results. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`get ` ( - | :ref:`io.realm.mongodb.App.Callback\> ` callback - | ) - - - Provides a way to subscribe to asynchronous operations via a callback, which handles both results and errors. - - - - - * - public **boolean** - - | :ref:`isOpen ` () - | - - - Whether or not the stream is currently open. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _get: - -.. _get__: - -.. _RealmEventStreamAsyncTask_get: - -.. _RealmEventStreamAsyncTask_get__: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get__: - - - -get ----- - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get_Callback_: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get_App_Callback_: - -.. _get_io_realm_mongodb_App_Callback_: - -.. _get_Callback_: - -.. _get_App_Callback_: - -.. _RealmEventStreamAsyncTask_get_io_realm_mongodb_App_Callback_: - -.. _RealmEventStreamAsyncTask_get_Callback_: - -.. _RealmEventStreamAsyncTask_get_App_Callback_: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_get_App_Callback_BaseChangeEvent_T___: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`get ` ( - | :ref:`io.realm.mongodb.App.Callback\> ` callback - | ) - - - - - * - Provides a way to subscribe to asynchronous operations via a callback, which handles both results and errors. - - - - - **Parameters** - - - ``callback`` - the :ref:`App.Callback ` designed to receive event results. - - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if the stream is already open. - - - - - - - - - - - - -.. _isOpen: - -.. _isOpen__: - -.. _RealmEventStreamAsyncTask_isOpen: - -.. _RealmEventStreamAsyncTask_isOpen__: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_isOpen: - -.. _io_realm_mongodb_RealmEventStreamAsyncTask_isOpen__: - - - -isOpen ------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isOpen ` () - | - - - - - * - Whether or not the stream is currently open. - - - - - - - **Returns** - - true if open, false if not. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt deleted file mode 100644 index 862d2eb70f..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/RealmEventStreamTask.txt +++ /dev/null @@ -1,181 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmEventStreamTask -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_RealmEventStreamTask: - - - -io.realm.mongodb -================ - -**Implemented interfaces:** - - - -- :ref:`io.realm.RealmAsyncTask ` - - -The RealmEventStreamTask is a specific version of :ref:`RealmAsyncTask ` that provides a blocking mechanism to work with asynchronous operations carried out against MongoDB Realm that yield stream results. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`BaseChangeEvent ` - - | :ref:`getNext ` () - | - - - Blocks the thread on which the call is made until the result of the operation arrives. - - - - - * - public **boolean** - - | :ref:`isOpen ` () - | - - - Whether or not the stream is currently open. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _getNext: - -.. _getNext__: - -.. _RealmEventStreamTask_getNext: - -.. _RealmEventStreamTask_getNext__: - -.. _io_realm_mongodb_RealmEventStreamTask_getNext: - -.. _io_realm_mongodb_RealmEventStreamTask_getNext__: - - - -getNext -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`BaseChangeEvent ` :ref:`getNext ` () - | - - - - - * - Blocks the thread on which the call is made until the result of the operation arrives. - - - - - - - **Returns** - - the next event in the stream. - - - - - **Throws** - - - :ref:`AppException ` - if the server raises an error - - - - - `IOException `__ - if something is wrong with the input stream - - - - - - - - - - - - -.. _isOpen: - -.. _isOpen__: - -.. _RealmEventStreamTask_isOpen: - -.. _RealmEventStreamTask_isOpen__: - -.. _io_realm_mongodb_RealmEventStreamTask_isOpen: - -.. _io_realm_mongodb_RealmEventStreamTask_isOpen__: - - - -isOpen ------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isOpen ` () - | - - - - - * - Whether or not the stream is currently open. - - - - - - - **Returns** - - true if open, false if not. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt b/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt deleted file mode 100644 index 6a9397f5c2..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/RealmResultTask.txt +++ /dev/null @@ -1,210 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RealmResultTask -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_RealmResultTask: - - - -io.realm.mongodb -================ - -**Implemented interfaces:** - - - -- :ref:`io.realm.RealmAsyncTask ` - - -The RealmResultTask is a specific version of :ref:`RealmAsyncTask ` that provides a mechanism to work with asynchronous operations carried out against MongoDB Realm that yield a result. - -This class offers both blocking (``get`` ) and non-blocking (``getAsync`` ) method calls. - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **T** - - | :ref:`get ` () - | - - - Blocks the thread on which the call is made until the result of the operation arrives. - - - - - * - public **void** - - | :ref:`getAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Provides a way to subscribe to asynchronous operations via a callback, which handles both results and errors. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _get: - -.. _get__: - -.. _RealmResultTask_get: - -.. _RealmResultTask_get__: - -.. _io_realm_mongodb_RealmResultTask_get: - -.. _io_realm_mongodb_RealmResultTask_get__: - - - -get ----- - -.. list-table:: - :header-rows: 1 - - * - | public **T** :ref:`get ` () - | - - - - - * - Blocks the thread on which the call is made until the result of the operation arrives. - - - - - - - **Returns** - - the result of the operation executed by this task. - - - - - - - - - - - -.. _getAsync: - -.. _getAsync__: - -.. _RealmResultTask_getAsync: - -.. _RealmResultTask_getAsync__: - -.. _io_realm_mongodb_RealmResultTask_getAsync: - -.. _io_realm_mongodb_RealmResultTask_getAsync__: - - - -getAsync --------- - -.. _io_realm_mongodb_RealmResultTask_getAsync_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_RealmResultTask_getAsync_Callback_: - -.. _io_realm_mongodb_RealmResultTask_getAsync_App_Callback_: - -.. _getAsync_io_realm_mongodb_App_Callback_: - -.. _getAsync_Callback_: - -.. _getAsync_App_Callback_: - -.. _RealmResultTask_getAsync_io_realm_mongodb_App_Callback_: - -.. _RealmResultTask_getAsync_Callback_: - -.. _RealmResultTask_getAsync_App_Callback_: - -.. _io_realm_mongodb_RealmResultTask_getAsync_App_Callback_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`getAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Provides a way to subscribe to asynchronous operations via a callback, which handles both results and errors. - - - - - **Parameters** - - - ``callback`` - the :ref:`App.Callback ` designed to receive results. - - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a thread without a `android.os.Looper `__ or from an `android.app.IntentService `__ thread. - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/User.txt b/source/sdk/java/api/io/realm/mongodb/User.txt deleted file mode 100644 index a38ab27cf2..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/User.txt +++ /dev/null @@ -1,1986 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class User -^^^^^^^^^^ - -.. _io_realm_mongodb_User: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.User - - -A *user* holds the user's meta data and tokens for accessing Realm App functionality.The user is used to configure Synchronized Realms and gives access to calling Realm App *Functions* through :ref:`Functions ` and accessing remote Realm App - -*Mongo Databases* through a :ref:`MongoClient ` . - - - - - - -.. seealso:: - - - - - :ref:`App.login(Credentials) ` - - - - - **io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(User, String)** - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`User.State ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - Two Users are considered equal if they have the same user identity and are associated with the same app. - - - - - * - public `String `__ - - | :ref:`getAccessToken ` () - | - - - Returns the current access token for the user. - - - - - * - public synchronized :ref:`ApiKeyAuth ` - - | :ref:`getApiKeys ` () - | - - - Returns a wrapper for managing API keys controlled by the current user. - - - - - * - public :ref:`App ` - - | :ref:`getApp ` () - | - - - Returns the :ref:`App ` this user is associated with. - - - - - - - * - public **Document** - - | :ref:`getCustomData ` () - | - - - Return the custom user data associated with the user in the Realm App. - - - - - * - public `String `__ - - | :ref:`getDeviceId ` () - | - - - Returns a unique identifier for the device the user logged in to. - - - - - * - public :ref:`Functions ` - - | :ref:`getFunctions ` ( - | **CodecRegistry** codecRegistry - | ) - - - Returns a *functions* manager for invoking Realm Functions with custom codec registry for encoding and decoding arguments and results. - - - - - * - public synchronized :ref:`Functions ` - - | :ref:`getFunctions ` () - | - - - Returns a *functions* manager for invoking MongoDB Realm Functions. - - - - - * - public `String `__ - - | :ref:`getId ` () - | - - - Returns the server id of the user. - - - - - * - public `List `__ - - | :ref:`getIdentities ` () - | - - - Returns a new list of the user's identities. - - - - - * - public synchronized :ref:`MongoClient ` - - | :ref:`getMongoClient ` ( - | `String `__ serviceName - | ) - - - Returns a :ref:`MongoClient ` instance for accessing documents in the database. - - - - - - - * - public :ref:`UserProfile ` - - | :ref:`getProfile ` () - | - - - Returns the profile for this user. - - - - - * - public :ref:`Credentials.Provider ` - - | :ref:`getProviderType ` () - | - - - Returns the provider type used to log the user - - - - - * - public synchronized :ref:`Push ` - - | :ref:`getPush ` ( - | `String `__ serviceName - | ) - - - Returns the :ref:`Push ` instance for managing push notification registrations. - - - - - - - * - public `String `__ - - | :ref:`getRefreshToken ` () - | - - - Returns the current refresh token for the user. - - - - - * - public :ref:`User.State ` - - | :ref:`getState ` () - | - - - Returns the :ref:`State ` the user is in. - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isLoggedIn ` () - | - - - Returns true if the user is currently logged in. - - - - - * - public :ref:`User ` - - | :ref:`linkCredentials ` ( - | :ref:`Credentials ` credentials - | ) - - - Links the current user with a new user identity represented by the given credentials. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`linkCredentialsAsync ` ( - | :ref:`Credentials ` credentials, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Links the current user with a new user identity represented by the given credentials. - - - - - * - public **void** - - | :ref:`logOut ` () - | - - - Log the user out of the Realm App. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`logOutAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Log the user out of the Realm App asynchronously. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`refreshCustomData ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Re-fetch custom user data from the Realm App asynchronously. - - - - - * - public **Document** - - | :ref:`refreshCustomData ` () - | - - - Re-fetch custom user data from the Realm App. - - - - - * - public :ref:`User ` - - | :ref:`remove ` () - | - - - Calling this will remove the user and any Realms the user has from the device. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`removeAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Calling this will asynchronously remove the user and any Realms the user has from the device. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _User_equals: - -.. _User_equals__: - -.. _io_realm_mongodb_User_equals: - -.. _io_realm_mongodb_User_equals__: - - - -equals ------- - -.. _io_realm_mongodb_User_equals_java_lang_Object_: - -.. _io_realm_mongodb_User_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _User_equals_java_lang_Object_: - -.. _User_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - Two Users are considered equal if they have the same user identity and are associated with the same app. - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getAccessToken: - -.. _getAccessToken__: - -.. _User_getAccessToken: - -.. _User_getAccessToken__: - -.. _io_realm_mongodb_User_getAccessToken: - -.. _io_realm_mongodb_User_getAccessToken__: - - - -getAccessToken --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getAccessToken ` () - | - - - - - * - Returns the current access token for the user. - - - - - - - **Returns** - - the current access token. - - - - - - - - - - - -.. _getApiKeys: - -.. _getApiKeys__: - -.. _User_getApiKeys: - -.. _User_getApiKeys__: - -.. _io_realm_mongodb_User_getApiKeys: - -.. _io_realm_mongodb_User_getApiKeys__: - - - -getApiKeys ----------- - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`ApiKeyAuth ` :ref:`getApiKeys ` () - | - - - - - * - Returns a wrapper for managing API keys controlled by the current user. - - - - - - - **Returns** - - wrapper for managing API keys controlled by the current user. - - - - - **Throws** - - - `IllegalStateException `__ - if no user is currently logged in. - - - - - - - - - - - - -.. _getApp: - -.. _getApp__: - -.. _User_getApp: - -.. _User_getApp__: - -.. _io_realm_mongodb_User_getApp: - -.. _io_realm_mongodb_User_getApp__: - - - -getApp ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`App ` :ref:`getApp ` () - | - - - - - * - Returns the :ref:`App ` this user is associated with. - - - - - - - - - **Returns** - - the :ref:`App ` this user is associated with. - - - - - - - - - - - - - -.. _getCustomData: - -.. _getCustomData__: - -.. _User_getCustomData: - -.. _User_getCustomData__: - -.. _io_realm_mongodb_User_getCustomData: - -.. _io_realm_mongodb_User_getCustomData__: - - - -getCustomData -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **Document** :ref:`getCustomData ` () - | - - - - - * - Return the custom user data associated with the user in the Realm App.The data is only refreshed when the user's access token is refreshed or when explicitly calling :ref:`refreshCustomData() ` . - - - - - - - - - - - **Returns** - - The custom user data associated with the user. - - - - - - - - - - - -.. _getDeviceId: - -.. _getDeviceId__: - -.. _User_getDeviceId: - -.. _User_getDeviceId__: - -.. _io_realm_mongodb_User_getDeviceId: - -.. _io_realm_mongodb_User_getDeviceId__: - - - -getDeviceId ------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getDeviceId ` () - | - - - - - * - Returns a unique identifier for the device the user logged in to. - - - - - - - **Returns** - - a unique device identifier for the user. - - - - - - - - - - - -.. _getFunctions: - -.. _getFunctions__: - -.. _User_getFunctions: - -.. _User_getFunctions__: - -.. _io_realm_mongodb_User_getFunctions: - -.. _io_realm_mongodb_User_getFunctions__: - - - -getFunctions ------------- - -.. _io_realm_mongodb_User_getFunctions_CodecRegistry_: - -.. _getFunctions_CodecRegistry_: - -.. _User_getFunctions_CodecRegistry_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Functions ` :ref:`getFunctions ` ( - | **CodecRegistry** codecRegistry - | ) - - - - - * - Returns a *functions* manager for invoking Realm Functions with custom codec registry for encoding and decoding arguments and results. - - - - - **Parameters** - - - ``codecRegistry`` - The codec registry to use for encoding and decoding arguments and results towards the remote Realm App. - - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Functions ` - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`Functions ` :ref:`getFunctions ` () - | - - - - - * - Returns a *functions* manager for invoking MongoDB Realm Functions.This will use the associated app's default codec registry to encode and decode arguments and results. - - - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Functions ` - - - - - - - - - - - - -.. _getId: - -.. _getId__: - -.. _User_getId: - -.. _User_getId__: - -.. _io_realm_mongodb_User_getId: - -.. _io_realm_mongodb_User_getId__: - - - -getId ------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getId ` () - | - - - - - * - Returns the server id of the user. - - - - - - - **Returns** - - the server id of the user. - - - - - - - - - - - -.. _getIdentities: - -.. _getIdentities__: - -.. _User_getIdentities: - -.. _User_getIdentities__: - -.. _io_realm_mongodb_User_getIdentities: - -.. _io_realm_mongodb_User_getIdentities__: - - - -getIdentities -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`getIdentities ` () - | - - - - - * - Returns a new list of the user's identities. - - - - - - - **Returns** - - the list of identities. - - - - - - - - - .. seealso:: - - - - - :ref:`UserIdentity ` - - - - - - - - - - - - -.. _getMongoClient: - -.. _getMongoClient__: - -.. _User_getMongoClient: - -.. _User_getMongoClient__: - -.. _io_realm_mongodb_User_getMongoClient: - -.. _io_realm_mongodb_User_getMongoClient__: - - - -getMongoClient --------------- - -.. _io_realm_mongodb_User_getMongoClient_java_lang_String_: - -.. _io_realm_mongodb_User_getMongoClient_String_: - -.. _getMongoClient_java_lang_String_: - -.. _getMongoClient_String_: - -.. _User_getMongoClient_java_lang_String_: - -.. _User_getMongoClient_String_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`MongoClient ` :ref:`getMongoClient ` ( - | `String `__ serviceName - | ) - - - - - * - Returns a :ref:`MongoClient ` instance for accessing documents in the database. - - - - - - - **Parameters** - - - ``serviceName`` - the service name used to connect to the server. - - - - - - - - - - - - - - - - -.. _getProfile: - -.. _getProfile__: - -.. _User_getProfile: - -.. _User_getProfile__: - -.. _io_realm_mongodb_User_getProfile: - -.. _io_realm_mongodb_User_getProfile__: - - - -getProfile ----------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UserProfile ` :ref:`getProfile ` () - | - - - - - * - Returns the profile for this user. - - - - - - - **Returns** - - the profile for this user - - - - - - - - - - - -.. _getProviderType: - -.. _getProviderType__: - -.. _User_getProviderType: - -.. _User_getProviderType__: - -.. _io_realm_mongodb_User_getProviderType: - -.. _io_realm_mongodb_User_getProviderType__: - - - -getProviderType ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Credentials.Provider ` :ref:`getProviderType ` () - | - - - - - * - Returns the provider type used to log the user - - - - - - - **Returns** - - the provider type of the user - - - - - - - - - - - -.. _getPush: - -.. _getPush__: - -.. _User_getPush: - -.. _User_getPush__: - -.. _io_realm_mongodb_User_getPush: - -.. _io_realm_mongodb_User_getPush__: - - - -getPush -------- - -.. _io_realm_mongodb_User_getPush_java_lang_String_: - -.. _io_realm_mongodb_User_getPush_String_: - -.. _getPush_java_lang_String_: - -.. _getPush_String_: - -.. _User_getPush_java_lang_String_: - -.. _User_getPush_String_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`Push ` :ref:`getPush ` ( - | `String `__ serviceName - | ) - - - - - * - Returns the :ref:`Push ` instance for managing push notification registrations. - - - - - - - **Parameters** - - - ``serviceName`` - the service name used to connect to the server. - - - - - - - - - - - - - - - - -.. _getRefreshToken: - -.. _getRefreshToken__: - -.. _User_getRefreshToken: - -.. _User_getRefreshToken__: - -.. _io_realm_mongodb_User_getRefreshToken: - -.. _io_realm_mongodb_User_getRefreshToken__: - - - -getRefreshToken ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getRefreshToken ` () - | - - - - - * - Returns the current refresh token for the user. - - - - - - - **Returns** - - the current refresh token. - - - - - - - - - - - -.. _getState: - -.. _getState__: - -.. _User_getState: - -.. _User_getState__: - -.. _io_realm_mongodb_User_getState: - -.. _io_realm_mongodb_User_getState__: - - - -getState --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User.State ` :ref:`getState ` () - | - - - - - * - Returns the :ref:`State ` the user is in. - - - - - - - - - **Returns** - - the :ref:`State ` of the user. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _User_hashCode: - -.. _User_hashCode__: - -.. _io_realm_mongodb_User_hashCode: - -.. _io_realm_mongodb_User_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isLoggedIn: - -.. _isLoggedIn__: - -.. _User_isLoggedIn: - -.. _User_isLoggedIn__: - -.. _io_realm_mongodb_User_isLoggedIn: - -.. _io_realm_mongodb_User_isLoggedIn__: - - - -isLoggedIn ----------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isLoggedIn ` () - | - - - - - * - Returns true if the user is currently logged in. Returns whether or not this user is still logged into the MongoDB Realm App. - - - - - - - **Returns** - - ``true`` if still logged in, ``false`` if not. - - - - - - - - - - - - - -.. _linkCredentials: - -.. _linkCredentials__: - -.. _User_linkCredentials: - -.. _User_linkCredentials__: - -.. _io_realm_mongodb_User_linkCredentials: - -.. _io_realm_mongodb_User_linkCredentials__: - - - -linkCredentials ---------------- - -.. _io_realm_mongodb_User_linkCredentials_io_realm_mongodb_Credentials_: - -.. _io_realm_mongodb_User_linkCredentials_Credentials_: - -.. _linkCredentials_io_realm_mongodb_Credentials_: - -.. _linkCredentials_Credentials_: - -.. _User_linkCredentials_io_realm_mongodb_Credentials_: - -.. _User_linkCredentials_Credentials_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`linkCredentials ` ( - | :ref:`Credentials ` credentials - | ) - - - - - * - Links the current user with a new user identity represented by the given credentials.Linking a user with more credentials, mean the user can login either of these credentials. It also makes it possible to "upgrade" an anonymous user by linking it with e.g. Email/Password credentials. - - - - .. code-block:: java - - - // Example - App app = new App("app-id") - User user = app.login(Credentials.anonymous()); - user.linkCredentials(Credentials.emailPassword("email", "password")); - - - - - - Note: It is not possible to link two existing users of MongoDB Realm. The provided credentials must not have been used by another user. - - - - - - - **Parameters** - - - ``credentials`` - the credentials to link with the current user. - - - - - - - - **Returns** - - the :ref:`User ` the credentials were linked to. - - - - - - - **Throws** - - - `IllegalStateException `__ - if no user is currently logged in. - - - - - - - - - - - - -.. _linkCredentialsAsync: - -.. _linkCredentialsAsync__: - -.. _User_linkCredentialsAsync: - -.. _User_linkCredentialsAsync__: - -.. _io_realm_mongodb_User_linkCredentialsAsync: - -.. _io_realm_mongodb_User_linkCredentialsAsync__: - - - -linkCredentialsAsync --------------------- - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials__Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials__Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials_App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials__App_Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials_Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials__Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _linkCredentialsAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _linkCredentialsAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _linkCredentialsAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _linkCredentialsAsync_Credentials_Callback_: - -.. _linkCredentialsAsync_Credentials__Callback_: - -.. _linkCredentialsAsync_Credentials_App_Callback_: - -.. _linkCredentialsAsync_Credentials__App_Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials_io_realm_mongodb_App_Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials__io_realm_mongodb_App_Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials_Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials__Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials_App_Callback_: - -.. _User_linkCredentialsAsync_io_realm_mongodb_Credentials__App_Callback_: - -.. _User_linkCredentialsAsync_Credentials_io_realm_mongodb_App_Callback_: - -.. _User_linkCredentialsAsync_Credentials__io_realm_mongodb_App_Callback_: - -.. _User_linkCredentialsAsync_Credentials_Callback_: - -.. _User_linkCredentialsAsync_Credentials__Callback_: - -.. _User_linkCredentialsAsync_Credentials_App_Callback_: - -.. _User_linkCredentialsAsync_Credentials__App_Callback_: - -.. _io_realm_mongodb_User_linkCredentialsAsync_Credentials__App_Callback_User__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`linkCredentialsAsync ` ( - | :ref:`Credentials ` credentials, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Links the current user with a new user identity represented by the given credentials.Linking a user with more credentials, mean the user can login either of these credentials. It also makes it possible to "upgrade" an anonymous user by linking it with e.g. Email/Password credentials. - - - - .. code-block:: java - - - // Example - App app = new App("app-id") - User user = app.login(Credentials.anonymous()); - user.linkCredentials(Credentials.emailPassword("email", "password")); - - - - - - Note: It is not possible to link two existing users of MongoDB Realm. The provided credentials must not have been used by another user. - - - - - - - **Parameters** - - - ``credentials`` - the credentials to link with the current user. - - - - - ``callback`` - callback when user identities has been linked or it failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _logOut: - -.. _logOut__: - -.. _User_logOut: - -.. _User_logOut__: - -.. _io_realm_mongodb_User_logOut: - -.. _io_realm_mongodb_User_logOut__: - - - -logOut ------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`logOut ` () - | - - - - - * - Log the user out of the Realm App. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before :ref:`User.remove() ` is called. - - Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. - - - - Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . - - - - All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling :ref:`User.remove() ` . - - - - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if an error occurred while trying to log the user out of the Realm App. - - - - - - - - - - - - -.. _logOutAsync: - -.. _logOutAsync__: - -.. _User_logOutAsync: - -.. _User_logOutAsync__: - -.. _io_realm_mongodb_User_logOutAsync: - -.. _io_realm_mongodb_User_logOutAsync__: - - - -logOutAsync ------------ - -.. _io_realm_mongodb_User_logOutAsync_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_logOutAsync_Callback_: - -.. _io_realm_mongodb_User_logOutAsync_App_Callback_: - -.. _logOutAsync_io_realm_mongodb_App_Callback_: - -.. _logOutAsync_Callback_: - -.. _logOutAsync_App_Callback_: - -.. _User_logOutAsync_io_realm_mongodb_App_Callback_: - -.. _User_logOutAsync_Callback_: - -.. _User_logOutAsync_App_Callback_: - -.. _io_realm_mongodb_User_logOutAsync_App_Callback_User__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`logOutAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Log the user out of the Realm App asynchronously. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before :ref:`User.remove() ` is called. - - Once the Realm App has confirmed the logout any registered :ref:`AuthenticationListener ` will be notified and user credentials will be deleted from this device. - - - - Logging out anonymous users will remove them immediately instead of marking them as :ref:`User.State.LOGGED_OUT ` . - - - - All other users will be marked as :ref:`User.State.LOGGED_OUT ` and will still be returned by :ref:`App.allUsers() ` . They can be removed completely by calling :ref:`User.remove() ` . - - - - - - - - - **Parameters** - - - ``callback`` - callback when logging out has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _refreshCustomData: - -.. _refreshCustomData__: - -.. _User_refreshCustomData: - -.. _User_refreshCustomData__: - -.. _io_realm_mongodb_User_refreshCustomData: - -.. _io_realm_mongodb_User_refreshCustomData__: - - - -refreshCustomData ------------------ - -.. _io_realm_mongodb_User_refreshCustomData_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_refreshCustomData_Callback_: - -.. _io_realm_mongodb_User_refreshCustomData_App_Callback_: - -.. _refreshCustomData_io_realm_mongodb_App_Callback_: - -.. _refreshCustomData_Callback_: - -.. _refreshCustomData_App_Callback_: - -.. _User_refreshCustomData_io_realm_mongodb_App_Callback_: - -.. _User_refreshCustomData_Callback_: - -.. _User_refreshCustomData_App_Callback_: - -.. _io_realm_mongodb_User_refreshCustomData_App_Callback_Document__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`refreshCustomData ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Re-fetch custom user data from the Realm App asynchronously.This is the asynchronous variant of :ref:`refreshCustomData() ` . - - - - - - - - - **Parameters** - - - ``callback`` - The callback that will receive the result or any errors from the request. - - - - - - - - **Returns** - - The task representing the ongoing operation. - - - - - **Throws** - - - `IllegalStateException `__ - if not called on a looper thread. - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **Document** :ref:`refreshCustomData ` () - | - - - - - * - Re-fetch custom user data from the Realm App. - - - - - - - **Returns** - - The updated custom user data associated with the user. - - - - - **Throws** - - - :ref:`AppException ` - if the request failed in some way. - - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _User_remove: - -.. _User_remove__: - -.. _io_realm_mongodb_User_remove: - -.. _io_realm_mongodb_User_remove__: - - - -remove ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`remove ` () - | - - - - - * - Calling this will remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted. - - - - - - - **Returns** - - the user that was removed. - - - - - **Throws** - - - :ref:`AppException ` - if an error occurred while trying to remove the user. - - - - - - - - - - - - -.. _removeAsync: - -.. _removeAsync__: - -.. _User_removeAsync: - -.. _User_removeAsync__: - -.. _io_realm_mongodb_User_removeAsync: - -.. _io_realm_mongodb_User_removeAsync__: - - - -removeAsync ------------ - -.. _io_realm_mongodb_User_removeAsync_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_User_removeAsync_Callback_: - -.. _io_realm_mongodb_User_removeAsync_App_Callback_: - -.. _removeAsync_io_realm_mongodb_App_Callback_: - -.. _removeAsync_Callback_: - -.. _removeAsync_App_Callback_: - -.. _User_removeAsync_io_realm_mongodb_App_Callback_: - -.. _User_removeAsync_Callback_: - -.. _User_removeAsync_App_Callback_: - -.. _io_realm_mongodb_User_removeAsync_App_Callback_User__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`removeAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Calling this will asynchronously remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted. - - - - - **Parameters** - - - ``callback`` - callback when removing the user has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/User/State.txt b/source/sdk/java/api/io/realm/mongodb/User/State.txt deleted file mode 100644 index 28e7cc1f2f..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/User/State.txt +++ /dev/null @@ -1,274 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum User.State -^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_User_State: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.User.State - - - - -**Enclosing class:** - -:ref:`User ` - - - -The user's potential states. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`LOGGED_IN ` - - - - - - - * - :ref:`LOGGED_OUT ` - - - - - - - * - :ref:`REMOVED ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`User.State ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`User.State ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_User_State_LOGGED_IN: - -.. _User_State_LOGGED_IN: - - - -``LOGGED_IN`` --------------- - -public static final :ref:`User.State ` - - - - - -.. _io_realm_mongodb_User_State_LOGGED_OUT: - -.. _User_State_LOGGED_OUT: - - - -``LOGGED_OUT`` ---------------- - -public static final :ref:`User.State ` - - - - - -.. _io_realm_mongodb_User_State_REMOVED: - -.. _User_State_REMOVED: - - - -``REMOVED`` ------------- - -public static final :ref:`User.State ` - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _State_valueOf: - -.. _State_valueOf__: - -.. _User_State_valueOf: - -.. _User_State_valueOf__: - -.. _io_realm_mongodb_User_State_valueOf: - -.. _io_realm_mongodb_User_State_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_User_State_valueOf_java_lang_String_: - -.. _io_realm_mongodb_User_State_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _User_State_valueOf_java_lang_String_: - -.. _User_State_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`User.State ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _State_values: - -.. _State_values__: - -.. _User_State_values: - -.. _User_State_values__: - -.. _io_realm_mongodb_User_State_values: - -.. _io_realm_mongodb_User_State_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`User.State ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt b/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt deleted file mode 100644 index f4056abbbe..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/UserIdentity.txt +++ /dev/null @@ -1,354 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class UserIdentity -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_UserIdentity: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.UserIdentity - - -Each User is represented by 1 or more identities each defined by an :ref:`Credentials.Provider ` . This class represents the identity defined by a specific provider. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public `String `__ - - | :ref:`getId ` () - | - - - Returns a unique identifier for this identity. - - - - - * - public :ref:`Credentials.Provider ` - - | :ref:`getProvider ` () - | - - - Returns the provider defining this identity. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _UserIdentity_equals: - -.. _UserIdentity_equals__: - -.. _io_realm_mongodb_UserIdentity_equals: - -.. _io_realm_mongodb_UserIdentity_equals__: - - - -equals ------- - -.. _io_realm_mongodb_UserIdentity_equals_java_lang_Object_: - -.. _io_realm_mongodb_UserIdentity_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _UserIdentity_equals_java_lang_Object_: - -.. _UserIdentity_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getId: - -.. _getId__: - -.. _UserIdentity_getId: - -.. _UserIdentity_getId__: - -.. _io_realm_mongodb_UserIdentity_getId: - -.. _io_realm_mongodb_UserIdentity_getId__: - - - -getId ------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getId ` () - | - - - - - * - Returns a unique identifier for this identity. - - - - - - - **Returns** - - a unique identifier for this identifier. - - - - - - - - - - - -.. _getProvider: - -.. _getProvider__: - -.. _UserIdentity_getProvider: - -.. _UserIdentity_getProvider__: - -.. _io_realm_mongodb_UserIdentity_getProvider: - -.. _io_realm_mongodb_UserIdentity_getProvider__: - - - -getProvider ------------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Credentials.Provider ` :ref:`getProvider ` () - | - - - - - * - Returns the provider defining this identity. - - - - - - - **Returns** - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _UserIdentity_hashCode: - -.. _UserIdentity_hashCode__: - -.. _io_realm_mongodb_UserIdentity_hashCode: - -.. _io_realm_mongodb_UserIdentity_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _toString: - -.. _toString__: - -.. _UserIdentity_toString: - -.. _UserIdentity_toString__: - -.. _io_realm_mongodb_UserIdentity_toString: - -.. _io_realm_mongodb_UserIdentity_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/UserProfile.txt b/source/sdk/java/api/io/realm/mongodb/UserProfile.txt deleted file mode 100644 index 9fe5c0f47a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/UserProfile.txt +++ /dev/null @@ -1,814 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class UserProfile -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_UserProfile: - - - -io.realm.mongodb -================ - - - | `java.lang.Object `__ - | io.realm.mongodb.UserProfile - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public `String `__ - - | :ref:`getBirthday ` () - | - - - Returns the birthday of the user. - - - - - * - public `String `__ - - | :ref:`getEmail ` () - | - - - Returns the email address of the user. - - - - - * - public `String `__ - - | :ref:`getFirstName ` () - | - - - Return the first name of the user. - - - - - * - public `String `__ - - | :ref:`getGender ` () - | - - - Returns the gender of the user. - - - - - * - public `String `__ - - | :ref:`getLastName ` () - | - - - Return the last name of the user. - - - - - * - public `Long `__ - - | :ref:`getMaxAge ` () - | - - - Returns the maximum age of the user. - - - - - * - public `Long `__ - - | :ref:`getMinAge ` () - | - - - Returns the minimum age of the user. - - - - - * - public `String `__ - - | :ref:`getName ` () - | - - - Returns the name of the user. - - - - - * - public `String `__ - - | :ref:`getPictureUrl ` () - | - - - Returns the picture URL of the user. - - - - - * - public :ref:`User ` - - | :ref:`getUser ` () - | - - - Returns the :ref:`User ` that this instance in associated with. - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _UserProfile_equals: - -.. _UserProfile_equals__: - -.. _io_realm_mongodb_UserProfile_equals: - -.. _io_realm_mongodb_UserProfile_equals__: - - - -equals ------- - -.. _io_realm_mongodb_UserProfile_equals_java_lang_Object_: - -.. _io_realm_mongodb_UserProfile_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _UserProfile_equals_java_lang_Object_: - -.. _UserProfile_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getBirthday: - -.. _getBirthday__: - -.. _UserProfile_getBirthday: - -.. _UserProfile_getBirthday__: - -.. _io_realm_mongodb_UserProfile_getBirthday: - -.. _io_realm_mongodb_UserProfile_getBirthday__: - - - -getBirthday ------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getBirthday ` () - | - - - - - * - Returns the birthday of the user. - - - - - - - **Returns** - - the birthday of the user or null if there is no birthday associated with the user. - - - - - - - - - - - -.. _getEmail: - -.. _getEmail__: - -.. _UserProfile_getEmail: - -.. _UserProfile_getEmail__: - -.. _io_realm_mongodb_UserProfile_getEmail: - -.. _io_realm_mongodb_UserProfile_getEmail__: - - - -getEmail --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getEmail ` () - | - - - - - * - Returns the email address of the user. - - - - - - - **Returns** - - the email address of the user or null if there is no email address associated with the user. address. - - - - - - - - - - - -.. _getFirstName: - -.. _getFirstName__: - -.. _UserProfile_getFirstName: - -.. _UserProfile_getFirstName__: - -.. _io_realm_mongodb_UserProfile_getFirstName: - -.. _io_realm_mongodb_UserProfile_getFirstName__: - - - -getFirstName ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getFirstName ` () - | - - - - - * - Return the first name of the user. - - - - - - - **Returns** - - the first name of the user or null if there is no first name associated with the user. - - - - - - - - - - - -.. _getGender: - -.. _getGender__: - -.. _UserProfile_getGender: - -.. _UserProfile_getGender__: - -.. _io_realm_mongodb_UserProfile_getGender: - -.. _io_realm_mongodb_UserProfile_getGender__: - - - -getGender ---------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getGender ` () - | - - - - - * - Returns the gender of the user. - - - - - - - **Returns** - - the gender of the user or null if there is no gender associated with the user. - - - - - - - - - - - -.. _getLastName: - -.. _getLastName__: - -.. _UserProfile_getLastName: - -.. _UserProfile_getLastName__: - -.. _io_realm_mongodb_UserProfile_getLastName: - -.. _io_realm_mongodb_UserProfile_getLastName__: - - - -getLastName ------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getLastName ` () - | - - - - - * - Return the last name of the user. - - - - - - - **Returns** - - the last name of the user or null if there is no last name associated with the user. - - - - - - - - - - - -.. _getMaxAge: - -.. _getMaxAge__: - -.. _UserProfile_getMaxAge: - -.. _UserProfile_getMaxAge__: - -.. _io_realm_mongodb_UserProfile_getMaxAge: - -.. _io_realm_mongodb_UserProfile_getMaxAge__: - - - -getMaxAge ---------- - -.. list-table:: - :header-rows: 1 - - * - | public `Long `__ :ref:`getMaxAge ` () - | - - - - - * - Returns the maximum age of the user. - - - - - - - **Returns** - - the maximum age of the user or null if there is no maximum age associated with the user. - - - - - - - - - - - -.. _getMinAge: - -.. _getMinAge__: - -.. _UserProfile_getMinAge: - -.. _UserProfile_getMinAge__: - -.. _io_realm_mongodb_UserProfile_getMinAge: - -.. _io_realm_mongodb_UserProfile_getMinAge__: - - - -getMinAge ---------- - -.. list-table:: - :header-rows: 1 - - * - | public `Long `__ :ref:`getMinAge ` () - | - - - - - * - Returns the minimum age of the user. - - - - - - - **Returns** - - the minimum age of the user or null if there is no minimum age associated with the user. - - - - - - - - - - - -.. _getName: - -.. _getName__: - -.. _UserProfile_getName: - -.. _UserProfile_getName__: - -.. _io_realm_mongodb_UserProfile_getName: - -.. _io_realm_mongodb_UserProfile_getName__: - - - -getName -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getName ` () - | - - - - - * - Returns the name of the user. - - - - - - - **Returns** - - the name of the user. - - - - - - - - - - - -.. _getPictureUrl: - -.. _getPictureUrl__: - -.. _UserProfile_getPictureUrl: - -.. _UserProfile_getPictureUrl__: - -.. _io_realm_mongodb_UserProfile_getPictureUrl: - -.. _io_realm_mongodb_UserProfile_getPictureUrl__: - - - -getPictureUrl -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getPictureUrl ` () - | - - - - - * - Returns the picture URL of the user. - - - - - - - **Returns** - - the picture URL of the user or null if there is no picture URL associated with the user. - - - - - - - - - - - -.. _getUser: - -.. _getUser__: - -.. _UserProfile_getUser: - -.. _UserProfile_getUser__: - -.. _io_realm_mongodb_UserProfile_getUser: - -.. _io_realm_mongodb_UserProfile_getUser__: - - - -getUser -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`getUser ` () - | - - - - - * - Returns the :ref:`User ` that this instance in associated with. - - - - - - - - - **Returns** - - The :ref:`User ` that this instance in associated with. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _UserProfile_hashCode: - -.. _UserProfile_hashCode__: - -.. _io_realm_mongodb_UserProfile_hashCode: - -.. _io_realm_mongodb_UserProfile_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _toString: - -.. _toString__: - -.. _UserProfile_toString: - -.. _UserProfile_toString__: - -.. _io_realm_mongodb_UserProfile_toString: - -.. _io_realm_mongodb_UserProfile_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/auth.txt b/source/sdk/java/api/io/realm/mongodb/auth.txt deleted file mode 100644 index 8ad25877d0..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/auth.txt +++ /dev/null @@ -1,36 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.auth -^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - ApiKey - ApiKeyAuth - EmailPasswordAuth - GoogleAuthType - - - -| - -- :ref:`io.realm.mongodb.auth.ApiKey ` -- :ref:`io.realm.mongodb.auth.ApiKeyAuth ` -- :ref:`io.realm.mongodb.auth.EmailPasswordAuth ` -- :ref:`io.realm.mongodb.auth.GoogleAuthType ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt b/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt deleted file mode 100644 index c886db57ba..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/auth/ApiKey.txt +++ /dev/null @@ -1,476 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class ApiKey -^^^^^^^^^^^^ - -.. _io_realm_mongodb_auth_ApiKey: - - - -io.realm.mongodb.auth -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.auth.ApiKey - - -Class representing an API key for a :ref:`User ` . An API can be used to represent the user when logging instead of using email and password. - -These keys are created or fetched through :ref:`ApiKeyAuth.create(String) ` or the various ``fetch`` -methods. - - - -Note that a keys **value** is only available when the key is created, after that it is not visible. So anyone creating an API key is responsible for storing it safely after that. - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public **ObjectId** - - | :ref:`getId ` () - | - - - Returns the unique identifier for this key. - - - - - * - public `String `__ - - | :ref:`getName ` () - | - - - Returns the name of this key. - - - - - * - public `String `__ - - | :ref:`getValue ` () - | - - - Returns this keys value. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isEnabled ` () - | - - - Returns whether or not this key is currently enabled. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _ApiKey_equals: - -.. _ApiKey_equals__: - -.. _io_realm_mongodb_auth_ApiKey_equals: - -.. _io_realm_mongodb_auth_ApiKey_equals__: - - - -equals ------- - -.. _io_realm_mongodb_auth_ApiKey_equals_java_lang_Object_: - -.. _io_realm_mongodb_auth_ApiKey_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _ApiKey_equals_java_lang_Object_: - -.. _ApiKey_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getId: - -.. _getId__: - -.. _ApiKey_getId: - -.. _ApiKey_getId__: - -.. _io_realm_mongodb_auth_ApiKey_getId: - -.. _io_realm_mongodb_auth_ApiKey_getId__: - - - -getId ------ - -.. list-table:: - :header-rows: 1 - - * - | public **ObjectId** :ref:`getId ` () - | - - - - - * - Returns the unique identifier for this key. - - - - - - - **Returns** - - the id, uniquely identifying the key. - - - - - - - - - - - -.. _getName: - -.. _getName__: - -.. _ApiKey_getName: - -.. _ApiKey_getName__: - -.. _io_realm_mongodb_auth_ApiKey_getName: - -.. _io_realm_mongodb_auth_ApiKey_getName__: - - - -getName -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getName ` () - | - - - - - * - Returns the name of this key. - - - - - - - **Returns** - - the name of the key. - - - - - - - - - - - -.. _getValue: - -.. _getValue__: - -.. _ApiKey_getValue: - -.. _ApiKey_getValue__: - -.. _io_realm_mongodb_auth_ApiKey_getValue: - -.. _io_realm_mongodb_auth_ApiKey_getValue__: - - - -getValue --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getValue ` () - | - - - - - * - Returns this keys value. This value is only returned when the key is created. After that the value is no longer visible. - - - - - - - **Returns** - - the value of this key. Is only returned when the key is created. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _ApiKey_hashCode: - -.. _ApiKey_hashCode__: - -.. _io_realm_mongodb_auth_ApiKey_hashCode: - -.. _io_realm_mongodb_auth_ApiKey_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isEnabled: - -.. _isEnabled__: - -.. _ApiKey_isEnabled: - -.. _ApiKey_isEnabled__: - -.. _io_realm_mongodb_auth_ApiKey_isEnabled: - -.. _io_realm_mongodb_auth_ApiKey_isEnabled__: - - - -isEnabled ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEnabled ` () - | - - - - - * - Returns whether or not this key is currently enabled. - - - - - - - **Returns** - - if the key is enabled or not. - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _ApiKey_toString: - -.. _ApiKey_toString__: - -.. _io_realm_mongodb_auth_ApiKey_toString: - -.. _io_realm_mongodb_auth_ApiKey_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt b/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt deleted file mode 100644 index 896e711a3a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/auth/ApiKeyAuth.txt +++ /dev/null @@ -1,1586 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class ApiKeyAuth -^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_auth_ApiKeyAuth: - - - -io.realm.mongodb.auth -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.auth.ApiKeyAuth - - -This class exposes functionality for a user to manage API keys under their control. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - protected abstract **void** - - | :ref:`call ` ( - | **int** functionType, - | `String `__ arg, - | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback - | ) - - - - - - - - * - public :ref:`ApiKey ` - - | :ref:`create ` ( - | `String `__ name - | ) - - - Creates a user API key that can be used to authenticate as the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`createAsync ` ( - | `String `__ name, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Asynchronously creates a user API key that can be used to authenticate as the user. - - - - - * - public **void** - - | :ref:`delete ` ( - | **ObjectId** id - | ) - - - Deletes a specific API key created by the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`deleteAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Deletes a specific API key created by the user. - - - - - * - public **void** - - | :ref:`disable ` ( - | **ObjectId** id - | ) - - - Disables a specific API key created by the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`disableAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Disables a specific API key created by the user. - - - - - * - public **void** - - | :ref:`enable ` ( - | **ObjectId** id - | ) - - - Enables a specific API key created by the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`enableAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Enables a specific API key created by the user. - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public :ref:`ApiKey ` - - | :ref:`fetch ` ( - | **ObjectId** id - | ) - - - Fetches a specific user API key associated with the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`fetchAll ` ( - | :ref:`io.realm.mongodb.App.Callback\> ` callback - | ) - - - Fetches all API keys associated with the user. - - - - - * - public `List `__ - - | :ref:`fetchAll ` () - | - - - Fetches all API keys associated with the user. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`fetchAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Fetches a specific user API key associated with the user. - - - - - * - public :ref:`App ` - - | :ref:`getApp ` () - | - - - Returns the :ref:`App ` that this instance in associated with. - - - - - - - * - public :ref:`User ` - - | :ref:`getUser ` () - | - - - Returns the :ref:`User ` that this instance in associated with. - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _call: - -.. _call__: - -.. _ApiKeyAuth_call: - -.. _ApiKeyAuth_call__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call__: - - - -call ----- - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int_java_lang_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__java_lang_String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int_String_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. _ApiKeyAuth_call_int__String__OsJavaNetworkTransport_NetworkTransportJNIResultCallback_: - -.. list-table:: - :header-rows: 1 - - * - | protected abstract **void** :ref:`call ` ( - | **int** functionType, - | `String `__ arg, - | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _create: - -.. _create__: - -.. _ApiKeyAuth_create: - -.. _ApiKeyAuth_create__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_create: - -.. _io_realm_mongodb_auth_ApiKeyAuth_create__: - - - -create ------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_create_java_lang_String_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_create_String_: - -.. _create_java_lang_String_: - -.. _create_String_: - -.. _ApiKeyAuth_create_java_lang_String_: - -.. _ApiKeyAuth_create_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ApiKey ` :ref:`create ` ( - | `String `__ name - | ) - - - - - * - Creates a user API key that can be used to authenticate as the user.The value of the key must be persisted at this time as this is the only time it is visible. - - The key is enabled when created. It can be disabled by calling :ref:`disable(ObjectId) ` . - - - - - - - - - **Parameters** - - - ``name`` - the name of the key - - - - - - - - **Returns** - - the new API key for the user. - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to create the API key. - - - - - - - - - - - - -.. _createAsync: - -.. _createAsync__: - -.. _ApiKeyAuth_createAsync: - -.. _ApiKeyAuth_createAsync__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync__: - - - -createAsync ------------ - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String__App_Callback_: - -.. _createAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _createAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _createAsync_java_lang_String_Callback_: - -.. _createAsync_java_lang_String__Callback_: - -.. _createAsync_java_lang_String_App_Callback_: - -.. _createAsync_java_lang_String__App_Callback_: - -.. _createAsync_String_io_realm_mongodb_App_Callback_: - -.. _createAsync_String__io_realm_mongodb_App_Callback_: - -.. _createAsync_String_Callback_: - -.. _createAsync_String__Callback_: - -.. _createAsync_String_App_Callback_: - -.. _createAsync_String__App_Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String_Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String__Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String_App_Callback_: - -.. _ApiKeyAuth_createAsync_java_lang_String__App_Callback_: - -.. _ApiKeyAuth_createAsync_String_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_createAsync_String__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_createAsync_String_Callback_: - -.. _ApiKeyAuth_createAsync_String__Callback_: - -.. _ApiKeyAuth_createAsync_String_App_Callback_: - -.. _ApiKeyAuth_createAsync_String__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_createAsync_String__App_Callback_ApiKey__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`createAsync ` ( - | `String `__ name, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Asynchronously creates a user API key that can be used to authenticate as the user.The value of the key must be persisted at this time as this is the only time it is visible. - - The key is enabled when created. It can be disabled by calling :ref:`disable(ObjectId) ` . - - - - - - - - - **Parameters** - - - ``name`` - the name of the key - - - - - ``callback`` - callback when key creation has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _delete: - -.. _delete__: - -.. _ApiKeyAuth_delete: - -.. _ApiKeyAuth_delete__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_delete: - -.. _io_realm_mongodb_auth_ApiKeyAuth_delete__: - - - -delete ------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_delete_ObjectId_: - -.. _delete_ObjectId_: - -.. _ApiKeyAuth_delete_ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`delete ` ( - | **ObjectId** id - | ) - - - - - * - Deletes a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to delete. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to delete the API key. - - - - - - - - - - - - -.. _deleteAsync: - -.. _deleteAsync__: - -.. _ApiKeyAuth_deleteAsync: - -.. _ApiKeyAuth_deleteAsync__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync__: - - - -deleteAsync ------------ - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId__App_Callback_: - -.. _deleteAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _deleteAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _deleteAsync_ObjectId_Callback_: - -.. _deleteAsync_ObjectId__Callback_: - -.. _deleteAsync_ObjectId_App_Callback_: - -.. _deleteAsync_ObjectId__App_Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId_Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId__Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId_App_Callback_: - -.. _ApiKeyAuth_deleteAsync_ObjectId__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_deleteAsync_ObjectId__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`deleteAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Deletes a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to delete. - - - - - ``callback`` - callback used when the was deleted or the call failed. The callback will always happen on the same thread as this method was called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _disable: - -.. _disable__: - -.. _ApiKeyAuth_disable: - -.. _ApiKeyAuth_disable__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disable: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disable__: - - - -disable -------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_disable_ObjectId_: - -.. _disable_ObjectId_: - -.. _ApiKeyAuth_disable_ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`disable ` ( - | **ObjectId** id - | ) - - - - - * - Disables a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to disable. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to disable the API key. - - - - - - - - - - - - -.. _disableAsync: - -.. _disableAsync__: - -.. _ApiKeyAuth_disableAsync: - -.. _ApiKeyAuth_disableAsync__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync__: - - - -disableAsync ------------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId__App_Callback_: - -.. _disableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _disableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _disableAsync_ObjectId_Callback_: - -.. _disableAsync_ObjectId__Callback_: - -.. _disableAsync_ObjectId_App_Callback_: - -.. _disableAsync_ObjectId__App_Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId_Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId__Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId_App_Callback_: - -.. _ApiKeyAuth_disableAsync_ObjectId__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_disableAsync_ObjectId__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`disableAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Disables a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to disable. - - - - - ``callback`` - callback used when the key was disabled or the call failed. The callback will always happen on the same thread as this method was called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _enable: - -.. _enable__: - -.. _ApiKeyAuth_enable: - -.. _ApiKeyAuth_enable__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enable: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enable__: - - - -enable ------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_enable_ObjectId_: - -.. _enable_ObjectId_: - -.. _ApiKeyAuth_enable_ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`enable ` ( - | **ObjectId** id - | ) - - - - - * - Enables a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to enable. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to enable the API key. - - - - - - - - - - - - -.. _enableAsync: - -.. _enableAsync__: - -.. _ApiKeyAuth_enableAsync: - -.. _ApiKeyAuth_enableAsync__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync__: - - - -enableAsync ------------ - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId__App_Callback_: - -.. _enableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _enableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _enableAsync_ObjectId_Callback_: - -.. _enableAsync_ObjectId__Callback_: - -.. _enableAsync_ObjectId_App_Callback_: - -.. _enableAsync_ObjectId__App_Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId_Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId__Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId_App_Callback_: - -.. _ApiKeyAuth_enableAsync_ObjectId__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_enableAsync_ObjectId__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`enableAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Enables a specific API key created by the user. - - - - - **Parameters** - - - ``id`` - the id of the key to enable. - - - - - ``callback`` - callback used when the key was enabled or the call failed. The callback will always happen on the same thread as this method was called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _ApiKeyAuth_equals: - -.. _ApiKeyAuth_equals__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_equals: - -.. _io_realm_mongodb_auth_ApiKeyAuth_equals__: - - - -equals ------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_equals_java_lang_Object_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _ApiKeyAuth_equals_java_lang_Object_: - -.. _ApiKeyAuth_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _fetch: - -.. _fetch__: - -.. _ApiKeyAuth_fetch: - -.. _ApiKeyAuth_fetch__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetch: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetch__: - - - -fetch ------ - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetch_ObjectId_: - -.. _fetch_ObjectId_: - -.. _ApiKeyAuth_fetch_ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ApiKey ` :ref:`fetch ` ( - | **ObjectId** id - | ) - - - - - * - Fetches a specific user API key associated with the user. - - - - - **Parameters** - - - ``id`` - the id of the key to fetch. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to fetch the API key. - - - - - - - - - - - - -.. _fetchAll: - -.. _fetchAll__: - -.. _ApiKeyAuth_fetchAll: - -.. _ApiKeyAuth_fetchAll__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll__: - - - -fetchAll --------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll_App_Callback_: - -.. _fetchAll_io_realm_mongodb_App_Callback_: - -.. _fetchAll_Callback_: - -.. _fetchAll_App_Callback_: - -.. _ApiKeyAuth_fetchAll_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_fetchAll_Callback_: - -.. _ApiKeyAuth_fetchAll_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAll_App_Callback_List_ApiKey___: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`fetchAll ` ( - | :ref:`io.realm.mongodb.App.Callback\> ` callback - | ) - - - - - * - Fetches all API keys associated with the user. - - - - - **Parameters** - - - ``callback`` - callback used when the keys were fetched or the call failed. The callback will always happen on the same thread as this method was called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public `List `__ :ref:`fetchAll ` () - | - - - - - * - Fetches all API keys associated with the user. - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to fetch the API keys. - - - - - - - - - - - - -.. _fetchAsync: - -.. _fetchAsync__: - -.. _ApiKeyAuth_fetchAsync: - -.. _ApiKeyAuth_fetchAsync__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync__: - - - -fetchAsync ----------- - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId__Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId_App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId__App_Callback_: - -.. _fetchAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _fetchAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _fetchAsync_ObjectId_Callback_: - -.. _fetchAsync_ObjectId__Callback_: - -.. _fetchAsync_ObjectId_App_Callback_: - -.. _fetchAsync_ObjectId__App_Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId_io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId__io_realm_mongodb_App_Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId_Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId__Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId_App_Callback_: - -.. _ApiKeyAuth_fetchAsync_ObjectId__App_Callback_: - -.. _io_realm_mongodb_auth_ApiKeyAuth_fetchAsync_ObjectId__App_Callback_ApiKey__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`fetchAsync ` ( - | **ObjectId** id, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Fetches a specific user API key associated with the user. - - - - - **Parameters** - - - ``id`` - the id of the key to fetch. - - - - - ``callback`` - callback used when the key was fetched or the call failed. The callback will always happen on the same thread as this method was called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _getApp: - -.. _getApp__: - -.. _ApiKeyAuth_getApp: - -.. _ApiKeyAuth_getApp__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_getApp: - -.. _io_realm_mongodb_auth_ApiKeyAuth_getApp__: - - - -getApp ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`App ` :ref:`getApp ` () - | - - - - - * - Returns the :ref:`App ` that this instance in associated with. - - - - - - - - - **Returns** - - The :ref:`App ` that this instance in associated with. - - - - - - - - - - - - - -.. _getUser: - -.. _getUser__: - -.. _ApiKeyAuth_getUser: - -.. _ApiKeyAuth_getUser__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_getUser: - -.. _io_realm_mongodb_auth_ApiKeyAuth_getUser__: - - - -getUser -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`getUser ` () - | - - - - - * - Returns the :ref:`User ` that this instance in associated with. - - - - - - - - - **Returns** - - The :ref:`User ` that this instance in associated with. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _ApiKeyAuth_hashCode: - -.. _ApiKeyAuth_hashCode__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_hashCode: - -.. _io_realm_mongodb_auth_ApiKeyAuth_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _toString: - -.. _toString__: - -.. _ApiKeyAuth_toString: - -.. _ApiKeyAuth_toString__: - -.. _io_realm_mongodb_auth_ApiKeyAuth_toString: - -.. _io_realm_mongodb_auth_ApiKeyAuth_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt b/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt deleted file mode 100644 index 99653f163c..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/auth/EmailPasswordAuth.txt +++ /dev/null @@ -1,2876 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class EmailPasswordAuth -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_auth_EmailPasswordAuth: - - - -io.realm.mongodb.auth -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.auth.EmailPasswordAuth - - -Class encapsulating functionality provided when :ref:`User ` 's are logged in through the :ref:`Credentials.Provider.EMAIL_PASSWORD ` provider. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - protected abstract **void** - - | :ref:`call ` ( - | **int** functionType, - | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback, - | `java.lang.String[] `__ args - | ) - - - - - - - - * - public **void** - - | :ref:`callResetPasswordFunction ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args - | ) - - - Call the reset password function configured to the :ref:`Credentials.Provider.EMAIL_PASSWORD ` provider. - - - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`callResetPasswordFunctionAsync ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Call the reset password function configured to the :ref:`Credentials.Provider.EMAIL_PASSWORD ` provider. - - - - - - - * - public **void** - - | :ref:`confirmUser ` ( - | `String `__ token, - | `String `__ tokenId - | ) - - - Confirms a user with the given token and token id. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`confirmUserAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Confirms a user with the given token and token id. - - - - - * - public **void** - - | :ref:`registerUser ` ( - | `String `__ email, - | `String `__ password - | ) - - - Registers a new user with the given email and password. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`registerUserAsync ` ( - | `String `__ email, - | `String `__ password, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Registers a new user with the given email and password. - - - - - * - public **void** - - | :ref:`resendConfirmationEmail ` ( - | `String `__ email - | ) - - - Resend the confirmation for a user to the given email. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`resendConfirmationEmailAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Resend the confirmation for a user to the given email. - - - - - * - public **void** - - | :ref:`resetPassword ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword - | ) - - - Resets the password of a user with the given token, token id, and new password. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`resetPasswordAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Resets the newPassword of a user with the given token, token id, and new password. - - - - - * - public **void** - - | :ref:`retryCustomConfirmation ` ( - | `String `__ email - | ) - - - Retries the custom confirmation on a user for a given email. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`retryCustomConfirmationAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Retries the custom confirmation on a user for a given email. - - - - - * - public **void** - - | :ref:`sendResetPasswordEmail ` ( - | `String `__ email - | ) - - - Sends a user a password reset email for the given email. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`sendResetPasswordEmailAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Sends a user a password reset email for the given email. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _call: - -.. _call__: - -.. _EmailPasswordAuth_call: - -.. _EmailPasswordAuth_call__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call__: - - - -call ----- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. _call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. _EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_java_lang_String_: - -.. _EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__java_lang_String_: - -.. _EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String_: - -.. _EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String_: - -.. _EmailPasswordAuth_call_int_OsJavaNetworkTransport_NetworkTransportJNIResultCallback_String____: - -.. _EmailPasswordAuth_call_int__OsJavaNetworkTransport_NetworkTransportJNIResultCallback__String____: - -.. list-table:: - :header-rows: 1 - - * - | protected abstract **void** :ref:`call ` ( - | **int** functionType, - | **OsJavaNetworkTransport.NetworkTransportJNIResultCallback** callback, - | `java.lang.String[] `__ args - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _callResetPasswordFunction: - -.. _callResetPasswordFunction__: - -.. _EmailPasswordAuth_callResetPasswordFunction: - -.. _EmailPasswordAuth_callResetPasswordFunction__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction__: - - - -callResetPasswordFunction -------------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_String_java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__String__java_lang_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_String_Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__String__Object_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String_String_Object____: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunction_String__String__Object____: - -.. _callResetPasswordFunction_java_lang_String_java_lang_String_java_lang_Object_: - -.. _callResetPasswordFunction_java_lang_String__java_lang_String__java_lang_Object_: - -.. _callResetPasswordFunction_java_lang_String_java_lang_String_Object_: - -.. _callResetPasswordFunction_java_lang_String__java_lang_String__Object_: - -.. _callResetPasswordFunction_java_lang_String_java_lang_String_Object____: - -.. _callResetPasswordFunction_java_lang_String__java_lang_String__Object____: - -.. _callResetPasswordFunction_java_lang_String_String_java_lang_Object_: - -.. _callResetPasswordFunction_java_lang_String__String__java_lang_Object_: - -.. _callResetPasswordFunction_java_lang_String_String_Object_: - -.. _callResetPasswordFunction_java_lang_String__String__Object_: - -.. _callResetPasswordFunction_java_lang_String_String_Object____: - -.. _callResetPasswordFunction_java_lang_String__String__Object____: - -.. _callResetPasswordFunction_String_java_lang_String_java_lang_Object_: - -.. _callResetPasswordFunction_String__java_lang_String__java_lang_Object_: - -.. _callResetPasswordFunction_String_java_lang_String_Object_: - -.. _callResetPasswordFunction_String__java_lang_String__Object_: - -.. _callResetPasswordFunction_String_java_lang_String_Object____: - -.. _callResetPasswordFunction_String__java_lang_String__Object____: - -.. _callResetPasswordFunction_String_String_java_lang_Object_: - -.. _callResetPasswordFunction_String__String__java_lang_Object_: - -.. _callResetPasswordFunction_String_String_Object_: - -.. _callResetPasswordFunction_String__String__Object_: - -.. _callResetPasswordFunction_String_String_Object____: - -.. _callResetPasswordFunction_String__String__Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_java_lang_String_Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__java_lang_String__Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String_String_Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_java_lang_String__String__Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_java_lang_String_Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__java_lang_String__Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_String_java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__String__java_lang_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_String_Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__String__Object_: - -.. _EmailPasswordAuth_callResetPasswordFunction_String_String_Object____: - -.. _EmailPasswordAuth_callResetPasswordFunction_String__String__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`callResetPasswordFunction ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args - | ) - - - - - * - Call the reset password function configured to the :ref:`Credentials.Provider.EMAIL_PASSWORD ` provider. - - - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - ``newPassword`` - the new password of the user. - - - - - ``args`` - any additional arguments provided to the reset function. All arguments must be able to be converted to JSON compatible values using ``toString()`` . - - - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _callResetPasswordFunctionAsync: - -.. _callResetPasswordFunctionAsync__: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync__: - - - -callResetPasswordFunctionAsync ------------------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object__Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object____Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object_____Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String_String_Object____App_Callback_: - -.. _callResetPasswordFunctionAsync_java_lang_String__String__Object_____App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object__Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object____Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object_____Callback_: - -.. _callResetPasswordFunctionAsync_String_java_lang_String_Object____App_Callback_: - -.. _callResetPasswordFunctionAsync_String__java_lang_String__Object_____App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_java_lang_Object_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__java_lang_Object__Callback_: - -.. _callResetPasswordFunctionAsync_String_String_java_lang_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__java_lang_Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object__Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object__App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object____Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object_____Callback_: - -.. _callResetPasswordFunctionAsync_String_String_Object____App_Callback_: - -.. _callResetPasswordFunctionAsync_String__String__Object_____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_java_lang_String_Object____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__java_lang_String__Object_____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_java_lang_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__java_lang_Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String_String_Object____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_java_lang_String__String__Object_____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_java_lang_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__java_lang_Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_java_lang_String_Object____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__java_lang_String__Object_____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_java_lang_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__java_lang_Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object__App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String_String_Object____App_Callback_: - -.. _EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object_____App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_callResetPasswordFunctionAsync_String__String__Object[]__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`callResetPasswordFunctionAsync ` ( - | `String `__ email, - | `String `__ newPassword, - | `java.lang.Object[] `__ args, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Call the reset password function configured to the :ref:`Credentials.Provider.EMAIL_PASSWORD ` provider. - - - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - ``newPassword`` - the new password of the user. - - - - - ``args`` - any additional arguments provided to the reset function. All arguments must be able to be converted to JSON compatible values using ``toString()`` . - - - - - - - ``callback`` - callback when the reset has completed or failed. The callback will always happen on the same thread as this this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _confirmUser: - -.. _confirmUser__: - -.. _EmailPasswordAuth_confirmUser: - -.. _EmailPasswordAuth_confirmUser__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser__: - - - -confirmUser ------------ - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_java_lang_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_java_lang_String__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUser_String__String_: - -.. _confirmUser_java_lang_String_java_lang_String_: - -.. _confirmUser_java_lang_String__java_lang_String_: - -.. _confirmUser_java_lang_String_String_: - -.. _confirmUser_java_lang_String__String_: - -.. _confirmUser_String_java_lang_String_: - -.. _confirmUser_String__java_lang_String_: - -.. _confirmUser_String_String_: - -.. _confirmUser_String__String_: - -.. _EmailPasswordAuth_confirmUser_java_lang_String_java_lang_String_: - -.. _EmailPasswordAuth_confirmUser_java_lang_String__java_lang_String_: - -.. _EmailPasswordAuth_confirmUser_java_lang_String_String_: - -.. _EmailPasswordAuth_confirmUser_java_lang_String__String_: - -.. _EmailPasswordAuth_confirmUser_String_java_lang_String_: - -.. _EmailPasswordAuth_confirmUser_String__java_lang_String_: - -.. _EmailPasswordAuth_confirmUser_String_String_: - -.. _EmailPasswordAuth_confirmUser_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`confirmUser ` ( - | `String `__ token, - | `String `__ tokenId - | ) - - - - - * - Confirms a user with the given token and token id. - - - - - **Parameters** - - - ``token`` - the confirmation token. - - - - - ``tokenId`` - the id of the confirmation token. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _confirmUserAsync: - -.. _confirmUserAsync__: - -.. _EmailPasswordAuth_confirmUserAsync: - -.. _EmailPasswordAuth_confirmUserAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync__: - - - -confirmUserAsync ----------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_java_lang_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__String__App_Callback_: - -.. _confirmUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _confirmUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _confirmUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _confirmUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _confirmUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_java_lang_String_String_Callback_: - -.. _confirmUserAsync_java_lang_String__String__Callback_: - -.. _confirmUserAsync_java_lang_String_String_App_Callback_: - -.. _confirmUserAsync_java_lang_String__String__App_Callback_: - -.. _confirmUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_String_java_lang_String_Callback_: - -.. _confirmUserAsync_String__java_lang_String__Callback_: - -.. _confirmUserAsync_String_java_lang_String_App_Callback_: - -.. _confirmUserAsync_String__java_lang_String__App_Callback_: - -.. _confirmUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _confirmUserAsync_String_String_Callback_: - -.. _confirmUserAsync_String__String__Callback_: - -.. _confirmUserAsync_String_String_App_Callback_: - -.. _confirmUserAsync_String__String__App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_String_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__String__Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String_String_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_java_lang_String__String__App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_String_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__String__Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String_String_App_Callback_: - -.. _EmailPasswordAuth_confirmUserAsync_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_confirmUserAsync_String__String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`confirmUserAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Confirms a user with the given token and token id. - - - - - **Parameters** - - - ``token`` - the confirmation token. - - - - - ``tokenId`` - the id of the confirmation token. - - - - - ``callback`` - callback when confirmation has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _registerUser: - -.. _registerUser__: - -.. _EmailPasswordAuth_registerUser: - -.. _EmailPasswordAuth_registerUser__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser__: - - - -registerUser ------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_java_lang_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_java_lang_String__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUser_String__String_: - -.. _registerUser_java_lang_String_java_lang_String_: - -.. _registerUser_java_lang_String__java_lang_String_: - -.. _registerUser_java_lang_String_String_: - -.. _registerUser_java_lang_String__String_: - -.. _registerUser_String_java_lang_String_: - -.. _registerUser_String__java_lang_String_: - -.. _registerUser_String_String_: - -.. _registerUser_String__String_: - -.. _EmailPasswordAuth_registerUser_java_lang_String_java_lang_String_: - -.. _EmailPasswordAuth_registerUser_java_lang_String__java_lang_String_: - -.. _EmailPasswordAuth_registerUser_java_lang_String_String_: - -.. _EmailPasswordAuth_registerUser_java_lang_String__String_: - -.. _EmailPasswordAuth_registerUser_String_java_lang_String_: - -.. _EmailPasswordAuth_registerUser_String__java_lang_String_: - -.. _EmailPasswordAuth_registerUser_String_String_: - -.. _EmailPasswordAuth_registerUser_String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`registerUser ` ( - | `String `__ email, - | `String `__ password - | ) - - - - - * - Registers a new user with the given email and password. - - - - - **Parameters** - - - ``email`` - the email to register with. This will be the username used during log in. - - - - - ``password`` - the password to associate with the email. The password must be between 6 and 128 characters long. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to register the user. - - - - - - - - - - - - -.. _registerUserAsync: - -.. _registerUserAsync__: - -.. _EmailPasswordAuth_registerUserAsync: - -.. _EmailPasswordAuth_registerUserAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync__: - - - -registerUserAsync ------------------ - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_java_lang_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__String__App_Callback_: - -.. _registerUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _registerUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _registerUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _registerUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _registerUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_java_lang_String_String_Callback_: - -.. _registerUserAsync_java_lang_String__String__Callback_: - -.. _registerUserAsync_java_lang_String_String_App_Callback_: - -.. _registerUserAsync_java_lang_String__String__App_Callback_: - -.. _registerUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_String_java_lang_String_Callback_: - -.. _registerUserAsync_String__java_lang_String__Callback_: - -.. _registerUserAsync_String_java_lang_String_App_Callback_: - -.. _registerUserAsync_String__java_lang_String__App_Callback_: - -.. _registerUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _registerUserAsync_String_String_Callback_: - -.. _registerUserAsync_String__String__Callback_: - -.. _registerUserAsync_String_String_App_Callback_: - -.. _registerUserAsync_String__String__App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_String_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__String__Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String_String_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_java_lang_String__String__App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_String_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__String__Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String_String_App_Callback_: - -.. _EmailPasswordAuth_registerUserAsync_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_registerUserAsync_String__String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`registerUserAsync ` ( - | `String `__ email, - | `String `__ password, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Registers a new user with the given email and password. - - - - - **Parameters** - - - ``email`` - the email to register with. This will be the username used during log in. - - - - - ``password`` - the password to associated with the email. The password must be between 6 and 128 characters long. - - - - - ``callback`` - callback when registration has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - :ref:`AppException ` - if the server failed to register the user. - - - - - - - - - - - - -.. _resendConfirmationEmail: - -.. _resendConfirmationEmail__: - -.. _EmailPasswordAuth_resendConfirmationEmail: - -.. _EmailPasswordAuth_resendConfirmationEmail__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmail: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmail__: - - - -resendConfirmationEmail ------------------------ - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmail_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmail_String_: - -.. _resendConfirmationEmail_java_lang_String_: - -.. _resendConfirmationEmail_String_: - -.. _EmailPasswordAuth_resendConfirmationEmail_java_lang_String_: - -.. _EmailPasswordAuth_resendConfirmationEmail_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`resendConfirmationEmail ` ( - | `String `__ email - | ) - - - - - * - Resend the confirmation for a user to the given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _resendConfirmationEmailAsync: - -.. _resendConfirmationEmailAsync__: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync__: - - - -resendConfirmationEmailAsync ----------------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String__App_Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String_Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String__Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String_App_Callback_: - -.. _resendConfirmationEmailAsync_java_lang_String__App_Callback_: - -.. _resendConfirmationEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _resendConfirmationEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _resendConfirmationEmailAsync_String_Callback_: - -.. _resendConfirmationEmailAsync_String__Callback_: - -.. _resendConfirmationEmailAsync_String_App_Callback_: - -.. _resendConfirmationEmailAsync_String__App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String__Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String_App_Callback_: - -.. _EmailPasswordAuth_resendConfirmationEmailAsync_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resendConfirmationEmailAsync_String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`resendConfirmationEmailAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Resend the confirmation for a user to the given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - ``callback`` - callback when resending the email has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _resetPassword: - -.. _resetPassword__: - -.. _EmailPasswordAuth_resetPassword: - -.. _EmailPasswordAuth_resetPassword__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword__: - - - -resetPassword -------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String__java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String_java_lang_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String__java_lang_String__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String__String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_java_lang_String__String__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String_java_lang_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String__java_lang_String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String_java_lang_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String__java_lang_String__String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String_String_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String__String__java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String_String_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPassword_String__String__String_: - -.. _resetPassword_java_lang_String_java_lang_String_java_lang_String_: - -.. _resetPassword_java_lang_String__java_lang_String__java_lang_String_: - -.. _resetPassword_java_lang_String_java_lang_String_String_: - -.. _resetPassword_java_lang_String__java_lang_String__String_: - -.. _resetPassword_java_lang_String_String_java_lang_String_: - -.. _resetPassword_java_lang_String__String__java_lang_String_: - -.. _resetPassword_java_lang_String_String_String_: - -.. _resetPassword_java_lang_String__String__String_: - -.. _resetPassword_String_java_lang_String_java_lang_String_: - -.. _resetPassword_String__java_lang_String__java_lang_String_: - -.. _resetPassword_String_java_lang_String_String_: - -.. _resetPassword_String__java_lang_String__String_: - -.. _resetPassword_String_String_java_lang_String_: - -.. _resetPassword_String__String__java_lang_String_: - -.. _resetPassword_String_String_String_: - -.. _resetPassword_String__String__String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String_java_lang_String_java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String__java_lang_String__java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String_java_lang_String_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String__java_lang_String__String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String_String_java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String__String__java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String_String_String_: - -.. _EmailPasswordAuth_resetPassword_java_lang_String__String__String_: - -.. _EmailPasswordAuth_resetPassword_String_java_lang_String_java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_String__java_lang_String__java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_String_java_lang_String_String_: - -.. _EmailPasswordAuth_resetPassword_String__java_lang_String__String_: - -.. _EmailPasswordAuth_resetPassword_String_String_java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_String__String__java_lang_String_: - -.. _EmailPasswordAuth_resetPassword_String_String_String_: - -.. _EmailPasswordAuth_resetPassword_String__String__String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`resetPassword ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword - | ) - - - - - * - Resets the password of a user with the given token, token id, and new password. - - - - - **Parameters** - - - ``token`` - the reset password token. - - - - - ``tokenId`` - the id of the reset password token. - - - - - ``newPassword`` - the new password for the user identified by the ``token`` . The password must be between 6 and 128 characters long. - - - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _resetPasswordAsync: - -.. _resetPasswordAsync__: - -.. _EmailPasswordAuth_resetPasswordAsync: - -.. _EmailPasswordAuth_resetPasswordAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync__: - - - -resetPasswordAsync ------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String_String_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__String__App_Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__App_Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_String_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__String__Callback_: - -.. _resetPasswordAsync_java_lang_String_java_lang_String_String_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__java_lang_String__String__App_Callback_: - -.. _resetPasswordAsync_java_lang_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String_String_java_lang_String_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__java_lang_String__Callback_: - -.. _resetPasswordAsync_java_lang_String_String_java_lang_String_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__java_lang_String__App_Callback_: - -.. _resetPasswordAsync_java_lang_String_String_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_java_lang_String_String_String_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__String__Callback_: - -.. _resetPasswordAsync_java_lang_String_String_String_App_Callback_: - -.. _resetPasswordAsync_java_lang_String__String__String__App_Callback_: - -.. _resetPasswordAsync_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String_java_lang_String_java_lang_String_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__java_lang_String__Callback_: - -.. _resetPasswordAsync_String_java_lang_String_java_lang_String_App_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__java_lang_String__App_Callback_: - -.. _resetPasswordAsync_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String_java_lang_String_String_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__String__Callback_: - -.. _resetPasswordAsync_String_java_lang_String_String_App_Callback_: - -.. _resetPasswordAsync_String__java_lang_String__String__App_Callback_: - -.. _resetPasswordAsync_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String_String_java_lang_String_Callback_: - -.. _resetPasswordAsync_String__String__java_lang_String__Callback_: - -.. _resetPasswordAsync_String_String_java_lang_String_App_Callback_: - -.. _resetPasswordAsync_String__String__java_lang_String__App_Callback_: - -.. _resetPasswordAsync_String_String_String_io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String__String__String__io_realm_mongodb_App_Callback_: - -.. _resetPasswordAsync_String_String_String_Callback_: - -.. _resetPasswordAsync_String__String__String__Callback_: - -.. _resetPasswordAsync_String_String_String_App_Callback_: - -.. _resetPasswordAsync_String__String__String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_java_lang_String_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__java_lang_String__String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String_String_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_java_lang_String__String__String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_java_lang_String_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__java_lang_String__String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_String_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__String__Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String_String_String_App_Callback_: - -.. _EmailPasswordAuth_resetPasswordAsync_String__String__String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_resetPasswordAsync_String__String__String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`resetPasswordAsync ` ( - | `String `__ token, - | `String `__ tokenId, - | `String `__ newPassword, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Resets the newPassword of a user with the given token, token id, and new password. - - - - - **Parameters** - - - ``token`` - the reset password token. - - - - - ``tokenId`` - the id of the reset password token. - - - - - ``newPassword`` - the new password for the user identified by the ``token`` . The password must be between 6 and 128 characters long. - - - - - - - ``callback`` - callback when the reset has completed or failed. The callback will always happen on the same thread as this this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _retryCustomConfirmation: - -.. _retryCustomConfirmation__: - -.. _EmailPasswordAuth_retryCustomConfirmation: - -.. _EmailPasswordAuth_retryCustomConfirmation__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmation: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmation__: - - - -retryCustomConfirmation ------------------------ - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmation_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmation_String_: - -.. _retryCustomConfirmation_java_lang_String_: - -.. _retryCustomConfirmation_String_: - -.. _EmailPasswordAuth_retryCustomConfirmation_java_lang_String_: - -.. _EmailPasswordAuth_retryCustomConfirmation_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`retryCustomConfirmation ` ( - | `String `__ email - | ) - - - - - * - Retries the custom confirmation on a user for a given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _retryCustomConfirmationAsync: - -.. _retryCustomConfirmationAsync__: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync__: - - - -retryCustomConfirmationAsync ----------------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String__App_Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String_Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String__Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String_App_Callback_: - -.. _retryCustomConfirmationAsync_java_lang_String__App_Callback_: - -.. _retryCustomConfirmationAsync_String_io_realm_mongodb_App_Callback_: - -.. _retryCustomConfirmationAsync_String__io_realm_mongodb_App_Callback_: - -.. _retryCustomConfirmationAsync_String_Callback_: - -.. _retryCustomConfirmationAsync_String__Callback_: - -.. _retryCustomConfirmationAsync_String_App_Callback_: - -.. _retryCustomConfirmationAsync_String__App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String__Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String_App_Callback_: - -.. _EmailPasswordAuth_retryCustomConfirmationAsync_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_retryCustomConfirmationAsync_String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`retryCustomConfirmationAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Retries the custom confirmation on a user for a given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - ``callback`` - callback when retrying the custom confirmation has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called from a non-looper thread. - - - - - - - - - - - - -.. _sendResetPasswordEmail: - -.. _sendResetPasswordEmail__: - -.. _EmailPasswordAuth_sendResetPasswordEmail: - -.. _EmailPasswordAuth_sendResetPasswordEmail__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmail: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmail__: - - - -sendResetPasswordEmail ----------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmail_java_lang_String_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmail_String_: - -.. _sendResetPasswordEmail_java_lang_String_: - -.. _sendResetPasswordEmail_String_: - -.. _EmailPasswordAuth_sendResetPasswordEmail_java_lang_String_: - -.. _EmailPasswordAuth_sendResetPasswordEmail_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`sendResetPasswordEmail ` ( - | `String `__ email - | ) - - - - - * - Sends a user a password reset email for the given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - -.. _sendResetPasswordEmailAsync: - -.. _sendResetPasswordEmailAsync__: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync__: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync__: - - - -sendResetPasswordEmailAsync ---------------------------- - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String__Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String_App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String__App_Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String_Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String__Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String_App_Callback_: - -.. _sendResetPasswordEmailAsync_java_lang_String__App_Callback_: - -.. _sendResetPasswordEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _sendResetPasswordEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _sendResetPasswordEmailAsync_String_Callback_: - -.. _sendResetPasswordEmailAsync_String__Callback_: - -.. _sendResetPasswordEmailAsync_String_App_Callback_: - -.. _sendResetPasswordEmailAsync_String__App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_java_lang_String__App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String_io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String__io_realm_mongodb_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String__Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String_App_Callback_: - -.. _EmailPasswordAuth_sendResetPasswordEmailAsync_String__App_Callback_: - -.. _io_realm_mongodb_auth_EmailPasswordAuth_sendResetPasswordEmailAsync_String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`sendResetPasswordEmailAsync ` ( - | `String `__ email, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Sends a user a password reset email for the given email. - - - - - **Parameters** - - - ``email`` - the email of the user. - - - - - ``callback`` - callback when sending the email has completed or failed. The callback will always happen on the same thread as this method is called on. - - - - - - - - - - **Throws** - - - :ref:`AppException ` - if the server failed to confirm the user. - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt b/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt deleted file mode 100644 index 685bc83141..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/auth/GoogleAuthType.txt +++ /dev/null @@ -1,251 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum GoogleAuthType -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_auth_GoogleAuthType: - - - -io.realm.mongodb.auth -===================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.auth.GoogleAuthType - - -This enum contains the list of Google authentication types supported by MongoDB Realm. - - -.. seealso:: - - - - - `Google Authentication `__ - - - - - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`AUTH_CODE ` - - - - - - - * - :ref:`ID_TOKEN ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`GoogleAuthType ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`GoogleAuthType ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_auth_GoogleAuthType_AUTH_CODE: - -.. _GoogleAuthType_AUTH_CODE: - - - -``AUTH_CODE`` --------------- - -public static final :ref:`GoogleAuthType ` - - - - - -.. _io_realm_mongodb_auth_GoogleAuthType_ID_TOKEN: - -.. _GoogleAuthType_ID_TOKEN: - - - -``ID_TOKEN`` -------------- - -public static final :ref:`GoogleAuthType ` - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _GoogleAuthType_valueOf: - -.. _GoogleAuthType_valueOf__: - -.. _io_realm_mongodb_auth_GoogleAuthType_valueOf: - -.. _io_realm_mongodb_auth_GoogleAuthType_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_auth_GoogleAuthType_valueOf_java_lang_String_: - -.. _io_realm_mongodb_auth_GoogleAuthType_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _GoogleAuthType_valueOf_java_lang_String_: - -.. _GoogleAuthType_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`GoogleAuthType ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _GoogleAuthType_values: - -.. _GoogleAuthType_values__: - -.. _io_realm_mongodb_auth_GoogleAuthType_values: - -.. _io_realm_mongodb_auth_GoogleAuthType_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`GoogleAuthType ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/functions.txt b/source/sdk/java/api/io/realm/mongodb/functions.txt deleted file mode 100644 index 1a2b2d9a6b..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/functions.txt +++ /dev/null @@ -1,30 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.functions -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - Functions - - - -| - -- :ref:`io.realm.mongodb.functions.Functions ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt b/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt deleted file mode 100644 index bc800889e7..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/functions/Functions.txt +++ /dev/null @@ -1,2025 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Functions -^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_functions_Functions: - - - -io.realm.mongodb.functions -========================== - - - | `java.lang.Object `__ - | io.realm.mongodb.functions.Functions - - -A *Functions* manager to call remote Realm functions for the associated Realm App.Arguments and results are encoded/decoded with the *Functions'* codec registry either inherited from the :ref:`AppConfiguration.getDefaultCodecRegistry() ` or set explicitly when creating the - -*Functions*-instance through :ref:`User.getFunctions(CodecRegistry) ` or through the individual calls to :ref:`callFunction(String, List, Class, CodecRegistry) ` . - - - - - - -.. seealso:: - - - - - :ref:`User.getFunctions() ` - - - - - :ref:`User.getFunctions(CodecRegistry) ` - - - - - :ref:`App.getFunctions(User) ` - - - - - :ref:`App.getFunctions(User, CodecRegistry) ` - - - - - :ref:`AppConfiguration ` - - - - - **CodecRegistry** - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **ResultT** - - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **** resultDecoder - | ) - - - Call a MongoDB Realm function synchronously with custom result decoder. - - - - - * - public **ResultT** - - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass - | ) - - - Call a MongoDB Realm function synchronously with default codec registry encoding/decoding arguments/results. - - - - - * - public **ResultT** - - | :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | **CodecRegistry** codecRegistry - | ) - - - Call a MongoDB Realm function synchronously with custom codec registry encoding/decoding arguments/results. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **** resultDecoder, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Call a MongoDB Realm function asynchronously with custom result decoder. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Call a MongoDB Realm function asynchronously with custom codec registry for encoding/decoding arguments/results. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | **CodecRegistry** codecRegistry, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Call a MongoDB Realm function asynchronously with custom codec registry for encoding/decoding arguments/results. - - - - - * - public :ref:`App ` - - | :ref:`getApp ` () - | - - - Returns the :ref:`App ` that this instance in associated with. - - - - - - - * - public **CodecRegistry** - - | :ref:`getDefaultCodecRegistry ` () - | - - - Returns the default codec registry used for encoding arguments and decoding results for this *Realm functions* instance. - - - - - * - public :ref:`User ` - - | :ref:`getUser ` () - | - - - Returns the :ref:`User ` that this instance in associated with. - - - - - - - * - protected abstract **T** - - | :ref:`invoke ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **CodecRegistry** codecRegistry, - | **** resultDecoder - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _callFunction: - -.. _callFunction__: - -.. _Functions_callFunction: - -.. _Functions_callFunction__: - -.. _io_realm_mongodb_functions_Functions_callFunction: - -.. _io_realm_mongodb_functions_Functions_callFunction__: - - - -callFunction ------------- - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_java_util_List__any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__java_util_List___any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_List__any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__List___any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_java_util_List__any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__java_util_List___any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_List__any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List___any__: - -.. _callFunction_java_lang_String_java_util_List__any__: - -.. _callFunction_java_lang_String__java_util_List___any__: - -.. _callFunction_java_lang_String_List__any__: - -.. _callFunction_java_lang_String__List___any__: - -.. _callFunction_String_java_util_List__any__: - -.. _callFunction_String__java_util_List___any__: - -.. _callFunction_String_List__any__: - -.. _callFunction_String__List___any__: - -.. _Functions_callFunction_java_lang_String_java_util_List__any__: - -.. _Functions_callFunction_java_lang_String__java_util_List___any__: - -.. _Functions_callFunction_java_lang_String_List__any__: - -.. _Functions_callFunction_java_lang_String__List___any__: - -.. _Functions_callFunction_String_java_util_List__any__: - -.. _Functions_callFunction_String__java_util_List___any__: - -.. _Functions_callFunction_String_List__any__: - -.. _Functions_callFunction_String__List___any__: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List______any__: - -.. list-table:: - :header-rows: 1 - - * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **** resultDecoder - | ) - - - - - * - Call a MongoDB Realm function synchronously with custom result decoder.The arguments will be encoded with the default codec registry encoding. - - - - - **Type Parameters** - - - ``ResultT`` - The type that the response will be decoded as using the ``resultDecoder`` - - - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultDecoder`` - The decoder used to decode the result. - - - - - - - - **Returns** - - Result of the Realm function. - - - - - **Throws** - - - :ref:`AppException ` - if the request failed in some way. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunction(String, List, Class, CodecRegistry) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_java_util_List_java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__java_util_List__java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_java_util_List_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__java_util_List__Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_List_java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__List__java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_List_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__List__Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_java_util_List_java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__java_util_List__java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_java_util_List_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__java_util_List__Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_List_java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List__java_lang_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_List_Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List__Class_: - -.. _callFunction_java_lang_String_java_util_List_java_lang_Class_: - -.. _callFunction_java_lang_String__java_util_List__java_lang_Class_: - -.. _callFunction_java_lang_String_java_util_List_Class_: - -.. _callFunction_java_lang_String__java_util_List__Class_: - -.. _callFunction_java_lang_String_List_java_lang_Class_: - -.. _callFunction_java_lang_String__List__java_lang_Class_: - -.. _callFunction_java_lang_String_List_Class_: - -.. _callFunction_java_lang_String__List__Class_: - -.. _callFunction_String_java_util_List_java_lang_Class_: - -.. _callFunction_String__java_util_List__java_lang_Class_: - -.. _callFunction_String_java_util_List_Class_: - -.. _callFunction_String__java_util_List__Class_: - -.. _callFunction_String_List_java_lang_Class_: - -.. _callFunction_String__List__java_lang_Class_: - -.. _callFunction_String_List_Class_: - -.. _callFunction_String__List__Class_: - -.. _Functions_callFunction_java_lang_String_java_util_List_java_lang_Class_: - -.. _Functions_callFunction_java_lang_String__java_util_List__java_lang_Class_: - -.. _Functions_callFunction_java_lang_String_java_util_List_Class_: - -.. _Functions_callFunction_java_lang_String__java_util_List__Class_: - -.. _Functions_callFunction_java_lang_String_List_java_lang_Class_: - -.. _Functions_callFunction_java_lang_String__List__java_lang_Class_: - -.. _Functions_callFunction_java_lang_String_List_Class_: - -.. _Functions_callFunction_java_lang_String__List__Class_: - -.. _Functions_callFunction_String_java_util_List_java_lang_Class_: - -.. _Functions_callFunction_String__java_util_List__java_lang_Class_: - -.. _Functions_callFunction_String_java_util_List_Class_: - -.. _Functions_callFunction_String__java_util_List__Class_: - -.. _Functions_callFunction_String_List_java_lang_Class_: - -.. _Functions_callFunction_String__List__java_lang_Class_: - -.. _Functions_callFunction_String_List_Class_: - -.. _Functions_callFunction_String__List__Class_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List_____Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Call a MongoDB Realm function synchronously with default codec registry encoding/decoding arguments/results. - - - **Type Parameters** - - - ``ResultT`` - The type that the response will be decoded as using the default codec registry. - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultClass`` - The type that the functions result should be converted to. - - - - - - - - **Returns** - - Result of the Realm function. - - - - - **Throws** - - - :ref:`AppException ` - if the request failed in some way. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunction(String, List, Class, CodecRegistry) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_java_util_List_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__java_util_List__Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_List_java_lang_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__List__java_lang_Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String_List_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_java_lang_String__List__Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_java_util_List_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__java_util_List__Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_List_java_lang_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List__java_lang_Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String_List_Class_CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List__Class__CodecRegistry_: - -.. _callFunction_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _callFunction_java_lang_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _callFunction_java_lang_String_java_util_List_Class_CodecRegistry_: - -.. _callFunction_java_lang_String__java_util_List__Class__CodecRegistry_: - -.. _callFunction_java_lang_String_List_java_lang_Class_CodecRegistry_: - -.. _callFunction_java_lang_String__List__java_lang_Class__CodecRegistry_: - -.. _callFunction_java_lang_String_List_Class_CodecRegistry_: - -.. _callFunction_java_lang_String__List__Class__CodecRegistry_: - -.. _callFunction_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _callFunction_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _callFunction_String_java_util_List_Class_CodecRegistry_: - -.. _callFunction_String__java_util_List__Class__CodecRegistry_: - -.. _callFunction_String_List_java_lang_Class_CodecRegistry_: - -.. _callFunction_String__List__java_lang_Class__CodecRegistry_: - -.. _callFunction_String_List_Class_CodecRegistry_: - -.. _callFunction_String__List__Class__CodecRegistry_: - -.. _Functions_callFunction_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _Functions_callFunction_java_lang_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _Functions_callFunction_java_lang_String_java_util_List_Class_CodecRegistry_: - -.. _Functions_callFunction_java_lang_String__java_util_List__Class__CodecRegistry_: - -.. _Functions_callFunction_java_lang_String_List_java_lang_Class_CodecRegistry_: - -.. _Functions_callFunction_java_lang_String__List__java_lang_Class__CodecRegistry_: - -.. _Functions_callFunction_java_lang_String_List_Class_CodecRegistry_: - -.. _Functions_callFunction_java_lang_String__List__Class__CodecRegistry_: - -.. _Functions_callFunction_String_java_util_List_java_lang_Class_CodecRegistry_: - -.. _Functions_callFunction_String__java_util_List__java_lang_Class__CodecRegistry_: - -.. _Functions_callFunction_String_java_util_List_Class_CodecRegistry_: - -.. _Functions_callFunction_String__java_util_List__Class__CodecRegistry_: - -.. _Functions_callFunction_String_List_java_lang_Class_CodecRegistry_: - -.. _Functions_callFunction_String__List__java_lang_Class__CodecRegistry_: - -.. _Functions_callFunction_String_List_Class_CodecRegistry_: - -.. _Functions_callFunction_String__List__Class__CodecRegistry_: - -.. _io_realm_mongodb_functions_Functions_callFunction_String__List_____Class_ResultT___CodecRegistry_: - -.. list-table:: - :header-rows: 1 - - * - | public **ResultT** :ref:`callFunction ` <**ResultT** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | **CodecRegistry** codecRegistry - | ) - - - - - * - Call a MongoDB Realm function synchronously with custom codec registry encoding/decoding arguments/results. - - - **Type Parameters** - - - ``ResultT`` - The type that the response will be decoded as using the ``codecRegistry`` . - - - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultClass`` - The type that the functions result should be converted to. - - - - - ``codecRegistry`` - Codec registry to use for argument encoding and result decoding. - - - - - - - - **Returns** - - Result of the Realm function. - - - - - **Throws** - - - :ref:`AppException ` - if the request failed in some way. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunctionAsync(String, List, Class, CodecRegistry, App.Callback) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - - - -.. _callFunctionAsync: - -.. _callFunctionAsync__: - -.. _Functions_callFunctionAsync: - -.. _Functions_callFunctionAsync__: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync__: - - - -callFunctionAsync ------------------ - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List__any__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List___any___Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List__any__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List___any___App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List__any__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List___any___io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List__any__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List___any___Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List__any__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List___any___App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List__any__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List___any___Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List__any__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List___any___App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List__any__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List___any___io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List__any__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List___any___Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List__any__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List___any___App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List__any__Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List___any___Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List__any__App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List___any___App_Callback_: - -.. _callFunctionAsync_java_lang_String_List__any__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List___any___io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_List__any__Callback_: - -.. _callFunctionAsync_java_lang_String__List___any___Callback_: - -.. _callFunctionAsync_java_lang_String_List__any__App_Callback_: - -.. _callFunctionAsync_java_lang_String__List___any___App_Callback_: - -.. _callFunctionAsync_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_java_util_List__any__Callback_: - -.. _callFunctionAsync_String__java_util_List___any___Callback_: - -.. _callFunctionAsync_String_java_util_List__any__App_Callback_: - -.. _callFunctionAsync_String__java_util_List___any___App_Callback_: - -.. _callFunctionAsync_String_List__any__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__List___any___io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_List__any__Callback_: - -.. _callFunctionAsync_String__List___any___Callback_: - -.. _callFunctionAsync_String_List__any__App_Callback_: - -.. _callFunctionAsync_String__List___any___App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List__any__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List___any___Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List__any__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List___any___App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List__any__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List___any___io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List__any__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List___any___Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List__any__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List___any___App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List__any__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List___any___io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List__any__Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List___any___Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List__any__App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List___any___App_Callback_: - -.. _Functions_callFunctionAsync_String_List__any__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__List___any___io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_List__any__Callback_: - -.. _Functions_callFunctionAsync_String__List___any___Callback_: - -.. _Functions_callFunctionAsync_String_List__any__App_Callback_: - -.. _Functions_callFunctionAsync_String__List___any___App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List______any___App_Callback_T__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **** resultDecoder, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Call a MongoDB Realm function asynchronously with custom result decoder.This is the asynchronous equivalent of **callFunction(String, List, Decoder)**. - - - - - - - **Type Parameters** - - - ``T`` - The type that the response will be decoded as using the ``resultDecoder`` - - - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultDecoder`` - The decoder used to decode the result. - - - - - ``callback`` - The callback that will receive the result or any errors from the request. - - - - - - - - **Returns** - - The task representing the ongoing operation. - - - - - **Throws** - - - `IllegalStateException `__ - if not called on a looper thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunction(String, List, Class) ` - - - - - :ref:`callFunctionAsync(String, List, Class, CodecRegistry, App.Callback) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__App_Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__App_Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__App_Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_App_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__App_Callback_: - -.. _callFunctionAsync_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_List_Class_Callback_: - -.. _callFunctionAsync_String__List__Class__Callback_: - -.. _callFunctionAsync_String_List_Class_App_Callback_: - -.. _callFunctionAsync_String__List__Class__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__App_Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__App_Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List_____Class_T___App_Callback_T__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Call a MongoDB Realm function asynchronously with custom codec registry for encoding/decoding arguments/results.This is the asynchronous equivalent of :ref:`callFunction(String, List, Class) ` . - - - - - - - **Type Parameters** - - - ``T`` - The type that the response will be decoded as using the default codec registry. - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultClass`` - The type that the functions result should be converted to. - - - - - ``callback`` - The callback that will receive the result or any errors from the request. - - - - - - - - **Returns** - - The task representing the ongoing operation. - - - - - **Throws** - - - `IllegalStateException `__ - if not called on a looper thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunction(String, List, Class) ` - - - - - :ref:`callFunctionAsync(String, List, Class, CodecRegistry, App.Callback) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_CodecRegistry_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__CodecRegistry__Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String_List_Class_CodecRegistry_App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List__Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_java_lang_String_List_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_java_lang_String__List__Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _callFunctionAsync_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _callFunctionAsync_String_List_Class_CodecRegistry_Callback_: - -.. _callFunctionAsync_String__List__Class__CodecRegistry__Callback_: - -.. _callFunctionAsync_String_List_Class_CodecRegistry_App_Callback_: - -.. _callFunctionAsync_String__List__Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_java_lang_String_List_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_java_lang_String__List__Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_String_java_util_List_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_String__java_util_List__Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_String_List_java_lang_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__java_lang_Class__CodecRegistry__App_Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_CodecRegistry_io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__CodecRegistry__io_realm_mongodb_App_Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_CodecRegistry_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__CodecRegistry__Callback_: - -.. _Functions_callFunctionAsync_String_List_Class_CodecRegistry_App_Callback_: - -.. _Functions_callFunctionAsync_String__List__Class__CodecRegistry__App_Callback_: - -.. _io_realm_mongodb_functions_Functions_callFunctionAsync_String__List_____Class_T___CodecRegistry__App_Callback_T__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`callFunctionAsync ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | `java.lang.Class\ `__ resultClass, - | **CodecRegistry** codecRegistry, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Call a MongoDB Realm function asynchronously with custom codec registry for encoding/decoding arguments/results.This is the asynchronous equivalent of :ref:`callFunction(String, List, Class, CodecRegistry) ` . - - - - - - - **Type Parameters** - - - ``T`` - The type that the response will be decoded as using the default codec registry. - - - - - - - - **Parameters** - - - ``name`` - Name of the Realm function to call. - - - - - ``args`` - Arguments to the Realm function. - - - - - ``resultClass`` - The type that the functions result should be converted to. - - - - - ``codecRegistry`` - Codec registry to use for argument encoding and result decoding. - - - - - ``callback`` - The callback that will receive the result or any errors from the request. - - - - - - - - **Returns** - - The task representing the ongoing operation. - - - - - **Throws** - - - `IllegalStateException `__ - if not called on a looper thread. - - - - - - - - - - .. seealso:: - - - - - :ref:`callFunction(String, List, Class, CodecRegistry) ` - - - - - :ref:`callFunctionAsync(String, List, Class, CodecRegistry, App.Callback) ` - - - - - :ref:`AppConfiguration.getDefaultCodecRegistry() ` - - - - - - - - - - - - -.. _getApp: - -.. _getApp__: - -.. _Functions_getApp: - -.. _Functions_getApp__: - -.. _io_realm_mongodb_functions_Functions_getApp: - -.. _io_realm_mongodb_functions_Functions_getApp__: - - - -getApp ------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`App ` :ref:`getApp ` () - | - - - - - * - Returns the :ref:`App ` that this instance in associated with. - - - - - - - - - **Returns** - - The :ref:`App ` that this instance in associated with. - - - - - - - - - - - - - -.. _getDefaultCodecRegistry: - -.. _getDefaultCodecRegistry__: - -.. _Functions_getDefaultCodecRegistry: - -.. _Functions_getDefaultCodecRegistry__: - -.. _io_realm_mongodb_functions_Functions_getDefaultCodecRegistry: - -.. _io_realm_mongodb_functions_Functions_getDefaultCodecRegistry__: - - - -getDefaultCodecRegistry ------------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **CodecRegistry** :ref:`getDefaultCodecRegistry ` () - | - - - - - * - Returns the default codec registry used for encoding arguments and decoding results for this *Realm functions* instance. - - - - - - - **Returns** - - The default codec registry. - - - - - - - - - - - -.. _getUser: - -.. _getUser__: - -.. _Functions_getUser: - -.. _Functions_getUser__: - -.. _io_realm_mongodb_functions_Functions_getUser: - -.. _io_realm_mongodb_functions_Functions_getUser__: - - - -getUser -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`getUser ` () - | - - - - - * - Returns the :ref:`User ` that this instance in associated with. - - - - - - - - - **Returns** - - The :ref:`User ` that this instance in associated with. - - - - - - - - - - - - - -.. _invoke: - -.. _invoke__: - -.. _Functions_invoke: - -.. _Functions_invoke__: - -.. _io_realm_mongodb_functions_Functions_invoke: - -.. _io_realm_mongodb_functions_Functions_invoke__: - - - -invoke ------- - -.. _io_realm_mongodb_functions_Functions_invoke_java_lang_String_java_util_List_CodecRegistry__any__: - -.. _io_realm_mongodb_functions_Functions_invoke_java_lang_String__java_util_List__CodecRegistry___any__: - -.. _io_realm_mongodb_functions_Functions_invoke_java_lang_String_List_CodecRegistry__any__: - -.. _io_realm_mongodb_functions_Functions_invoke_java_lang_String__List__CodecRegistry___any__: - -.. _io_realm_mongodb_functions_Functions_invoke_String_java_util_List_CodecRegistry__any__: - -.. _io_realm_mongodb_functions_Functions_invoke_String__java_util_List__CodecRegistry___any__: - -.. _io_realm_mongodb_functions_Functions_invoke_String_List_CodecRegistry__any__: - -.. _io_realm_mongodb_functions_Functions_invoke_String__List__CodecRegistry___any__: - -.. _invoke_java_lang_String_java_util_List_CodecRegistry__any__: - -.. _invoke_java_lang_String__java_util_List__CodecRegistry___any__: - -.. _invoke_java_lang_String_List_CodecRegistry__any__: - -.. _invoke_java_lang_String__List__CodecRegistry___any__: - -.. _invoke_String_java_util_List_CodecRegistry__any__: - -.. _invoke_String__java_util_List__CodecRegistry___any__: - -.. _invoke_String_List_CodecRegistry__any__: - -.. _invoke_String__List__CodecRegistry___any__: - -.. _Functions_invoke_java_lang_String_java_util_List_CodecRegistry__any__: - -.. _Functions_invoke_java_lang_String__java_util_List__CodecRegistry___any__: - -.. _Functions_invoke_java_lang_String_List_CodecRegistry__any__: - -.. _Functions_invoke_java_lang_String__List__CodecRegistry___any__: - -.. _Functions_invoke_String_java_util_List_CodecRegistry__any__: - -.. _Functions_invoke_String__java_util_List__CodecRegistry___any__: - -.. _Functions_invoke_String_List_CodecRegistry__any__: - -.. _Functions_invoke_String__List__CodecRegistry___any__: - -.. _io_realm_mongodb_functions_Functions_invoke_String__List_____CodecRegistry___any__: - -.. list-table:: - :header-rows: 1 - - * - | protected abstract **T** :ref:`invoke ` <**T** >( - | `String `__ name, - | `java.util.List\ `__ args, - | **CodecRegistry** codecRegistry, - | **** resultDecoder - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/log/obfuscator.txt b/source/sdk/java/api/io/realm/mongodb/log/obfuscator.txt deleted file mode 100644 index 93880192f0..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/log/obfuscator.txt +++ /dev/null @@ -1,30 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.log.obfuscator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - HttpLogObfuscator - - - -| - -- :ref:`io.realm.mongodb.log.obfuscator.HttpLogObfuscator ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt b/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt deleted file mode 100644 index 3d881cf185..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/log/obfuscator/HttpLogObfuscator.txt +++ /dev/null @@ -1,379 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class HttpLogObfuscator -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator: - - - -io.realm.mongodb.log.obfuscator -=============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.log.obfuscator.HttpLogObfuscator - - -The HttpLogObfuscator keeps sensitive information from being displayed in Logcat. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`HttpLogObfuscator ` ( - | `String `__ feature, - | `java.util.Map\ `__ patternObfuscatorMap - | ) - - - Constructor for creating an HTTP log obfuscator. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`obfuscate ` ( - | `java.util.List\ `__ urlSegments, - | `String `__ input - | ) - - - Obfuscates a logcat entry or not depending on whether the request being sent matches the specified feature. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _HttpLogObfuscator: - -.. _HttpLogObfuscator__: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`HttpLogObfuscator ` ( - | `String `__ feature, - | `java.util.Map\ `__ patternObfuscatorMap - | ) - - - - - * - Constructor for creating an HTTP log obfuscator. - - - - - **Parameters** - - - ``feature`` - the feature to obfuscate, e.g. "providers" for login requests - see **io.realm.internal.network.LoggingInterceptor**. - - - - - - - ``patternObfuscatorMap`` - `Map `__ of keys subject to being obfuscated and **RegexPatternObfuscator**s used to determine which obfuscator has to be used for the given feature. - - - - - - - - - - - - - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _HttpLogObfuscator_equals: - -.. _HttpLogObfuscator_equals__: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_equals: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_equals__: - - - -equals ------- - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_equals_java_lang_Object_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _HttpLogObfuscator_equals_java_lang_Object_: - -.. _HttpLogObfuscator_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _HttpLogObfuscator_hashCode: - -.. _HttpLogObfuscator_hashCode__: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_hashCode: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _obfuscate: - -.. _obfuscate__: - -.. _HttpLogObfuscator_obfuscate: - -.. _HttpLogObfuscator_obfuscate__: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate__: - - - -obfuscate ---------- - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_java_util_List_java_lang_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_java_util_List__java_lang_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_java_util_List_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_java_util_List__String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_List_java_lang_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_List__java_lang_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_List_String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_List__String_: - -.. _obfuscate_java_util_List_java_lang_String_: - -.. _obfuscate_java_util_List__java_lang_String_: - -.. _obfuscate_java_util_List_String_: - -.. _obfuscate_java_util_List__String_: - -.. _obfuscate_List_java_lang_String_: - -.. _obfuscate_List__java_lang_String_: - -.. _obfuscate_List_String_: - -.. _obfuscate_List__String_: - -.. _HttpLogObfuscator_obfuscate_java_util_List_java_lang_String_: - -.. _HttpLogObfuscator_obfuscate_java_util_List__java_lang_String_: - -.. _HttpLogObfuscator_obfuscate_java_util_List_String_: - -.. _HttpLogObfuscator_obfuscate_java_util_List__String_: - -.. _HttpLogObfuscator_obfuscate_List_java_lang_String_: - -.. _HttpLogObfuscator_obfuscate_List__java_lang_String_: - -.. _HttpLogObfuscator_obfuscate_List_String_: - -.. _HttpLogObfuscator_obfuscate_List__String_: - -.. _io_realm_mongodb_log_obfuscator_HttpLogObfuscator_obfuscate_List_String___String_: - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`obfuscate ` ( - | `java.util.List\ `__ urlSegments, - | `String `__ input - | ) - - - - - * - Obfuscates a logcat entry or not depending on whether the request being sent matches the specified feature. If it doesn't, the logcat entry will be returned unmodified. - - - - - **Parameters** - - - ``urlSegments`` - the URL segments of the request to be sent. - - - - - ``input`` - the original logcat entry. - - - - - - - - **Returns** - - the logcat entry to be shown in the logcat. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo.txt b/source/sdk/java/api/io/realm/mongodb/mongo.txt deleted file mode 100644 index 433ec005f6..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo.txt +++ /dev/null @@ -1,36 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.mongo -^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - MongoClient - MongoCollection - MongoDatabase - MongoNamespace - - - -| - -- :ref:`io.realm.mongodb.mongo.MongoClient ` -- :ref:`io.realm.mongodb.mongo.MongoCollection ` -- :ref:`io.realm.mongodb.mongo.MongoDatabase ` -- :ref:`io.realm.mongodb.mongo.MongoNamespace ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt deleted file mode 100644 index da1711ffbb..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoClient.txt +++ /dev/null @@ -1,198 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoClient -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_MongoClient: - - - -io.realm.mongodb.mongo -====================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.MongoClient - - -The remote MongoClient used for working with data in MongoDB remotely via Realm. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`MongoDatabase ` - - | :ref:`getDatabase ` ( - | `String `__ databaseName - | ) - - - Gets a :ref:`MongoDatabase ` instance for the given database name. - - - - - - - * - public `String `__ - - | :ref:`getServiceName ` () - | - - - Returns the service name for this client. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _getDatabase: - -.. _getDatabase__: - -.. _MongoClient_getDatabase: - -.. _MongoClient_getDatabase__: - -.. _io_realm_mongodb_mongo_MongoClient_getDatabase: - -.. _io_realm_mongodb_mongo_MongoClient_getDatabase__: - - - -getDatabase ------------ - -.. _io_realm_mongodb_mongo_MongoClient_getDatabase_java_lang_String_: - -.. _io_realm_mongodb_mongo_MongoClient_getDatabase_String_: - -.. _getDatabase_java_lang_String_: - -.. _getDatabase_String_: - -.. _MongoClient_getDatabase_java_lang_String_: - -.. _MongoClient_getDatabase_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoDatabase ` :ref:`getDatabase ` ( - | `String `__ databaseName - | ) - - - - - * - Gets a :ref:`MongoDatabase ` instance for the given database name. - - - - - - - **Parameters** - - - ``databaseName`` - the name of the database to retrieve - - - - - - - - **Returns** - - a ``RemoteMongoDatabase`` representing the specified database - - - - - - - - - - - - - -.. _getServiceName: - -.. _getServiceName__: - -.. _MongoClient_getServiceName: - -.. _MongoClient_getServiceName__: - -.. _io_realm_mongodb_mongo_MongoClient_getServiceName: - -.. _io_realm_mongodb_mongo_MongoClient_getServiceName__: - - - -getServiceName --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getServiceName ` () - | - - - - - * - Returns the service name for this client. - - - - - - - **Returns** - - the service name. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt deleted file mode 100644 index 47ab62b8b7..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoCollection.txt +++ /dev/null @@ -1,4475 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoCollection -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_MongoCollection: - - - -io.realm.mongodb.mongo -====================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.MongoCollection - - -The MongoCollection interface provides read and write access to documents.Use :ref:`MongoDatabase.getCollection ` to get a collection instance. - - - -Before any access is possible, there must be an active, logged-in user. - - - - -.. seealso:: - - - - - :ref:`MongoDatabase ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`AggregateIterable ` - - | :ref:`aggregate ` <**ResultT** >( - | `java.util.List\ `__ pipeline, - | `java.lang.Class\ `__ resultClass - | ) - - - Aggregates documents according to the specified aggregation pipeline specifying an output class. - - - - - * - public :ref:`AggregateIterable ` - - | :ref:`aggregate ` ( - | `java.util.List\ `__ pipeline - | ) - - - Aggregates documents according to the specified aggregation pipeline. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`count ` ( - | **Bson** filter, - | :ref:`CountOptions ` options - | ) - - - Counts the number of documents in the collection according to the given options. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`count ` ( - | **Bson** filter - | ) - - - Counts the number of documents in the collection according to the given options. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`count ` () - | - - - Counts the number of documents in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`deleteMany ` ( - | **Bson** filter - | ) - - - Removes all documents from the collection that match the given query filter. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`deleteOne ` ( - | **Bson** filter - | ) - - - Removes at most one document from the collection that matches the given filter. - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass, - | :ref:`FindOptions ` options - | ) - - - Finds all documents in the collection that match the given filter specifying an output class and also using :ref:`FindOptions ` to build the query. - - - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds all documents in the collection that match the given filter specifying an output class. - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` ( - | **Bson** filter, - | :ref:`FindOptions ` options - | ) - - - Finds all documents in the collection that match the given filter using :ref:`FindOptions ` to build the query. - - - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` ( - | **Bson** filter - | ) - - - Finds all documents in the collection that match the given filter. - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass, - | :ref:`FindOptions ` options - | ) - - - Finds all documents in the collection specifying an output class and also using :ref:`FindOptions ` to build the query. - - - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass - | ) - - - Finds all documents in the collection specifying an output class. - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` ( - | :ref:`FindOptions ` options - | ) - - - Finds all documents in the collection using :ref:`FindOptions ` to build the query. - - - - - - - * - public :ref:`FindIterable ` - - | :ref:`find ` () - | - - - Finds all documents in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` <**ResultT** >( - | **Bson** filter, - | :ref:`FindOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` ( - | **Bson** filter, - | :ref:`FindOptions ` options - | ) - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` ( - | **Bson** filter - | ) - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOne ` () - | - - - Finds a document in the collection. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndDelete ` <**ResultT** >( - | **Bson** filter, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and delete it. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndDelete ` ( - | **Bson** filter, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - Finds a document in the collection and delete it. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndDelete ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and delete it. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndDelete ` ( - | **Bson** filter - | ) - - - Finds a document in the collection and delete it. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndReplace ` <**ResultT** >( - | **Bson** filter, - | **Bson** replacement, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and replaces it with the given document. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndReplace ` ( - | **Bson** filter, - | **Bson** replacement, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - Finds a document in the collection and replaces it with the given document. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndReplace ` <**ResultT** >( - | **Bson** filter, - | **Bson** replacement, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and replaces it with the given document. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndReplace ` ( - | **Bson** filter, - | **Bson** replacement - | ) - - - Finds a document in the collection and replaces it with the given document. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndUpdate ` <**ResultT** >( - | **Bson** filter, - | **Bson** update, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and performs the given update. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndUpdate ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - Finds a document in the collection and performs the given update. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndUpdate ` <**ResultT** >( - | **Bson** filter, - | **Bson** update, - | `java.lang.Class\ `__ resultClass - | ) - - - Finds a document in the collection and performs the given update. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`findOneAndUpdate ` ( - | **Bson** filter, - | **Bson** update - | ) - - - Finds a document in the collection and performs the given update. - - - - - * - public **CodecRegistry** - - | :ref:`getCodecRegistry ` () - | - - - Gets the codec registry for the MongoCollection. - - - - - * - public `Class `__ - - | :ref:`getDocumentClass ` () - | - - - Gets the class of documents stored in this collection. - - - - - * - public `String `__ - - | :ref:`getName ` () - | - - - Gets the name of this collection - - - - - * - public :ref:`MongoNamespace ` - - | :ref:`getNamespace ` () - | - - - Gets the namespace of this collection, i.e. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`insertMany ` ( - | `java.util.List\ `__ documents - | ) - - - Inserts one or more documents. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`insertOne ` ( - | **DocumentT** document - | ) - - - Inserts the provided document. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`updateMany ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`UpdateOptions ` updateOptions - | ) - - - Update all documents in the collection according to the specified arguments. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`updateMany ` ( - | **Bson** filter, - | **Bson** update - | ) - - - Update all documents in the collection according to the specified arguments. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`updateOne ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`UpdateOptions ` updateOptions - | ) - - - Update a single document in the collection according to the specified arguments. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`updateOne ` ( - | **Bson** filter, - | **Bson** update - | ) - - - Update a single document in the collection according to the specified arguments. - - - - - * - public :ref:`RealmEventStreamTask ` - - | :ref:`watch ` ( - | **ObjectId[]** ids - | ) - - - Watches specified IDs in a collection. - - - - - * - public :ref:`RealmEventStreamTask ` - - | :ref:`watch ` ( - | **BsonValue[]** ids - | ) - - - Watches specified IDs in a collection. - - - - - * - public :ref:`RealmEventStreamTask ` - - | :ref:`watch ` () - | - - - Watches a collection. - - - - - * - public :ref:`RealmEventStreamAsyncTask ` - - | :ref:`watchAsync ` ( - | **ObjectId[]** ids - | ) - - - Watches specified IDs in a collection asynchronously. - - - - - * - public :ref:`RealmEventStreamAsyncTask ` - - | :ref:`watchAsync ` ( - | **BsonValue[]** ids - | ) - - - Watches specified IDs in a collection asynchronously. - - - - - * - public :ref:`RealmEventStreamAsyncTask ` - - | :ref:`watchAsync ` () - | - - - Watches a collection asynchronously. - - - - - * - public :ref:`RealmEventStreamTask ` - - | :ref:`watchWithFilter ` ( - | **BsonDocument** matchFilter - | ) - - - Watches a collection. - - - - - * - public :ref:`RealmEventStreamTask ` - - | :ref:`watchWithFilter ` ( - | **Document** matchFilter - | ) - - - Watches a collection. - - - - - * - public :ref:`RealmEventStreamAsyncTask ` - - | :ref:`watchWithFilterAsync ` ( - | **BsonDocument** matchFilter - | ) - - - Watches a collection asynchronously. - - - - - * - public :ref:`RealmEventStreamAsyncTask ` - - | :ref:`watchWithFilterAsync ` ( - | **Document** matchFilter - | ) - - - Watches a collection asynchronously. - - - - - * - public :ref:`MongoCollection ` - - | :ref:`withCodecRegistry ` ( - | **CodecRegistry** codecRegistry - | ) - - - Creates a new MongoCollection instance with a different codec registry. - - - - - * - public :ref:`MongoCollection ` - - | :ref:`withDocumentClass ` <**NewDocumentT** >( - | `java.lang.Class\ `__ clazz - | ) - - - Creates a new MongoCollection instance with a different default class to cast any documents returned from the database into. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _aggregate: - -.. _aggregate__: - -.. _MongoCollection_aggregate: - -.. _MongoCollection_aggregate__: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate__: - - - -aggregate ---------- - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_java_util_List_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_java_util_List__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_java_util_List_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_java_util_List__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson___java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson___Class_: - -.. _aggregate_java_util_List_java_lang_Class_: - -.. _aggregate_java_util_List__java_lang_Class_: - -.. _aggregate_java_util_List_Class_: - -.. _aggregate_java_util_List__Class_: - -.. _aggregate_List_java_lang_Class_: - -.. _aggregate_List__java_lang_Class_: - -.. _aggregate_List_Class_: - -.. _aggregate_List__Class_: - -.. _aggregate_List___extends_Bson__java_lang_Class_: - -.. _aggregate_List___extends_Bson___java_lang_Class_: - -.. _aggregate_List___extends_Bson__Class_: - -.. _aggregate_List___extends_Bson___Class_: - -.. _MongoCollection_aggregate_java_util_List_java_lang_Class_: - -.. _MongoCollection_aggregate_java_util_List__java_lang_Class_: - -.. _MongoCollection_aggregate_java_util_List_Class_: - -.. _MongoCollection_aggregate_java_util_List__Class_: - -.. _MongoCollection_aggregate_List_java_lang_Class_: - -.. _MongoCollection_aggregate_List__java_lang_Class_: - -.. _MongoCollection_aggregate_List_Class_: - -.. _MongoCollection_aggregate_List__Class_: - -.. _MongoCollection_aggregate_List___extends_Bson__java_lang_Class_: - -.. _MongoCollection_aggregate_List___extends_Bson___java_lang_Class_: - -.. _MongoCollection_aggregate_List___extends_Bson__Class_: - -.. _MongoCollection_aggregate_List___extends_Bson___Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson___Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AggregateIterable ` :ref:`aggregate ` <**ResultT** >( - | `java.util.List\ `__ pipeline, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Aggregates documents according to the specified aggregation pipeline specifying an output class.All documents will be delivered in the form of an :ref:`AggregateIterable ` from which individual elements can be extracted. - - - - - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``pipeline`` - the aggregation pipeline - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - an :ref:`AggregateIterable ` from which the results can be extracted - - - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_java_util_List_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List_: - -.. _io_realm_mongodb_mongo_MongoCollection_aggregate_List___extends_Bson__: - -.. _aggregate_java_util_List_: - -.. _aggregate_List_: - -.. _aggregate_List___extends_Bson__: - -.. _MongoCollection_aggregate_java_util_List_: - -.. _MongoCollection_aggregate_List_: - -.. _MongoCollection_aggregate_List___extends_Bson__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AggregateIterable ` :ref:`aggregate ` ( - | `java.util.List\ `__ pipeline - | ) - - - - - * - Aggregates documents according to the specified aggregation pipeline.All documents will be delivered in the form of an :ref:`AggregateIterable ` from which individual elements can be extracted. - - - - - - - - - **Parameters** - - - ``pipeline`` - the aggregation pipeline - - - - - - - - **Returns** - - an :ref:`AggregateIterable ` from which the results can be extracted - - - - - - - - - - - - - -.. _count: - -.. _count__: - -.. _MongoCollection_count: - -.. _MongoCollection_count__: - -.. _io_realm_mongodb_mongo_MongoCollection_count: - -.. _io_realm_mongodb_mongo_MongoCollection_count__: - - - -count ------ - -.. _io_realm_mongodb_mongo_MongoCollection_count_Bson_io_realm_mongodb_mongo_options_CountOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_count_Bson__io_realm_mongodb_mongo_options_CountOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_count_Bson_CountOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_count_Bson__CountOptions_: - -.. _count_Bson_io_realm_mongodb_mongo_options_CountOptions_: - -.. _count_Bson__io_realm_mongodb_mongo_options_CountOptions_: - -.. _count_Bson_CountOptions_: - -.. _count_Bson__CountOptions_: - -.. _MongoCollection_count_Bson_io_realm_mongodb_mongo_options_CountOptions_: - -.. _MongoCollection_count_Bson__io_realm_mongodb_mongo_options_CountOptions_: - -.. _MongoCollection_count_Bson_CountOptions_: - -.. _MongoCollection_count_Bson__CountOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`count ` ( - | **Bson** filter, - | :ref:`CountOptions ` options - | ) - - - - - * - Counts the number of documents in the collection according to the given options. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - the options describing the count - - - - - - - - **Returns** - - a task containing the number of documents in the collection - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_count_Bson_: - -.. _count_Bson_: - -.. _MongoCollection_count_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`count ` ( - | **Bson** filter - | ) - - - - - * - Counts the number of documents in the collection according to the given options. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - - - - **Returns** - - a task containing the number of documents in the collection - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`count ` () - | - - - - - * - Counts the number of documents in the collection. - - - - - - - **Returns** - - a task containing the number of documents in the collection - - - - - - - - - - - -.. _deleteMany: - -.. _deleteMany__: - -.. _MongoCollection_deleteMany: - -.. _MongoCollection_deleteMany__: - -.. _io_realm_mongodb_mongo_MongoCollection_deleteMany: - -.. _io_realm_mongodb_mongo_MongoCollection_deleteMany__: - - - -deleteMany ----------- - -.. _io_realm_mongodb_mongo_MongoCollection_deleteMany_Bson_: - -.. _deleteMany_Bson_: - -.. _MongoCollection_deleteMany_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`deleteMany ` ( - | **Bson** filter - | ) - - - - - * - Removes all documents from the collection that match the given query filter. If no documents match, the collection is not modified. - - - - - **Parameters** - - - ``filter`` - the query filter to apply the the delete operation - - - - - - - - **Returns** - - a task containing the result of the remove many operation - - - - - - - - - - - -.. _deleteOne: - -.. _deleteOne__: - -.. _MongoCollection_deleteOne: - -.. _MongoCollection_deleteOne__: - -.. _io_realm_mongodb_mongo_MongoCollection_deleteOne: - -.. _io_realm_mongodb_mongo_MongoCollection_deleteOne__: - - - -deleteOne ---------- - -.. _io_realm_mongodb_mongo_MongoCollection_deleteOne_Bson_: - -.. _deleteOne_Bson_: - -.. _MongoCollection_deleteOne_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`deleteOne ` ( - | **Bson** filter - | ) - - - - - * - Removes at most one document from the collection that matches the given filter. If no documents match, the collection is not modified. - - - - - **Parameters** - - - ``filter`` - the query filter to apply the the delete operation - - - - - - - - **Returns** - - a task containing the result of the remove one operation - - - - - - - - - - - -.. _find: - -.. _find__: - -.. _MongoCollection_find: - -.. _MongoCollection_find__: - -.. _io_realm_mongodb_mongo_MongoCollection_find: - -.. _io_realm_mongodb_mongo_MongoCollection_find__: - - - -find ----- - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_java_lang_Class_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__java_lang_Class__FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_Class_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__Class__FindOptions_: - -.. _find_Bson_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson__java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson_java_lang_Class_FindOptions_: - -.. _find_Bson__java_lang_Class__FindOptions_: - -.. _find_Bson_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson__Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson_Class_FindOptions_: - -.. _find_Bson__Class__FindOptions_: - -.. _MongoCollection_find_Bson_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson__java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson_java_lang_Class_FindOptions_: - -.. _MongoCollection_find_Bson__java_lang_Class__FindOptions_: - -.. _MongoCollection_find_Bson_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson__Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson_Class_FindOptions_: - -.. _MongoCollection_find_Bson__Class__FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__Class_ResultT___FindOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass, - | :ref:`FindOptions ` options - | ) - - - - - * - Finds all documents in the collection that match the given filter specifying an output class and also using :ref:`FindOptions ` to build the query. - - All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``resultClass`` - the class to decode each document into - - - - - ``options`` - a :ref:`FindOptions ` struct - - - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__Class_: - -.. _find_Bson_java_lang_Class_: - -.. _find_Bson__java_lang_Class_: - -.. _find_Bson_Class_: - -.. _find_Bson__Class_: - -.. _MongoCollection_find_Bson_java_lang_Class_: - -.. _MongoCollection_find_Bson__java_lang_Class_: - -.. _MongoCollection_find_Bson_Class_: - -.. _MongoCollection_find_Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds all documents in the collection that match the given filter specifying an output class.All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson__FindOptions_: - -.. _find_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Bson_FindOptions_: - -.. _find_Bson__FindOptions_: - -.. _MongoCollection_find_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Bson_FindOptions_: - -.. _MongoCollection_find_Bson__FindOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` ( - | **Bson** filter, - | :ref:`FindOptions ` options - | ) - - - - - * - Finds all documents in the collection that match the given filter using :ref:`FindOptions ` to build the query. - - All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - a :ref:`FindOptions ` struct - - - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_Bson_: - -.. _find_Bson_: - -.. _MongoCollection_find_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` ( - | **Bson** filter - | ) - - - - - * - Finds all documents in the collection that match the given filter.All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_java_lang_Class_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_java_lang_Class__FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class__FindOptions_: - -.. _find_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_java_lang_Class_FindOptions_: - -.. _find_java_lang_Class__FindOptions_: - -.. _find_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_Class_FindOptions_: - -.. _find_Class__FindOptions_: - -.. _MongoCollection_find_java_lang_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_java_lang_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_java_lang_Class_FindOptions_: - -.. _MongoCollection_find_java_lang_Class__FindOptions_: - -.. _MongoCollection_find_Class_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Class__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_Class_FindOptions_: - -.. _MongoCollection_find_Class__FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class_ResultT___FindOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass, - | :ref:`FindOptions ` options - | ) - - - - - * - Finds all documents in the collection specifying an output class and also using :ref:`FindOptions ` to build the query. - - All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``resultClass`` - the class to decode each document into - - - - - ``options`` - a :ref:`FindOptions ` struct for building the query - - - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class_: - -.. _find_java_lang_Class_: - -.. _find_Class_: - -.. _MongoCollection_find_java_lang_Class_: - -.. _MongoCollection_find_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds all documents in the collection specifying an output class.All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_find_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_find_FindOptions_: - -.. _find_io_realm_mongodb_mongo_options_FindOptions_: - -.. _find_FindOptions_: - -.. _MongoCollection_find_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_find_FindOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` ( - | :ref:`FindOptions ` options - | ) - - - - - * - Finds all documents in the collection using :ref:`FindOptions ` to build the query. - - All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - - - **Parameters** - - - ``options`` - a :ref:`FindOptions ` struct for building the query - - - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`find ` () - | - - - - - * - Finds all documents in the collection.All documents will be delivered in the form of a :ref:`FindIterable ` from which individual elements can be extracted. - - - - - - - - - - - **Returns** - - an iterable containing the result of the find operation - - - - - - - - - - - -.. _findOne: - -.. _findOne__: - -.. _MongoCollection_findOne: - -.. _MongoCollection_findOne__: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne__: - - - -findOne -------- - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_FindOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__FindOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_FindOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__FindOptions__Class_: - -.. _findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_java_lang_Class_: - -.. _findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__java_lang_Class_: - -.. _findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_Class_: - -.. _findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__Class_: - -.. _findOne_Bson_FindOptions_java_lang_Class_: - -.. _findOne_Bson__FindOptions__java_lang_Class_: - -.. _findOne_Bson_FindOptions_Class_: - -.. _findOne_Bson__FindOptions__Class_: - -.. _MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_java_lang_Class_: - -.. _MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__java_lang_Class_: - -.. _MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_Class_: - -.. _MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions__Class_: - -.. _MongoCollection_findOne_Bson_FindOptions_java_lang_Class_: - -.. _MongoCollection_findOne_Bson__FindOptions__java_lang_Class_: - -.. _MongoCollection_findOne_Bson_FindOptions_Class_: - -.. _MongoCollection_findOne_Bson__FindOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__FindOptions__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( - | **Bson** filter, - | :ref:`FindOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - a :ref:`FindOptions ` struct - - - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_FindOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__FindOptions_: - -.. _findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _findOne_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _findOne_Bson_FindOptions_: - -.. _findOne_Bson__FindOptions_: - -.. _MongoCollection_findOne_Bson_io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_findOne_Bson__io_realm_mongodb_mongo_options_FindOptions_: - -.. _MongoCollection_findOne_Bson_FindOptions_: - -.. _MongoCollection_findOne_Bson__FindOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` ( - | **Bson** filter, - | :ref:`FindOptions ` options - | ) - - - - - * - Finds a document in the collection. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - a :ref:`FindOptions ` struct - - - - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__Class_: - -.. _findOne_Bson_java_lang_Class_: - -.. _findOne_Bson__java_lang_Class_: - -.. _findOne_Bson_Class_: - -.. _findOne_Bson__Class_: - -.. _MongoCollection_findOne_Bson_java_lang_Class_: - -.. _MongoCollection_findOne_Bson__java_lang_Class_: - -.. _MongoCollection_findOne_Bson_Class_: - -.. _MongoCollection_findOne_Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Bson_: - -.. _findOne_Bson_: - -.. _MongoCollection_findOne_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` ( - | **Bson** filter - | ) - - - - - * - Finds a document in the collection. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Class_: - -.. _findOne_java_lang_Class_: - -.. _findOne_Class_: - -.. _MongoCollection_findOne_java_lang_Class_: - -.. _MongoCollection_findOne_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOne_Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` <**ResultT** >( - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection. - - - **Type Parameters** - - - ``ResultT`` - the target document type - - - - - - - - **Parameters** - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOne ` () - | - - - - - * - Finds a document in the collection. - - - - - - - **Returns** - - a task containing the result of the find one operation - - - - - - - - - - - -.. _findOneAndDelete: - -.. _findOneAndDelete__: - -.. _MongoCollection_findOneAndDelete: - -.. _MongoCollection_findOneAndDelete__: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete__: - - - -findOneAndDelete ----------------- - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions__Class_: - -.. _findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _findOneAndDelete_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndDelete_Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndDelete_Bson_FindOneAndModifyOptions_Class_: - -.. _findOneAndDelete_Bson__FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` <**ResultT** >( - | **Bson** filter, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and delete it. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions_: - -.. _findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndDelete_Bson_FindOneAndModifyOptions_: - -.. _findOneAndDelete_Bson__FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndDelete_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndDelete_Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndDelete_Bson_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndDelete_Bson__FindOneAndModifyOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` ( - | **Bson** filter, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - - - * - Finds a document in the collection and delete it. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__Class_: - -.. _findOneAndDelete_Bson_java_lang_Class_: - -.. _findOneAndDelete_Bson__java_lang_Class_: - -.. _findOneAndDelete_Bson_Class_: - -.. _findOneAndDelete_Bson__Class_: - -.. _MongoCollection_findOneAndDelete_Bson_java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__java_lang_Class_: - -.. _MongoCollection_findOneAndDelete_Bson_Class_: - -.. _MongoCollection_findOneAndDelete_Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` <**ResultT** >( - | **Bson** filter, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and delete it. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndDelete_Bson_: - -.. _findOneAndDelete_Bson_: - -.. _MongoCollection_findOneAndDelete_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndDelete ` ( - | **Bson** filter - | ) - - - - - * - Finds a document in the collection and delete it. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - - - -.. _findOneAndReplace: - -.. _findOneAndReplace__: - -.. _MongoCollection_findOneAndReplace: - -.. _MongoCollection_findOneAndReplace__: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace__: - - - -findOneAndReplace ------------------ - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndReplace ` <**ResultT** >( - | **Bson** filter, - | **Bson** replacement, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and replaces it with the given document. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``replacement`` - the document to replace the matched document with - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions_: - -.. _findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_: - -.. _findOneAndReplace_Bson__Bson__FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__FindOneAndModifyOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndReplace ` ( - | **Bson** filter, - | **Bson** replacement, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - - - * - Finds a document in the collection and replaces it with the given document. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``replacement`` - the document to replace the matched document with - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__Class_: - -.. _findOneAndReplace_Bson_Bson_java_lang_Class_: - -.. _findOneAndReplace_Bson__Bson__java_lang_Class_: - -.. _findOneAndReplace_Bson_Bson_Class_: - -.. _findOneAndReplace_Bson__Bson__Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__java_lang_Class_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_Class_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndReplace ` <**ResultT** >( - | **Bson** filter, - | **Bson** replacement, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and replaces it with the given document. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``replacement`` - the document to replace the matched document with - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson_Bson_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndReplace_Bson__Bson_: - -.. _findOneAndReplace_Bson_Bson_: - -.. _findOneAndReplace_Bson__Bson_: - -.. _MongoCollection_findOneAndReplace_Bson_Bson_: - -.. _MongoCollection_findOneAndReplace_Bson__Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndReplace ` ( - | **Bson** filter, - | **Bson** replacement - | ) - - - - - * - Finds a document in the collection and replaces it with the given document. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``replacement`` - the document to replace the matched document with - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - - - -.. _findOneAndUpdate: - -.. _findOneAndUpdate__: - -.. _MongoCollection_findOneAndUpdate: - -.. _MongoCollection_findOneAndUpdate__: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate__: - - - -findOneAndUpdate ----------------- - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions__Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndUpdate ` <**ResultT** >( - | **Bson** filter, - | **Bson** update, - | :ref:`FindOneAndModifyOptions ` options, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and performs the given update. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``update`` - the update document - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions_: - -.. _findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_: - -.. _findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__io_realm_mongodb_mongo_options_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_FindOneAndModifyOptions_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__FindOneAndModifyOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndUpdate ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`FindOneAndModifyOptions ` options - | ) - - - - - * - Finds a document in the collection and performs the given update. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``update`` - the update document - - - - - ``options`` - a :ref:`FindOneAndModifyOptions ` struct - - - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__Class_: - -.. _findOneAndUpdate_Bson_Bson_java_lang_Class_: - -.. _findOneAndUpdate_Bson__Bson__java_lang_Class_: - -.. _findOneAndUpdate_Bson_Bson_Class_: - -.. _findOneAndUpdate_Bson__Bson__Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__java_lang_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_Class_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson__Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson__Class_ResultT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndUpdate ` <**ResultT** >( - | **Bson** filter, - | **Bson** update, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - Finds a document in the collection and performs the given update. - - - **Type Parameters** - - - ``ResultT`` - the target document type of the iterable. - - - - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``update`` - the update document - - - - - ``resultClass`` - the class to decode each document into - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson_Bson_: - -.. _io_realm_mongodb_mongo_MongoCollection_findOneAndUpdate_Bson__Bson_: - -.. _findOneAndUpdate_Bson_Bson_: - -.. _findOneAndUpdate_Bson__Bson_: - -.. _MongoCollection_findOneAndUpdate_Bson_Bson_: - -.. _MongoCollection_findOneAndUpdate_Bson__Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`findOneAndUpdate ` ( - | **Bson** filter, - | **Bson** update - | ) - - - - - * - Finds a document in the collection and performs the given update. - - - - - **Parameters** - - - ``filter`` - the query filter - - - - - ``update`` - the update document - - - - - - - - **Returns** - - a task containing the resulting document - - - - - - - - - - - -.. _getCodecRegistry: - -.. _getCodecRegistry__: - -.. _MongoCollection_getCodecRegistry: - -.. _MongoCollection_getCodecRegistry__: - -.. _io_realm_mongodb_mongo_MongoCollection_getCodecRegistry: - -.. _io_realm_mongodb_mongo_MongoCollection_getCodecRegistry__: - - - -getCodecRegistry ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **CodecRegistry** :ref:`getCodecRegistry ` () - | - - - - - * - Gets the codec registry for the MongoCollection. - - - - - - - **Returns** - - the **CodecRegistry** for this collection - - - - - - - - - - - - - -.. _getDocumentClass: - -.. _getDocumentClass__: - -.. _MongoCollection_getDocumentClass: - -.. _MongoCollection_getDocumentClass__: - -.. _io_realm_mongodb_mongo_MongoCollection_getDocumentClass: - -.. _io_realm_mongodb_mongo_MongoCollection_getDocumentClass__: - - - -getDocumentClass ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Class `__ :ref:`getDocumentClass ` () - | - - - - - * - Gets the class of documents stored in this collection.If you used the simple :ref:`MongoDatabase.getCollection(String) ` to get this collection, this is `org.bson.Document `__ . - - - - - - - - - - - **Returns** - - the class of documents in this collection - - - - - - - - - - - -.. _getName: - -.. _getName__: - -.. _MongoCollection_getName: - -.. _MongoCollection_getName__: - -.. _io_realm_mongodb_mongo_MongoCollection_getName: - -.. _io_realm_mongodb_mongo_MongoCollection_getName__: - - - -getName -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getName ` () - | - - - - - * - Gets the name of this collection - - - - - - - **Returns** - - the name - - - - - - - - - - - -.. _getNamespace: - -.. _getNamespace__: - -.. _MongoCollection_getNamespace: - -.. _MongoCollection_getNamespace__: - -.. _io_realm_mongodb_mongo_MongoCollection_getNamespace: - -.. _io_realm_mongodb_mongo_MongoCollection_getNamespace__: - - - -getNamespace ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoNamespace ` :ref:`getNamespace ` () - | - - - - - * - Gets the namespace of this collection, i.e. the database and collection names together. - - - - - - - **Returns** - - the namespace - - - - - - - - - - - -.. _insertMany: - -.. _insertMany__: - -.. _MongoCollection_insertMany: - -.. _MongoCollection_insertMany__: - -.. _io_realm_mongodb_mongo_MongoCollection_insertMany: - -.. _io_realm_mongodb_mongo_MongoCollection_insertMany__: - - - -insertMany ----------- - -.. _io_realm_mongodb_mongo_MongoCollection_insertMany_java_util_List_: - -.. _io_realm_mongodb_mongo_MongoCollection_insertMany_List_: - -.. _io_realm_mongodb_mongo_MongoCollection_insertMany_List___extends_DocumentT__: - -.. _insertMany_java_util_List_: - -.. _insertMany_List_: - -.. _insertMany_List___extends_DocumentT__: - -.. _MongoCollection_insertMany_java_util_List_: - -.. _MongoCollection_insertMany_List_: - -.. _MongoCollection_insertMany_List___extends_DocumentT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`insertMany ` ( - | `java.util.List\ `__ documents - | ) - - - - - * - Inserts one or more documents. - - - - - **Parameters** - - - ``documents`` - the documents to insert - - - - - - - - **Returns** - - a task containing the result of the insert many operation - - - - - - - - - - - -.. _insertOne: - -.. _insertOne__: - -.. _MongoCollection_insertOne: - -.. _MongoCollection_insertOne__: - -.. _io_realm_mongodb_mongo_MongoCollection_insertOne: - -.. _io_realm_mongodb_mongo_MongoCollection_insertOne__: - - - -insertOne ---------- - -.. _io_realm_mongodb_mongo_MongoCollection_insertOne_DocumentT_: - -.. _insertOne_DocumentT_: - -.. _MongoCollection_insertOne_DocumentT_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`insertOne ` ( - | **DocumentT** document - | ) - - - - - * - Inserts the provided document. If the document is missing an identifier, the client should generate one. - - - - - **Parameters** - - - ``document`` - the document to insert - - - - - - - - **Returns** - - a task containing the result of the insert one operation - - - - - - - - - - - -.. _updateMany: - -.. _updateMany__: - -.. _MongoCollection_updateMany: - -.. _MongoCollection_updateMany__: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany__: - - - -updateMany ----------- - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson_Bson_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson__Bson__UpdateOptions_: - -.. _updateMany_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _updateMany_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _updateMany_Bson_Bson_UpdateOptions_: - -.. _updateMany_Bson__Bson__UpdateOptions_: - -.. _MongoCollection_updateMany_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _MongoCollection_updateMany_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _MongoCollection_updateMany_Bson_Bson_UpdateOptions_: - -.. _MongoCollection_updateMany_Bson__Bson__UpdateOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`updateMany ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`UpdateOptions ` updateOptions - | ) - - - - - * - Update all documents in the collection according to the specified arguments. - - - - - **Parameters** - - - ``filter`` - a document describing the query filter, which may not be null. - - - - - ``update`` - a document describing the update, which may not be null. The update to apply must include only update operators. - - - - - ``updateOptions`` - the options to apply to the update operation - - - - - - - - **Returns** - - a task containing the result of the update many operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson_Bson_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateMany_Bson__Bson_: - -.. _updateMany_Bson_Bson_: - -.. _updateMany_Bson__Bson_: - -.. _MongoCollection_updateMany_Bson_Bson_: - -.. _MongoCollection_updateMany_Bson__Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`updateMany ` ( - | **Bson** filter, - | **Bson** update - | ) - - - - - * - Update all documents in the collection according to the specified arguments. - - - - - **Parameters** - - - ``filter`` - a document describing the query filter, which may not be null. - - - - - ``update`` - a document describing the update, which may not be null. The update to apply must include only update operators. - - - - - - - - **Returns** - - a task containing the result of the update many operation - - - - - - - - - - - -.. _updateOne: - -.. _updateOne__: - -.. _MongoCollection_updateOne: - -.. _MongoCollection_updateOne__: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne__: - - - -updateOne ---------- - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson_Bson_UpdateOptions_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson__Bson__UpdateOptions_: - -.. _updateOne_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _updateOne_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _updateOne_Bson_Bson_UpdateOptions_: - -.. _updateOne_Bson__Bson__UpdateOptions_: - -.. _MongoCollection_updateOne_Bson_Bson_io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _MongoCollection_updateOne_Bson__Bson__io_realm_mongodb_mongo_options_UpdateOptions_: - -.. _MongoCollection_updateOne_Bson_Bson_UpdateOptions_: - -.. _MongoCollection_updateOne_Bson__Bson__UpdateOptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`updateOne ` ( - | **Bson** filter, - | **Bson** update, - | :ref:`UpdateOptions ` updateOptions - | ) - - - - - * - Update a single document in the collection according to the specified arguments. - - - - - **Parameters** - - - ``filter`` - a document describing the query filter, which may not be null. - - - - - ``update`` - a document describing the update, which may not be null. The update to apply must include only update operators. - - - - - ``updateOptions`` - the options to apply to the update operation - - - - - - - - **Returns** - - a task containing the result of the update one operation - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson_Bson_: - -.. _io_realm_mongodb_mongo_MongoCollection_updateOne_Bson__Bson_: - -.. _updateOne_Bson_Bson_: - -.. _updateOne_Bson__Bson_: - -.. _MongoCollection_updateOne_Bson_Bson_: - -.. _MongoCollection_updateOne_Bson__Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`updateOne ` ( - | **Bson** filter, - | **Bson** update - | ) - - - - - * - Update a single document in the collection according to the specified arguments. - - - - - **Parameters** - - - ``filter`` - a document describing the query filter, which may not be null. - - - - - ``update`` - a document describing the update, which may not be null. The update to apply must include only update operators. - - - - - - - - **Returns** - - a task containing the result of the update one operation - - - - - - - - - - - -.. _watch: - -.. _watch__: - -.. _MongoCollection_watch: - -.. _MongoCollection_watch__: - -.. _io_realm_mongodb_mongo_MongoCollection_watch: - -.. _io_realm_mongodb_mongo_MongoCollection_watch__: - - - -watch ------ - -.. _io_realm_mongodb_mongo_MongoCollection_watch_ObjectId_: - -.. _io_realm_mongodb_mongo_MongoCollection_watch_ObjectId____: - -.. _watch_ObjectId_: - -.. _watch_ObjectId____: - -.. _MongoCollection_watch_ObjectId_: - -.. _MongoCollection_watch_ObjectId____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamTask ` :ref:`watch ` ( - | **ObjectId[]** ids - | ) - - - - - * - Watches specified IDs in a collection. This convenience overload supports the use case of non-**BsonValue** instances of **ObjectId** by wrapping them in **BsonObjectId** instances for the user. - - - - - - - **Parameters** - - - ``ids`` - unique object identifiers of the IDs to watch. - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_watch_BsonValue_: - -.. _io_realm_mongodb_mongo_MongoCollection_watch_BsonValue____: - -.. _watch_BsonValue_: - -.. _watch_BsonValue____: - -.. _MongoCollection_watch_BsonValue_: - -.. _MongoCollection_watch_BsonValue____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamTask ` :ref:`watch ` ( - | **BsonValue[]** ids - | ) - - - - - * - Watches specified IDs in a collection. - - - - - **Parameters** - - - ``ids`` - the ids to watch. - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamTask ` :ref:`watch ` () - | - - - - - * - Watches a collection. The resulting stream will be notified of all events on this collection that the active user is authorized to see based on the configured MongoDB Realm rules. - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - - - -.. _watchAsync: - -.. _watchAsync__: - -.. _MongoCollection_watchAsync: - -.. _MongoCollection_watchAsync__: - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync: - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync__: - - - -watchAsync ----------- - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync_ObjectId_: - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync_ObjectId____: - -.. _watchAsync_ObjectId_: - -.. _watchAsync_ObjectId____: - -.. _MongoCollection_watchAsync_ObjectId_: - -.. _MongoCollection_watchAsync_ObjectId____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamAsyncTask ` :ref:`watchAsync ` ( - | **ObjectId[]** ids - | ) - - - - - * - Watches specified IDs in a collection asynchronously. This convenience overload supports the use case of non-**BsonValue** instances of **ObjectId** by wrapping them in **BsonObjectId** instances for the user. - - - - - - - **Parameters** - - - ``ids`` - unique object identifiers of the IDs to watch. - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync_BsonValue_: - -.. _io_realm_mongodb_mongo_MongoCollection_watchAsync_BsonValue____: - -.. _watchAsync_BsonValue_: - -.. _watchAsync_BsonValue____: - -.. _MongoCollection_watchAsync_BsonValue_: - -.. _MongoCollection_watchAsync_BsonValue____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamAsyncTask ` :ref:`watchAsync ` ( - | **BsonValue[]** ids - | ) - - - - - * - Watches specified IDs in a collection asynchronously. - - - - - **Parameters** - - - ``ids`` - the ids to watch. - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamAsyncTask ` :ref:`watchAsync ` () - | - - - - - * - Watches a collection asynchronously. The resulting stream will be notified of all events on this collection that the active user is authorized to see based on the configured MongoDB Realm rules. - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - - - -.. _watchWithFilter: - -.. _watchWithFilter__: - -.. _MongoCollection_watchWithFilter: - -.. _MongoCollection_watchWithFilter__: - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilter: - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilter__: - - - -watchWithFilter ---------------- - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilter_BsonDocument_: - -.. _watchWithFilter_BsonDocument_: - -.. _MongoCollection_watchWithFilter_BsonDocument_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamTask ` :ref:`watchWithFilter ` ( - | **BsonDocument** matchFilter - | ) - - - - - * - Watches a collection. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . - - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ - - - - - - - **Parameters** - - - ``matchFilter`` - the $match filter to apply to incoming change events - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilter_Document_: - -.. _watchWithFilter_Document_: - -.. _MongoCollection_watchWithFilter_Document_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamTask ` :ref:`watchWithFilter ` ( - | **Document** matchFilter - | ) - - - - - * - Watches a collection. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-**BsonDocument** instances for the user. - - See `how to define a match filter `__ . - - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ - - - - - - - **Parameters** - - - ``matchFilter`` - the $match filter to apply to incoming change events - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - - - -.. _watchWithFilterAsync: - -.. _watchWithFilterAsync__: - -.. _MongoCollection_watchWithFilterAsync: - -.. _MongoCollection_watchWithFilterAsync__: - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilterAsync: - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilterAsync__: - - - -watchWithFilterAsync --------------------- - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilterAsync_BsonDocument_: - -.. _watchWithFilterAsync_BsonDocument_: - -.. _MongoCollection_watchWithFilterAsync_BsonDocument_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamAsyncTask ` :ref:`watchWithFilterAsync ` ( - | **BsonDocument** matchFilter - | ) - - - - - * - Watches a collection asynchronously. The provided BSON document will be used as a match expression filter on the change events coming from the stream.See `how to define a match filter `__ . - - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ - - - - - - - **Parameters** - - - ``matchFilter`` - the $match filter to apply to incoming change events - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoCollection_watchWithFilterAsync_Document_: - -.. _watchWithFilterAsync_Document_: - -.. _MongoCollection_watchWithFilterAsync_Document_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmEventStreamAsyncTask ` :ref:`watchWithFilterAsync ` ( - | **Document** matchFilter - | ) - - - - - * - Watches a collection asynchronously. The provided document will be used as a match expression filter on the change events coming from the stream. This convenience overload supports the use of non-**BsonDocument** instances for the user. - - See `how to define a match filter `__ . - - Defining the match expression to filter ChangeEvents is similar to `how to define the match expression for triggers `__ - - - - - - - **Parameters** - - - ``matchFilter`` - the $match filter to apply to incoming change events - - - - - - - - **Returns** - - a task that provides access to the stream of change events. - - - - - - - - - - - -.. _withCodecRegistry: - -.. _withCodecRegistry__: - -.. _MongoCollection_withCodecRegistry: - -.. _MongoCollection_withCodecRegistry__: - -.. _io_realm_mongodb_mongo_MongoCollection_withCodecRegistry: - -.. _io_realm_mongodb_mongo_MongoCollection_withCodecRegistry__: - - - -withCodecRegistry ------------------ - -.. _io_realm_mongodb_mongo_MongoCollection_withCodecRegistry_CodecRegistry_: - -.. _withCodecRegistry_CodecRegistry_: - -.. _MongoCollection_withCodecRegistry_CodecRegistry_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoCollection ` :ref:`withCodecRegistry ` ( - | **CodecRegistry** codecRegistry - | ) - - - - - * - Creates a new MongoCollection instance with a different codec registry. - - - - - **Parameters** - - - ``codecRegistry`` - the new **CodecRegistry** for the collection. - - - - - - - - - - **Returns** - - a new MongoCollection instance with the different codec registry - - - - - - - - - - - -.. _withDocumentClass: - -.. _withDocumentClass__: - -.. _MongoCollection_withDocumentClass: - -.. _MongoCollection_withDocumentClass__: - -.. _io_realm_mongodb_mongo_MongoCollection_withDocumentClass: - -.. _io_realm_mongodb_mongo_MongoCollection_withDocumentClass__: - - - -withDocumentClass ------------------ - -.. _io_realm_mongodb_mongo_MongoCollection_withDocumentClass_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_withDocumentClass_Class_: - -.. _withDocumentClass_java_lang_Class_: - -.. _withDocumentClass_Class_: - -.. _MongoCollection_withDocumentClass_java_lang_Class_: - -.. _MongoCollection_withDocumentClass_Class_: - -.. _io_realm_mongodb_mongo_MongoCollection_withDocumentClass_Class_NewDocumentT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoCollection ` :ref:`withDocumentClass ` <**NewDocumentT** >( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Creates a new MongoCollection instance with a different default class to cast any documents returned from the database into. - - - **Type Parameters** - - - ``NewDocumentT`` - The type that the new collection will encode documents from and decode documents to. - - - - - - - - **Parameters** - - - ``clazz`` - the default class to which any documents returned from the database will be cast. - - - - - - - - **Returns** - - a new MongoCollection instance with the different default class - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt deleted file mode 100644 index 7d3bb5421c..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoDatabase.txt +++ /dev/null @@ -1,308 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoDatabase -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_MongoDatabase: - - - -io.realm.mongodb.mongo -====================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.MongoDatabase - - -The RemoteMongoDatabase provides access to its **Document** :ref:`MongoCollection ` s. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`MongoCollection ` - - | :ref:`getCollection ` <**DocumentT** >( - | `String `__ collectionName, - | `java.lang.Class\ `__ documentClass - | ) - - - Gets a collection, with a specific default document class. - - - - - * - public :ref:`MongoCollection ` - - | :ref:`getCollection ` ( - | `String `__ collectionName - | ) - - - Gets a collection. - - - - - * - public `String `__ - - | :ref:`getName ` () - | - - - Gets the name of the database. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _getCollection: - -.. _getCollection__: - -.. _MongoDatabase_getCollection: - -.. _MongoDatabase_getCollection__: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection__: - - - -getCollection -------------- - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_java_lang_String_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_java_lang_String__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_java_lang_String_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_java_lang_String__Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String_java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String__java_lang_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String_Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String__Class_: - -.. _getCollection_java_lang_String_java_lang_Class_: - -.. _getCollection_java_lang_String__java_lang_Class_: - -.. _getCollection_java_lang_String_Class_: - -.. _getCollection_java_lang_String__Class_: - -.. _getCollection_String_java_lang_Class_: - -.. _getCollection_String__java_lang_Class_: - -.. _getCollection_String_Class_: - -.. _getCollection_String__Class_: - -.. _MongoDatabase_getCollection_java_lang_String_java_lang_Class_: - -.. _MongoDatabase_getCollection_java_lang_String__java_lang_Class_: - -.. _MongoDatabase_getCollection_java_lang_String_Class_: - -.. _MongoDatabase_getCollection_java_lang_String__Class_: - -.. _MongoDatabase_getCollection_String_java_lang_Class_: - -.. _MongoDatabase_getCollection_String__java_lang_Class_: - -.. _MongoDatabase_getCollection_String_Class_: - -.. _MongoDatabase_getCollection_String__Class_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String__Class_DocumentT__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoCollection ` :ref:`getCollection ` <**DocumentT** >( - | `String `__ collectionName, - | `java.lang.Class\ `__ documentClass - | ) - - - - - * - Gets a collection, with a specific default document class. - - - **Type Parameters** - - - ``DocumentT`` - the type of the class to use instead of ``Document`` . - - - - - - - - - - **Parameters** - - - ``collectionName`` - the name of the collection to return - - - - - ``documentClass`` - the default class to cast any documents returned from the database into. - - - - - - - - **Returns** - - the collection - - - - - - - - - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_java_lang_String_: - -.. _io_realm_mongodb_mongo_MongoDatabase_getCollection_String_: - -.. _getCollection_java_lang_String_: - -.. _getCollection_String_: - -.. _MongoDatabase_getCollection_java_lang_String_: - -.. _MongoDatabase_getCollection_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoCollection ` :ref:`getCollection ` ( - | `String `__ collectionName - | ) - - - - - * - Gets a collection. - - - - - **Parameters** - - - ``collectionName`` - the name of the collection to return - - - - - - - - **Returns** - - the collection - - - - - - - - - - - -.. _getName: - -.. _getName__: - -.. _MongoDatabase_getName: - -.. _MongoDatabase_getName__: - -.. _io_realm_mongodb_mongo_MongoDatabase_getName: - -.. _io_realm_mongodb_mongo_MongoDatabase_getName__: - - - -getName -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getName ` () - | - - - - - * - Gets the name of the database. - - - - - - - **Returns** - - the database name - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt b/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt deleted file mode 100644 index 037179844a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/MongoNamespace.txt +++ /dev/null @@ -1,775 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoNamespace -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_MongoNamespace: - - - -io.realm.mongodb.mongo -====================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.MongoNamespace - - -A MongoDB namespace, which includes a database name and collection name. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`MongoNamespace ` ( - | `String `__ fullName - | ) - - - Construct an instance for the given full name. - - - - - * - | :ref:`MongoNamespace ` ( - | `String `__ databaseName, - | `String `__ collectionName - | ) - - - Construct an instance from the given database name and collection name. - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static final `String `__ - - - - :ref:`COMMAND_COLLECTION_NAME ` - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static **void** - - | :ref:`checkCollectionNameValidity ` ( - | `String `__ collectionName - | ) - - - Check the validity of the given collection name. - - - - - * - public static **void** - - | :ref:`checkDatabaseNameValidity ` ( - | `String `__ databaseName - | ) - - - Check the validity of the given database name. - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public `String `__ - - | :ref:`getCollectionName ` () - | - - - Gets the collection name. - - - - - * - public `String `__ - - | :ref:`getDatabaseName ` () - | - - - Gets the database name. - - - - - * - public `String `__ - - | :ref:`getFullName ` () - | - - - Gets the full name, which is the database name and the collection name, separated by a period. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - Returns the standard MongoDB representation of a namespace, which is ``.`` . - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_mongodb_mongo_MongoNamespace_COMMAND_COLLECTION_NAME: - - - -``COMMAND_COLLECTION_NAME`` ----------------------------- - - - - - - -Constructor Detail -================== - -.. _MongoNamespace: - -.. _MongoNamespace__: - -.. _io_realm_mongodb_mongo_MongoNamespace: - -.. _io_realm_mongodb_mongo_MongoNamespace__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoNamespace ` ( - | `String `__ fullName - | ) - - - - - * - Construct an instance for the given full name. The database name is the string preceding the first ``"."`` character. - - - - - - - **Parameters** - - - ``fullName`` - the non-null full namespace - - - - - - - - - - .. seealso:: - - - - - :ref:`checkDatabaseNameValidity(String) ` - - - - - :ref:`checkCollectionNameValidity(String) ` - - - - - - - - - - - - -.. _MongoNamespace: - -.. _MongoNamespace__: - -.. _io_realm_mongodb_mongo_MongoNamespace: - -.. _io_realm_mongodb_mongo_MongoNamespace__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`MongoNamespace ` ( - | `String `__ databaseName, - | `String `__ collectionName - | ) - - - - - * - Construct an instance from the given database name and collection name. - - - - - **Parameters** - - - ``databaseName`` - the valid database name - - - - - ``collectionName`` - the valid collection name - - - - - - - - - - .. seealso:: - - - - - :ref:`checkDatabaseNameValidity(String) ` - - - - - :ref:`checkCollectionNameValidity(String) ` - - - - - - - - - - - - - - -Method Detail -============= - -.. _checkCollectionNameValidity: - -.. _checkCollectionNameValidity__: - -.. _MongoNamespace_checkCollectionNameValidity: - -.. _MongoNamespace_checkCollectionNameValidity__: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkCollectionNameValidity: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkCollectionNameValidity__: - - - -checkCollectionNameValidity ---------------------------- - -.. _io_realm_mongodb_mongo_MongoNamespace_checkCollectionNameValidity_java_lang_String_: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkCollectionNameValidity_String_: - -.. _checkCollectionNameValidity_java_lang_String_: - -.. _checkCollectionNameValidity_String_: - -.. _MongoNamespace_checkCollectionNameValidity_java_lang_String_: - -.. _MongoNamespace_checkCollectionNameValidity_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`checkCollectionNameValidity ` ( - | `String `__ collectionName - | ) - - - - - * - Check the validity of the given collection name. A valid collection name is non-null and non-empty. The server may impose additional restrictions on collection names. - - - - - **Parameters** - - - ``collectionName`` - the collection name - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the collection name is invalid - - - - - - - - - - - - -.. _checkDatabaseNameValidity: - -.. _checkDatabaseNameValidity__: - -.. _MongoNamespace_checkDatabaseNameValidity: - -.. _MongoNamespace_checkDatabaseNameValidity__: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkDatabaseNameValidity: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkDatabaseNameValidity__: - - - -checkDatabaseNameValidity -------------------------- - -.. _io_realm_mongodb_mongo_MongoNamespace_checkDatabaseNameValidity_java_lang_String_: - -.. _io_realm_mongodb_mongo_MongoNamespace_checkDatabaseNameValidity_String_: - -.. _checkDatabaseNameValidity_java_lang_String_: - -.. _checkDatabaseNameValidity_String_: - -.. _MongoNamespace_checkDatabaseNameValidity_java_lang_String_: - -.. _MongoNamespace_checkDatabaseNameValidity_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static **void** :ref:`checkDatabaseNameValidity ` ( - | `String `__ databaseName - | ) - - - - - * - Check the validity of the given database name. A valid database name is non-null, non-empty, and does not contain any of the following characters: ``'\0', '/', '\\', ' ', '"', '.'`` . The server may impose additional restrictions on database names. - - - - - - - **Parameters** - - - ``databaseName`` - the database name - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the database name is invalid - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _MongoNamespace_equals: - -.. _MongoNamespace_equals__: - -.. _io_realm_mongodb_mongo_MongoNamespace_equals: - -.. _io_realm_mongodb_mongo_MongoNamespace_equals__: - - - -equals ------- - -.. _io_realm_mongodb_mongo_MongoNamespace_equals_java_lang_Object_: - -.. _io_realm_mongodb_mongo_MongoNamespace_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _MongoNamespace_equals_java_lang_Object_: - -.. _MongoNamespace_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getCollectionName: - -.. _getCollectionName__: - -.. _MongoNamespace_getCollectionName: - -.. _MongoNamespace_getCollectionName__: - -.. _io_realm_mongodb_mongo_MongoNamespace_getCollectionName: - -.. _io_realm_mongodb_mongo_MongoNamespace_getCollectionName__: - - - -getCollectionName ------------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getCollectionName ` () - | - - - - - * - Gets the collection name. - - - - - - - **Returns** - - the collection name - - - - - - - - - - - -.. _getDatabaseName: - -.. _getDatabaseName__: - -.. _MongoNamespace_getDatabaseName: - -.. _MongoNamespace_getDatabaseName__: - -.. _io_realm_mongodb_mongo_MongoNamespace_getDatabaseName: - -.. _io_realm_mongodb_mongo_MongoNamespace_getDatabaseName__: - - - -getDatabaseName ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getDatabaseName ` () - | - - - - - * - Gets the database name. - - - - - - - **Returns** - - the database name - - - - - - - - - - - -.. _getFullName: - -.. _getFullName__: - -.. _MongoNamespace_getFullName: - -.. _MongoNamespace_getFullName__: - -.. _io_realm_mongodb_mongo_MongoNamespace_getFullName: - -.. _io_realm_mongodb_mongo_MongoNamespace_getFullName__: - - - -getFullName ------------ - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getFullName ` () - | - - - - - * - Gets the full name, which is the database name and the collection name, separated by a period. - - - - - - - **Returns** - - the full name - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _MongoNamespace_hashCode: - -.. _MongoNamespace_hashCode__: - -.. _io_realm_mongodb_mongo_MongoNamespace_hashCode: - -.. _io_realm_mongodb_mongo_MongoNamespace_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _toString: - -.. _toString__: - -.. _MongoNamespace_toString: - -.. _MongoNamespace_toString__: - -.. _io_realm_mongodb_mongo_MongoNamespace_toString: - -.. _io_realm_mongodb_mongo_MongoNamespace_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - Returns the standard MongoDB representation of a namespace, which is ``.`` . - - - - - - - - - **Returns** - - string representation of the namespace. - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events.txt deleted file mode 100644 index fc312470e3..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events.txt +++ /dev/null @@ -1,34 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.mongo.events -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - BaseChangeEvent - BaseChangeEvent.OperationType - UpdateDescription - - - -| - -- :ref:`io.realm.mongodb.mongo.events.BaseChangeEvent ` -- :ref:`io.realm.mongodb.mongo.events.BaseChangeEvent.OperationType ` -- :ref:`io.realm.mongodb.mongo.events.UpdateDescription ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt deleted file mode 100644 index ad37afc277..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent.txt +++ /dev/null @@ -1,414 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class BaseChangeEvent -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent: - - - -io.realm.mongodb.mongo.events -============================= - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.events.BaseChangeEvent - - -Represents the set of properties that exist on all MongoDB realm change events produced by watch streams in this SDK. Other change event types inherit from this type. - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`BaseChangeEvent.OperationType ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **BsonDocument** - - | :ref:`getDocumentKey ` () - | - - - The unique identifier for the document that was actually changed. - - - - - * - public **DocumentT** - - | :ref:`getFullDocument ` () - | - - - The full document at some point after the change has been applied. - - - - - * - public :ref:`BaseChangeEvent.OperationType ` - - | :ref:`getOperationType ` () - | - - - Returns the operation type of the change that triggered the change event. - - - - - * - public :ref:`UpdateDescription ` - - | :ref:`getUpdateDescription ` () - | - - - In the case of an update, the description of which fields have been added, removed or updated. - - - - - * - public **boolean** - - | :ref:`hasUncommittedWrites ` () - | - - - Indicates a local change event that has not yet been synchronized with a remote data store. - - - - - * - public abstract **BsonDocument** - - | :ref:`toBsonDocument ` () - | - - - Converts the change event to a BSON representation, as it would look on a MongoDB realm change stream, or a Realm compact watch stream. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _getDocumentKey: - -.. _getDocumentKey__: - -.. _BaseChangeEvent_getDocumentKey: - -.. _BaseChangeEvent_getDocumentKey__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getDocumentKey: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getDocumentKey__: - - - -getDocumentKey --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonDocument** :ref:`getDocumentKey ` () - | - - - - - * - The unique identifier for the document that was actually changed. - - - - - - - **Returns** - - the document key. - - - - - - - - - - - -.. _getFullDocument: - -.. _getFullDocument__: - -.. _BaseChangeEvent_getFullDocument: - -.. _BaseChangeEvent_getFullDocument__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getFullDocument: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getFullDocument__: - - - -getFullDocument ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public **DocumentT** :ref:`getFullDocument ` () - | - - - - - * - The full document at some point after the change has been applied. - - - - - - - **Returns** - - the full document. - - - - - - - - - - - -.. _getOperationType: - -.. _getOperationType__: - -.. _BaseChangeEvent_getOperationType: - -.. _BaseChangeEvent_getOperationType__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getOperationType: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getOperationType__: - - - -getOperationType ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`BaseChangeEvent.OperationType ` :ref:`getOperationType ` () - | - - - - - * - Returns the operation type of the change that triggered the change event. - - - - - - - **Returns** - - the operation type of this change event. - - - - - - - - - - - -.. _getUpdateDescription: - -.. _getUpdateDescription__: - -.. _BaseChangeEvent_getUpdateDescription: - -.. _BaseChangeEvent_getUpdateDescription__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getUpdateDescription: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_getUpdateDescription__: - - - -getUpdateDescription --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UpdateDescription ` :ref:`getUpdateDescription ` () - | - - - - - * - In the case of an update, the description of which fields have been added, removed or updated. - - - - - - - **Returns** - - the update description. - - - - - - - - - - - -.. _hasUncommittedWrites: - -.. _hasUncommittedWrites__: - -.. _BaseChangeEvent_hasUncommittedWrites: - -.. _BaseChangeEvent_hasUncommittedWrites__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_hasUncommittedWrites: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_hasUncommittedWrites__: - - - -hasUncommittedWrites --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasUncommittedWrites ` () - | - - - - - * - Indicates a local change event that has not yet been synchronized with a remote data store. Used only for the sync use case. - - - - - - - **Returns** - - whether or not this change event represents uncommitted writes. - - - - - - - - - - - -.. _toBsonDocument: - -.. _toBsonDocument__: - -.. _BaseChangeEvent_toBsonDocument: - -.. _BaseChangeEvent_toBsonDocument__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_toBsonDocument: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_toBsonDocument__: - - - -toBsonDocument --------------- - -.. list-table:: - :header-rows: 1 - - * - | public abstract **BsonDocument** :ref:`toBsonDocument ` () - | - - - - - * - Converts the change event to a BSON representation, as it would look on a MongoDB realm change stream, or a Realm compact watch stream. - - - - - - - **Returns** - - The BSON document representation of the change event. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt deleted file mode 100644 index f09004912e..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/BaseChangeEvent/OperationType.txt +++ /dev/null @@ -1,318 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum BaseChangeEvent.OperationType -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType: - - - -io.realm.mongodb.mongo.events -============================= - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.mongo.events.BaseChangeEvent.OperationType - - - - -**Enclosing class:** - -:ref:`BaseChangeEvent ` - - - -Represents the different MongoDB operations that can occur. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`DELETE ` - - - - - - - * - :ref:`INSERT ` - - - - - - - * - :ref:`REPLACE ` - - - - - - - * - :ref:`UNKNOWN ` - - - - - - - * - :ref:`UPDATE ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`BaseChangeEvent.OperationType ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`BaseChangeEvent.OperationType ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_DELETE: - -.. _BaseChangeEvent_OperationType_DELETE: - - - -``DELETE`` ------------ - -public static final :ref:`BaseChangeEvent.OperationType ` - - - - - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_INSERT: - -.. _BaseChangeEvent_OperationType_INSERT: - - - -``INSERT`` ------------ - -public static final :ref:`BaseChangeEvent.OperationType ` - - - - - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_REPLACE: - -.. _BaseChangeEvent_OperationType_REPLACE: - - - -``REPLACE`` ------------- - -public static final :ref:`BaseChangeEvent.OperationType ` - - - - - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_UNKNOWN: - -.. _BaseChangeEvent_OperationType_UNKNOWN: - - - -``UNKNOWN`` ------------- - -public static final :ref:`BaseChangeEvent.OperationType ` - - - - - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_UPDATE: - -.. _BaseChangeEvent_OperationType_UPDATE: - - - -``UPDATE`` ------------ - -public static final :ref:`BaseChangeEvent.OperationType ` - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _OperationType_valueOf: - -.. _OperationType_valueOf__: - -.. _BaseChangeEvent_OperationType_valueOf: - -.. _BaseChangeEvent_OperationType_valueOf__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_valueOf: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_valueOf_java_lang_String_: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _BaseChangeEvent_OperationType_valueOf_java_lang_String_: - -.. _BaseChangeEvent_OperationType_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`BaseChangeEvent.OperationType ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _OperationType_values: - -.. _OperationType_values__: - -.. _BaseChangeEvent_OperationType_values: - -.. _BaseChangeEvent_OperationType_values__: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_values: - -.. _io_realm_mongodb_mongo_events_BaseChangeEvent_OperationType_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`BaseChangeEvent.OperationType ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt b/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt deleted file mode 100644 index 66486fc5ed..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/events/UpdateDescription.txt +++ /dev/null @@ -1,714 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class UpdateDescription -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_events_UpdateDescription: - - - -io.realm.mongodb.mongo.events -============================= - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.events.UpdateDescription - - -Indicates which fields have been modified in a given update operation. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`UpdateDescription ` - - | :ref:`diff ` ( - | **BsonDocument** beforeDocument, - | **BsonDocument** afterDocument - | ) - - - Find the diff between two documents. - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ obj - | ) - - - - - - - - * - public static :ref:`UpdateDescription ` - - | :ref:`fromBsonDocument ` ( - | **BsonDocument** document - | ) - - - Converts an update description BSON document from a MongoDB Change Event into an UpdateDescription object. - - - - - * - public `Collection `__ - - | :ref:`getRemovedFields ` () - | - - - Returns a `List `__ containing the field names that have been removed in the corresponding update. - - - - - - - * - public **BsonDocument** - - | :ref:`getUpdatedFields ` () - | - - - Returns a **BsonDocument** containing keys and values representing (respectively) the fields that have changed in the corresponding update and their new values. - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isEmpty ` () - | - - - Determines whether this update description is empty. - - - - - * - public :ref:`UpdateDescription ` - - | :ref:`merge ` ( - | :ref:`UpdateDescription ` otherDescription - | ) - - - Unilaterally merge an update description into this update description. - - - - - * - public **BsonDocument** - - | :ref:`toBsonDocument ` () - | - - - Converts this update description to its document representation as it would appear in a MongoDB Change Event. - - - - - * - public **BsonDocument** - - | :ref:`toUpdateDocument ` () - | - - - Convert this update description to an update document. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _diff: - -.. _diff__: - -.. _UpdateDescription_diff: - -.. _UpdateDescription_diff__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_diff: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_diff__: - - - -diff ----- - -.. _io_realm_mongodb_mongo_events_UpdateDescription_diff_BsonDocument_BsonDocument_: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_diff_BsonDocument__BsonDocument_: - -.. _diff_BsonDocument_BsonDocument_: - -.. _diff_BsonDocument__BsonDocument_: - -.. _UpdateDescription_diff_BsonDocument_BsonDocument_: - -.. _UpdateDescription_diff_BsonDocument__BsonDocument_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`UpdateDescription ` :ref:`diff ` ( - | **BsonDocument** beforeDocument, - | **BsonDocument** afterDocument - | ) - - - - - * - Find the diff between two documents.NOTE: This does not do a full diff on [BsonArray]. If there is an inequality between the old and new array, the old array will simply be replaced by the new one. - - - - - - - **Parameters** - - - ``beforeDocument`` - original document - - - - - ``afterDocument`` - document to diff on - - - - - - - - **Returns** - - a description of the updated fields and removed keys between the documents. - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _UpdateDescription_equals: - -.. _UpdateDescription_equals__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_equals: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_equals__: - - - -equals ------- - -.. _io_realm_mongodb_mongo_events_UpdateDescription_equals_java_lang_Object_: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _UpdateDescription_equals_java_lang_Object_: - -.. _UpdateDescription_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ obj - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _fromBsonDocument: - -.. _fromBsonDocument__: - -.. _UpdateDescription_fromBsonDocument: - -.. _UpdateDescription_fromBsonDocument__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_fromBsonDocument: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_fromBsonDocument__: - - - -fromBsonDocument ----------------- - -.. _io_realm_mongodb_mongo_events_UpdateDescription_fromBsonDocument_BsonDocument_: - -.. _fromBsonDocument_BsonDocument_: - -.. _UpdateDescription_fromBsonDocument_BsonDocument_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`UpdateDescription ` :ref:`fromBsonDocument ` ( - | **BsonDocument** document - | ) - - - - - * - Converts an update description BSON document from a MongoDB Change Event into an UpdateDescription object. - - - - - **Parameters** - - - ``document`` - the - - - - - - - - **Returns** - - the converted UpdateDescription - - - - - - - - - - - -.. _getRemovedFields: - -.. _getRemovedFields__: - -.. _UpdateDescription_getRemovedFields: - -.. _UpdateDescription_getRemovedFields__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_getRemovedFields: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_getRemovedFields__: - - - -getRemovedFields ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Collection `__ :ref:`getRemovedFields ` () - | - - - - - * - Returns a `List `__ containing the field names that have been removed in the corresponding update. - - - - - - - - - **Returns** - - the removed fields names. - - - - - - - - - - - -.. _getUpdatedFields: - -.. _getUpdatedFields__: - -.. _UpdateDescription_getUpdatedFields: - -.. _UpdateDescription_getUpdatedFields__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_getUpdatedFields: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_getUpdatedFields__: - - - -getUpdatedFields ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonDocument** :ref:`getUpdatedFields ` () - | - - - - - * - Returns a **BsonDocument** containing keys and values representing (respectively) the fields that have changed in the corresponding update and their new values. - - - - - - - - - **Returns** - - the updated field names and their new values. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _UpdateDescription_hashCode: - -.. _UpdateDescription_hashCode__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_hashCode: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isEmpty: - -.. _isEmpty__: - -.. _UpdateDescription_isEmpty: - -.. _UpdateDescription_isEmpty__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_isEmpty: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_isEmpty__: - - - -isEmpty -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isEmpty ` () - | - - - - - * - Determines whether this update description is empty. - - - - - - - **Returns** - - true if the update description is empty, false otherwise - - - - - - - - - - - -.. _merge: - -.. _merge__: - -.. _UpdateDescription_merge: - -.. _UpdateDescription_merge__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_merge: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_merge__: - - - -merge ------ - -.. _io_realm_mongodb_mongo_events_UpdateDescription_merge_io_realm_mongodb_mongo_events_UpdateDescription_: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_merge_UpdateDescription_: - -.. _merge_io_realm_mongodb_mongo_events_UpdateDescription_: - -.. _merge_UpdateDescription_: - -.. _UpdateDescription_merge_io_realm_mongodb_mongo_events_UpdateDescription_: - -.. _UpdateDescription_merge_UpdateDescription_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UpdateDescription ` :ref:`merge ` ( - | :ref:`UpdateDescription ` otherDescription - | ) - - - - - * - Unilaterally merge an update description into this update description. - - - - - **Parameters** - - - ``otherDescription`` - the update description to merge into this - - - - - - - - **Returns** - - this merged update description - - - - - - - - - - - -.. _toBsonDocument: - -.. _toBsonDocument__: - -.. _UpdateDescription_toBsonDocument: - -.. _UpdateDescription_toBsonDocument__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_toBsonDocument: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_toBsonDocument__: - - - -toBsonDocument --------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonDocument** :ref:`toBsonDocument ` () - | - - - - - * - Converts this update description to its document representation as it would appear in a MongoDB Change Event. - - - - - - - **Returns** - - the update description document as it would appear in a change event - - - - - - - - - - - -.. _toUpdateDocument: - -.. _toUpdateDocument__: - -.. _UpdateDescription_toUpdateDocument: - -.. _UpdateDescription_toUpdateDocument__: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_toUpdateDocument: - -.. _io_realm_mongodb_mongo_events_UpdateDescription_toUpdateDocument__: - - - -toUpdateDocument ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonDocument** :ref:`toUpdateDocument ` () - | - - - - - * - Convert this update description to an update document. - - - - - - - **Returns** - - an update document with the appropriate $set and $unset documents. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable.txt deleted file mode 100644 index 70a63ada63..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable.txt +++ /dev/null @@ -1,36 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.mongo.iterable -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - AggregateIterable - FindIterable - MongoCursor - MongoIterable - - - -| - -- :ref:`io.realm.mongodb.mongo.iterable.AggregateIterable ` -- :ref:`io.realm.mongodb.mongo.iterable.FindIterable ` -- :ref:`io.realm.mongodb.mongo.iterable.MongoCursor ` -- :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt deleted file mode 100644 index 25d132ec8e..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/AggregateIterable.txt +++ /dev/null @@ -1,107 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class AggregateIterable -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_iterable_AggregateIterable: - - - -io.realm.mongodb.mongo.iterable -=============================== - - - | `java.lang.Object `__ - | :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` - | io.realm.mongodb.mongo.iterable.AggregateIterable - - -Specific iterable for :ref:`io.realm.mongodb.mongo.MongoCollection.aggregate(List) ` operations. - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`AggregateIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **** osMongoCollection, - | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass, - | `java.util.List\ `__ pipeline - | ) - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` : ``iterator`` , ``first`` - - - - -Constructor Detail -================== - -.. _AggregateIterable: - -.. _AggregateIterable__: - -.. _io_realm_mongodb_mongo_iterable_AggregateIterable: - -.. _io_realm_mongodb_mongo_iterable_AggregateIterable__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`AggregateIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **** osMongoCollection, - | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass, - | `java.util.List\ `__ pipeline - | ) - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt deleted file mode 100644 index 6a8b4240ce..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/FindIterable.txt +++ /dev/null @@ -1,414 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class FindIterable -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_iterable_FindIterable: - - - -io.realm.mongodb.mongo.iterable -=============================== - - - | `java.lang.Object `__ - | :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` - | io.realm.mongodb.mongo.iterable.FindIterable - - -Specific iterable for :ref:`io.realm.mongodb.mongo.MongoCollection.find() ` operations. - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`FindIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **** osMongoCollection, - | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`FindIterable ` - - | :ref:`filter ` ( - | **Bson** filter - | ) - - - Sets the query filter to apply to the query. - - - - - * - public :ref:`FindIterable ` - - | :ref:`limit ` ( - | **int** limit - | ) - - - Sets the limit to apply. - - - - - * - public :ref:`FindIterable ` - - | :ref:`projection ` ( - | **Bson** projection - | ) - - - Sets a document describing the fields to return for all matching documents. - - - - - * - public :ref:`FindIterable ` - - | :ref:`sort ` ( - | **Bson** sort - | ) - - - Sets the sort criteria to apply to the query. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.mongodb.mongo.iterable.MongoIterable ` : ``iterator`` , ``first`` - - - - -Constructor Detail -================== - -.. _FindIterable: - -.. _FindIterable__: - -.. _io_realm_mongodb_mongo_iterable_FindIterable: - -.. _io_realm_mongodb_mongo_iterable_FindIterable__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` ( - | `ThreadPoolExecutor `__ threadPoolExecutor, - | **** osMongoCollection, - | **CodecRegistry** codecRegistry, - | `java.lang.Class\ `__ resultClass - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _filter: - -.. _filter__: - -.. _FindIterable_filter: - -.. _FindIterable_filter__: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_filter: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_filter__: - - - -filter ------- - -.. _io_realm_mongodb_mongo_iterable_FindIterable_filter_Bson_: - -.. _filter_Bson_: - -.. _FindIterable_filter_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`filter ` ( - | **Bson** filter - | ) - - - - - * - Sets the query filter to apply to the query. - - - - - **Parameters** - - - ``filter`` - the filter, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _limit: - -.. _limit__: - -.. _FindIterable_limit: - -.. _FindIterable_limit__: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_limit: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_limit__: - - - -limit ------ - -.. _io_realm_mongodb_mongo_iterable_FindIterable_limit_int_: - -.. _limit_int_: - -.. _FindIterable_limit_int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`limit ` ( - | **int** limit - | ) - - - - - * - Sets the limit to apply. - - - - - **Parameters** - - - ``limit`` - the limit, which may be 0 - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _projection: - -.. _projection__: - -.. _FindIterable_projection: - -.. _FindIterable_projection__: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_projection: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_projection__: - - - -projection ----------- - -.. _io_realm_mongodb_mongo_iterable_FindIterable_projection_Bson_: - -.. _projection_Bson_: - -.. _FindIterable_projection_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`projection ` ( - | **Bson** projection - | ) - - - - - * - Sets a document describing the fields to return for all matching documents. - - - - - **Parameters** - - - ``projection`` - the project document, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _FindIterable_sort: - -.. _FindIterable_sort__: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_sort: - -.. _io_realm_mongodb_mongo_iterable_FindIterable_sort__: - - - -sort ----- - -.. _io_realm_mongodb_mongo_iterable_FindIterable_sort_Bson_: - -.. _sort_Bson_: - -.. _FindIterable_sort_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindIterable ` :ref:`sort ` ( - | **Bson** sort - | ) - - - - - * - Sets the sort criteria to apply to the query. - - - - - **Parameters** - - - ``sort`` - the sort criteria, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt deleted file mode 100644 index 5c8c792d5b..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoCursor.txt +++ /dev/null @@ -1,288 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoCursor -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_iterable_MongoCursor: - - - -io.realm.mongodb.mongo.iterable -=============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.iterable.MongoCursor - - -**Implemented interfaces:** - - - -- `java.util.Iterator `__ -- `java.io.Closeable `__ -- `java.lang.AutoCloseable `__ - - -The Mongo Cursor class is fundamentally an `Iterator `__ containing an additional ``tryNext()`` method for convenience. - -An application should ensure that a cursor is closed in all circumstances, e.g. using a try-with-resources statement. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`close ` () - | - - - - - - - - * - public **boolean** - - | :ref:`hasNext ` () - | - - - - - - - - * - public **ResultT** - - | :ref:`next ` () - | - - - - - - - - * - public **ResultT** - - | :ref:`tryNext ` () - | - - - A special ``next()`` case that returns the next document if available or null. - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _close: - -.. _close__: - -.. _MongoCursor_close: - -.. _MongoCursor_close__: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_close: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_close__: - - - -close ------ - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`close ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _hasNext: - -.. _hasNext__: - -.. _MongoCursor_hasNext: - -.. _MongoCursor_hasNext__: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_hasNext: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_hasNext__: - - - -hasNext -------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`hasNext ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _next: - -.. _next__: - -.. _MongoCursor_next: - -.. _MongoCursor_next__: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_next: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_next__: - - - -next ----- - -.. list-table:: - :header-rows: 1 - - * - | public **ResultT** :ref:`next ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _tryNext: - -.. _tryNext__: - -.. _MongoCursor_tryNext: - -.. _MongoCursor_tryNext__: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_tryNext: - -.. _io_realm_mongodb_mongo_iterable_MongoCursor_tryNext__: - - - -tryNext -------- - -.. list-table:: - :header-rows: 1 - - * - | public **ResultT** :ref:`tryNext ` () - | - - - - - * - A special ``next()`` case that returns the next document if available or null. - - - - - - - - - **Returns** - - A ``Task`` containing the next document if available or null. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt b/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt deleted file mode 100644 index f26abb2899..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/iterable/MongoIterable.txt +++ /dev/null @@ -1,184 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class MongoIterable -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_iterable_MongoIterable: - - - -io.realm.mongodb.mongo.iterable -=============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.iterable.MongoIterable - - -The MongoIterable is the results from an operation, such as a ``find()`` or an ``aggregate()`` query. - -This class somewhat mimics the behavior of an `Iterable `__ but given its results are obtained asynchronously, its values are wrapped inside a ``Task`` . - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`RealmResultTask ` - - | :ref:`first ` () - | - - - Helper to return the first item in the iterator or null. - - - - - * - public :ref:`RealmResultTask ` - - | :ref:`iterator ` () - | - - - Returns a cursor of the operation represented by this iterable. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _first: - -.. _first__: - -.. _MongoIterable_first: - -.. _MongoIterable_first__: - -.. _io_realm_mongodb_mongo_iterable_MongoIterable_first: - -.. _io_realm_mongodb_mongo_iterable_MongoIterable_first__: - - - -first ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`first ` () - | - - - - - * - Helper to return the first item in the iterator or null.The result is wrapped in a ``Task`` since the iterator should be capable of asynchronously retrieve documents from the server. - - - - - - - - - - - **Returns** - - a task containing the first item or null. - - - - - - - - - - - -.. _iterator: - -.. _iterator__: - -.. _MongoIterable_iterator: - -.. _MongoIterable_iterator__: - -.. _io_realm_mongodb_mongo_iterable_MongoIterable_iterator: - -.. _io_realm_mongodb_mongo_iterable_MongoIterable_iterator__: - - - -iterator --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmResultTask ` :ref:`iterator ` () - | - - - - - * - Returns a cursor of the operation represented by this iterable.The result is wrapped in a ``Task`` since the iterator should be capable of asynchronously retrieve documents from the server. - - - - - - - - - - - **Returns** - - an asynchronous task with cursor of the operation represented by this iterable. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options.txt deleted file mode 100644 index c65a338bcf..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options.txt +++ /dev/null @@ -1,38 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.mongo.options -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - CountOptions - FindOneAndModifyOptions - FindOptions - InsertManyResult - UpdateOptions - - - -| - -- :ref:`io.realm.mongodb.mongo.options.CountOptions ` -- :ref:`io.realm.mongodb.mongo.options.FindOneAndModifyOptions ` -- :ref:`io.realm.mongodb.mongo.options.FindOptions ` -- :ref:`io.realm.mongodb.mongo.options.InsertManyResult ` -- :ref:`io.realm.mongodb.mongo.options.UpdateOptions ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt deleted file mode 100644 index ef1d3209ad..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/CountOptions.txt +++ /dev/null @@ -1,296 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class CountOptions -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_options_CountOptions: - - - -io.realm.mongodb.mongo.options -============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.options.CountOptions - - -The options for a count operation. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`CountOptions ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **int** - - | :ref:`getLimit ` () - | - - - Gets the limit to apply. - - - - - * - public :ref:`CountOptions ` - - | :ref:`limit ` ( - | **int** limit - | ) - - - Sets the limit to apply. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _CountOptions: - -.. _CountOptions__: - -.. _io_realm_mongodb_mongo_options_CountOptions: - -.. _io_realm_mongodb_mongo_options_CountOptions__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`CountOptions ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getLimit: - -.. _getLimit__: - -.. _CountOptions_getLimit: - -.. _CountOptions_getLimit__: - -.. _io_realm_mongodb_mongo_options_CountOptions_getLimit: - -.. _io_realm_mongodb_mongo_options_CountOptions_getLimit__: - - - -getLimit --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getLimit ` () - | - - - - - * - Gets the limit to apply. The default is 0, which means there is no limit. - - - - - - - **Returns** - - the limit - - - - - - - - - - - -.. _limit: - -.. _limit__: - -.. _CountOptions_limit: - -.. _CountOptions_limit__: - -.. _io_realm_mongodb_mongo_options_CountOptions_limit: - -.. _io_realm_mongodb_mongo_options_CountOptions_limit__: - - - -limit ------ - -.. _io_realm_mongodb_mongo_options_CountOptions_limit_int_: - -.. _limit_int_: - -.. _CountOptions_limit_int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`CountOptions ` :ref:`limit ` ( - | **int** limit - | ) - - - - - * - Sets the limit to apply. - - - - - **Parameters** - - - ``limit`` - the limit - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _CountOptions_toString: - -.. _CountOptions_toString__: - -.. _io_realm_mongodb_mongo_options_CountOptions_toString: - -.. _io_realm_mongodb_mongo_options_CountOptions_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt deleted file mode 100644 index 29c2633abb..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOneAndModifyOptions.txt +++ /dev/null @@ -1,686 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class FindOneAndModifyOptions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions: - - - -io.realm.mongodb.mongo.options -============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.options.FindOneAndModifyOptions - - -The options to apply to a findOneAndUpdate, findOneAndReplace, or findOneAndDelete operation (also commonly referred to as findOneAndModify operations). - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`FindOneAndModifyOptions ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **Bson** - - | :ref:`getProjection ` () - | - - - Gets a document describing the fields to return for all matching documents. - - - - - * - public **Bson** - - | :ref:`getSort ` () - | - - - Gets the sort criteria to apply to the query. - - - - - * - public **boolean** - - | :ref:`isReturnNewDocument ` () - | - - - Returns true if the findOneAndModify operation should return the new document. - - - - - * - public **boolean** - - | :ref:`isUpsert ` () - | - - - Returns true if a new document should be inserted if there are no matches to the query filter. - - - - - * - public :ref:`FindOneAndModifyOptions ` - - | :ref:`projection ` ( - | **Bson** projection - | ) - - - Sets a document describing the fields to return for all matching documents. - - - - - * - public :ref:`FindOneAndModifyOptions ` - - | :ref:`returnNewDocument ` ( - | **boolean** returnNewDocument - | ) - - - Set to true if findOneAndModify operations should return the new updated document. - - - - - * - public :ref:`FindOneAndModifyOptions ` - - | :ref:`sort ` ( - | **Bson** sort - | ) - - - Sets the sort criteria to apply to the query. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - * - public :ref:`FindOneAndModifyOptions ` - - | :ref:`upsert ` ( - | **boolean** upsert - | ) - - - Set to true if a new document should be inserted if there are no matches to the query filter. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _FindOneAndModifyOptions: - -.. _FindOneAndModifyOptions__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOneAndModifyOptions ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _getProjection: - -.. _getProjection__: - -.. _FindOneAndModifyOptions_getProjection: - -.. _FindOneAndModifyOptions_getProjection__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_getProjection: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_getProjection__: - - - -getProjection -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **Bson** :ref:`getProjection ` () - | - - - - - * - Gets a document describing the fields to return for all matching documents. - - - - - - - **Returns** - - the project document, which may be null - - - - - - - - - - - -.. _getSort: - -.. _getSort__: - -.. _FindOneAndModifyOptions_getSort: - -.. _FindOneAndModifyOptions_getSort__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_getSort: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_getSort__: - - - -getSort -------- - -.. list-table:: - :header-rows: 1 - - * - | public **Bson** :ref:`getSort ` () - | - - - - - * - Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order. - - - - - - - **Returns** - - a document describing the sort criteria - - - - - - - - - - - -.. _isReturnNewDocument: - -.. _isReturnNewDocument__: - -.. _FindOneAndModifyOptions_isReturnNewDocument: - -.. _FindOneAndModifyOptions_isReturnNewDocument__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_isReturnNewDocument: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_isReturnNewDocument__: - - - -isReturnNewDocument -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isReturnNewDocument ` () - | - - - - - * - Returns true if the findOneAndModify operation should return the new document. The default is false Note: Only findOneAndUpdate and findOneAndReplace take this options findOneAndDelete will always return the old document - - - - - - - **Returns** - - true if findOneAndModify operation should return the new document - - - - - - - - - - - -.. _isUpsert: - -.. _isUpsert__: - -.. _FindOneAndModifyOptions_isUpsert: - -.. _FindOneAndModifyOptions_isUpsert__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_isUpsert: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_isUpsert__: - - - -isUpsert --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isUpsert ` () - | - - - - - * - Returns true if a new document should be inserted if there are no matches to the query filter. The default is false. Note: Only findOneAndUpdate and findOneAndReplace take this option - - - - - - - **Returns** - - true if a new document should be inserted if there are no matches to the query filter - - - - - - - - - - - -.. _projection: - -.. _projection__: - -.. _FindOneAndModifyOptions_projection: - -.. _FindOneAndModifyOptions_projection__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_projection: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_projection__: - - - -projection ----------- - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_projection_Bson_: - -.. _projection_Bson_: - -.. _FindOneAndModifyOptions_projection_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOneAndModifyOptions ` :ref:`projection ` ( - | **Bson** projection - | ) - - - - - * - Sets a document describing the fields to return for all matching documents. - - - - - **Parameters** - - - ``projection`` - the project document, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _returnNewDocument: - -.. _returnNewDocument__: - -.. _FindOneAndModifyOptions_returnNewDocument: - -.. _FindOneAndModifyOptions_returnNewDocument__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_returnNewDocument: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_returnNewDocument__: - - - -returnNewDocument ------------------ - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_returnNewDocument_boolean_: - -.. _returnNewDocument_boolean_: - -.. _FindOneAndModifyOptions_returnNewDocument_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOneAndModifyOptions ` :ref:`returnNewDocument ` ( - | **boolean** returnNewDocument - | ) - - - - - * - Set to true if findOneAndModify operations should return the new updated document. Set to false / leave blank to have these operation return the document before the update. Note: Only findOneAndUpdate and findOneAndReplace take this options findOneAndDelete will always return the old document - - - - - **Parameters** - - - ``returnNewDocument`` - true if findOneAndModify operations should return the updated document - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _FindOneAndModifyOptions_sort: - -.. _FindOneAndModifyOptions_sort__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_sort: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_sort__: - - - -sort ----- - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_sort_Bson_: - -.. _sort_Bson_: - -.. _FindOneAndModifyOptions_sort_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOneAndModifyOptions ` :ref:`sort ` ( - | **Bson** sort - | ) - - - - - * - Sets the sort criteria to apply to the query. - - - - - **Parameters** - - - ``sort`` - the sort criteria, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _FindOneAndModifyOptions_toString: - -.. _FindOneAndModifyOptions_toString__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_toString: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - -.. _upsert: - -.. _upsert__: - -.. _FindOneAndModifyOptions_upsert: - -.. _FindOneAndModifyOptions_upsert__: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_upsert: - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_upsert__: - - - -upsert ------- - -.. _io_realm_mongodb_mongo_options_FindOneAndModifyOptions_upsert_boolean_: - -.. _upsert_boolean_: - -.. _FindOneAndModifyOptions_upsert_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOneAndModifyOptions ` :ref:`upsert ` ( - | **boolean** upsert - | ) - - - - - * - Set to true if a new document should be inserted if there are no matches to the query filter. - - - - - **Parameters** - - - ``upsert`` - true if a new document should be inserted if there are no matches to the query filter. - - - - - - - - **Returns** - - this - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt deleted file mode 100644 index e809abfc7d..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/FindOptions.txt +++ /dev/null @@ -1,556 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class FindOptions -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_options_FindOptions: - - - -io.realm.mongodb.mongo.options -============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.options.FindOptions - - -The options to apply to a find operation (also commonly referred to as a query). - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`FindOptions ` () - | - - - Construct a new instance. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **int** - - | :ref:`getLimit ` () - | - - - Gets the limit to apply. - - - - - * - public **Bson** - - | :ref:`getProjection ` () - | - - - Gets a document describing the fields to return for all matching documents. - - - - - * - public **Bson** - - | :ref:`getSort ` () - | - - - Gets the sort criteria to apply to the query. - - - - - * - public :ref:`FindOptions ` - - | :ref:`limit ` ( - | **int** limit - | ) - - - Sets the limit to apply. - - - - - * - public :ref:`FindOptions ` - - | :ref:`projection ` ( - | **Bson** projection - | ) - - - Sets a document describing the fields to return for all matching documents. - - - - - * - public :ref:`FindOptions ` - - | :ref:`sort ` ( - | **Bson** sort - | ) - - - Sets the sort criteria to apply to the query. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _FindOptions: - -.. _FindOptions__: - -.. _io_realm_mongodb_mongo_options_FindOptions: - -.. _io_realm_mongodb_mongo_options_FindOptions__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOptions ` () - | - - - - - * - Construct a new instance. - - - - - - - - - - - - - -Method Detail -============= - -.. _getLimit: - -.. _getLimit__: - -.. _FindOptions_getLimit: - -.. _FindOptions_getLimit__: - -.. _io_realm_mongodb_mongo_options_FindOptions_getLimit: - -.. _io_realm_mongodb_mongo_options_FindOptions_getLimit__: - - - -getLimit --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`getLimit ` () - | - - - - - * - Gets the limit to apply. The default is null. - - - - - - - **Returns** - - the limit - - - - - - - - - - - -.. _getProjection: - -.. _getProjection__: - -.. _FindOptions_getProjection: - -.. _FindOptions_getProjection__: - -.. _io_realm_mongodb_mongo_options_FindOptions_getProjection: - -.. _io_realm_mongodb_mongo_options_FindOptions_getProjection__: - - - -getProjection -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **Bson** :ref:`getProjection ` () - | - - - - - * - Gets a document describing the fields to return for all matching documents. - - - - - - - **Returns** - - the project document, which may be null - - - - - - - - - - - -.. _getSort: - -.. _getSort__: - -.. _FindOptions_getSort: - -.. _FindOptions_getSort__: - -.. _io_realm_mongodb_mongo_options_FindOptions_getSort: - -.. _io_realm_mongodb_mongo_options_FindOptions_getSort__: - - - -getSort -------- - -.. list-table:: - :header-rows: 1 - - * - | public **Bson** :ref:`getSort ` () - | - - - - - * - Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order. - - - - - - - **Returns** - - a document describing the sort criteria - - - - - - - - - - - -.. _limit: - -.. _limit__: - -.. _FindOptions_limit: - -.. _FindOptions_limit__: - -.. _io_realm_mongodb_mongo_options_FindOptions_limit: - -.. _io_realm_mongodb_mongo_options_FindOptions_limit__: - - - -limit ------ - -.. _io_realm_mongodb_mongo_options_FindOptions_limit_int_: - -.. _limit_int_: - -.. _FindOptions_limit_int_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOptions ` :ref:`limit ` ( - | **int** limit - | ) - - - - - * - Sets the limit to apply. - - - - - **Parameters** - - - ``limit`` - the limit, which may be null - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _projection: - -.. _projection__: - -.. _FindOptions_projection: - -.. _FindOptions_projection__: - -.. _io_realm_mongodb_mongo_options_FindOptions_projection: - -.. _io_realm_mongodb_mongo_options_FindOptions_projection__: - - - -projection ----------- - -.. _io_realm_mongodb_mongo_options_FindOptions_projection_Bson_: - -.. _projection_Bson_: - -.. _FindOptions_projection_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOptions ` :ref:`projection ` ( - | **Bson** projection - | ) - - - - - * - Sets a document describing the fields to return for all matching documents. - - - - - **Parameters** - - - ``projection`` - the project document, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _sort: - -.. _sort__: - -.. _FindOptions_sort: - -.. _FindOptions_sort__: - -.. _io_realm_mongodb_mongo_options_FindOptions_sort: - -.. _io_realm_mongodb_mongo_options_FindOptions_sort__: - - - -sort ----- - -.. _io_realm_mongodb_mongo_options_FindOptions_sort_Bson_: - -.. _sort_Bson_: - -.. _FindOptions_sort_Bson_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`FindOptions ` :ref:`sort ` ( - | **Bson** sort - | ) - - - - - * - Sets the sort criteria to apply to the query. - - - - - **Parameters** - - - ``sort`` - the sort criteria, which may be null. - - - - - - - - **Returns** - - this - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _FindOptions_toString: - -.. _FindOptions_toString__: - -.. _io_realm_mongodb_mongo_options_FindOptions_toString: - -.. _io_realm_mongodb_mongo_options_FindOptions_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt deleted file mode 100644 index 6e1f915b73..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/InsertManyResult.txt +++ /dev/null @@ -1,177 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class InsertManyResult -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_options_InsertManyResult: - - - -io.realm.mongodb.mongo.options -============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.options.InsertManyResult - - -The result of an insert many operation. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`InsertManyResult ` ( - | `java.util.Map\ `__ insertedIds - | ) - - - Constructs a result. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public `Map `__ - - | :ref:`getInsertedIds ` () - | - - - Returns the _ids of the inserted documents arranged by the index of the document from the operation and its corresponding id. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _InsertManyResult: - -.. _InsertManyResult__: - -.. _io_realm_mongodb_mongo_options_InsertManyResult: - -.. _io_realm_mongodb_mongo_options_InsertManyResult__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`InsertManyResult ` ( - | `java.util.Map\ `__ insertedIds - | ) - - - - - * - Constructs a result. - - - - - **Parameters** - - - ``insertedIds`` - the _ids of the inserted documents arranged by the index of the document from the operation and its corresponding id. - - - - - - - - - - - - - - -Method Detail -============= - -.. _getInsertedIds: - -.. _getInsertedIds__: - -.. _InsertManyResult_getInsertedIds: - -.. _InsertManyResult_getInsertedIds__: - -.. _io_realm_mongodb_mongo_options_InsertManyResult_getInsertedIds: - -.. _io_realm_mongodb_mongo_options_InsertManyResult_getInsertedIds__: - - - -getInsertedIds --------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Map `__ :ref:`getInsertedIds ` () - | - - - - - * - Returns the _ids of the inserted documents arranged by the index of the document from the operation and its corresponding id. - - - - - - - **Returns** - - the _ids of the inserted documents arranged by the index of the document from the operation and its corresponding id. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt b/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt deleted file mode 100644 index f97a564824..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/options/UpdateOptions.txt +++ /dev/null @@ -1,296 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class UpdateOptions -^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_options_UpdateOptions: - - - -io.realm.mongodb.mongo.options -============================== - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.options.UpdateOptions - - -The options to apply when updating documents. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`UpdateOptions ` () - | - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`isUpsert ` () - | - - - Returns true if a new document should be inserted if there are no matches to the query filter. - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - * - public :ref:`UpdateOptions ` - - | :ref:`upsert ` ( - | **boolean** upsert - | ) - - - Set to true if a new document should be inserted if there are no matches to the query filter. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _UpdateOptions: - -.. _UpdateOptions__: - -.. _io_realm_mongodb_mongo_options_UpdateOptions: - -.. _io_realm_mongodb_mongo_options_UpdateOptions__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UpdateOptions ` () - | - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _isUpsert: - -.. _isUpsert__: - -.. _UpdateOptions_isUpsert: - -.. _UpdateOptions_isUpsert__: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_isUpsert: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_isUpsert__: - - - -isUpsert --------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isUpsert ` () - | - - - - - * - Returns true if a new document should be inserted if there are no matches to the query filter. The default is false. - - - - - - - **Returns** - - true if a new document should be inserted if there are no matches to the query filter - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _UpdateOptions_toString: - -.. _UpdateOptions_toString__: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_toString: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - -.. _upsert: - -.. _upsert__: - -.. _UpdateOptions_upsert: - -.. _UpdateOptions_upsert__: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_upsert: - -.. _io_realm_mongodb_mongo_options_UpdateOptions_upsert__: - - - -upsert ------- - -.. _io_realm_mongodb_mongo_options_UpdateOptions_upsert_boolean_: - -.. _upsert_boolean_: - -.. _UpdateOptions_upsert_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UpdateOptions ` :ref:`upsert ` ( - | **boolean** upsert - | ) - - - - - * - Set to true if a new document should be inserted if there are no matches to the query filter. - - - - - **Parameters** - - - ``upsert`` - true if a new document should be inserted if there are no matches to the query filter. - - - - - - - - **Returns** - - this - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result.txt deleted file mode 100644 index 15891ac17e..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result.txt +++ /dev/null @@ -1,34 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.mongo.result -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - DeleteResult - InsertOneResult - UpdateResult - - - -| - -- :ref:`io.realm.mongodb.mongo.result.DeleteResult ` -- :ref:`io.realm.mongodb.mongo.result.InsertOneResult ` -- :ref:`io.realm.mongodb.mongo.result.UpdateResult ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt deleted file mode 100644 index 8191ea8b9b..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/DeleteResult.txt +++ /dev/null @@ -1,177 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class DeleteResult -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_result_DeleteResult: - - - -io.realm.mongodb.mongo.result -============================= - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.result.DeleteResult - - -The result of a delete operation. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`DeleteResult ` ( - | **long** deletedCount - | ) - - - Constructs a result. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **long** - - | :ref:`getDeletedCount ` () - | - - - Gets the number of documents deleted. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _DeleteResult: - -.. _DeleteResult__: - -.. _io_realm_mongodb_mongo_result_DeleteResult: - -.. _io_realm_mongodb_mongo_result_DeleteResult__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`DeleteResult ` ( - | **long** deletedCount - | ) - - - - - * - Constructs a result. - - - - - **Parameters** - - - ``deletedCount`` - the number of documents deleted. - - - - - - - - - - - - - - -Method Detail -============= - -.. _getDeletedCount: - -.. _getDeletedCount__: - -.. _DeleteResult_getDeletedCount: - -.. _DeleteResult_getDeletedCount__: - -.. _io_realm_mongodb_mongo_result_DeleteResult_getDeletedCount: - -.. _io_realm_mongodb_mongo_result_DeleteResult_getDeletedCount__: - - - -getDeletedCount ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getDeletedCount ` () - | - - - - - * - Gets the number of documents deleted. - - - - - - - **Returns** - - the number of documents deleted - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt deleted file mode 100644 index 2d765e13fc..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/InsertOneResult.txt +++ /dev/null @@ -1,177 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class InsertOneResult -^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_result_InsertOneResult: - - - -io.realm.mongodb.mongo.result -============================= - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.result.InsertOneResult - - -The result of an insert one operation. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`InsertOneResult ` ( - | **BsonValue** insertedId - | ) - - - Constructs a result. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **BsonValue** - - | :ref:`getInsertedId ` () - | - - - Returns the _id of the inserted document. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _InsertOneResult: - -.. _InsertOneResult__: - -.. _io_realm_mongodb_mongo_result_InsertOneResult: - -.. _io_realm_mongodb_mongo_result_InsertOneResult__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`InsertOneResult ` ( - | **BsonValue** insertedId - | ) - - - - - * - Constructs a result. - - - - - **Parameters** - - - ``insertedId`` - the _id of the inserted document. - - - - - - - - - - - - - - -Method Detail -============= - -.. _getInsertedId: - -.. _getInsertedId__: - -.. _InsertOneResult_getInsertedId: - -.. _InsertOneResult_getInsertedId__: - -.. _io_realm_mongodb_mongo_result_InsertOneResult_getInsertedId: - -.. _io_realm_mongodb_mongo_result_InsertOneResult_getInsertedId__: - - - -getInsertedId -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonValue** :ref:`getInsertedId ` () - | - - - - - * - Returns the _id of the inserted document. - - - - - - - **Returns** - - the _id of the inserted document. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt b/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt deleted file mode 100644 index b627df595a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/mongo/result/UpdateResult.txt +++ /dev/null @@ -1,303 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class UpdateResult -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_mongo_result_UpdateResult: - - - -io.realm.mongodb.mongo.result -============================= - - - | `java.lang.Object `__ - | io.realm.mongodb.mongo.result.UpdateResult - - -The result of an update operation. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`UpdateResult ` ( - | **long** matchedCount, - | **long** modifiedCount, - | **BsonValue** upsertedId - | ) - - - Constructs a result. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **long** - - | :ref:`getMatchedCount ` () - | - - - Returns the number of documents matched by the query. - - - - - * - public **long** - - | :ref:`getModifiedCount ` () - | - - - Returns the number of documents modified. - - - - - * - public **BsonValue** - - | :ref:`getUpsertedId ` () - | - - - If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _UpdateResult: - -.. _UpdateResult__: - -.. _io_realm_mongodb_mongo_result_UpdateResult: - -.. _io_realm_mongodb_mongo_result_UpdateResult__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`UpdateResult ` ( - | **long** matchedCount, - | **long** modifiedCount, - | **BsonValue** upsertedId - | ) - - - - - * - Constructs a result. - - - - - **Parameters** - - - ``matchedCount`` - the number of documents matched by the query. - - - - - ``modifiedCount`` - the number of documents modified. - - - - - ``upsertedId`` - the _id of the inserted document if the replace resulted in an inserted document, otherwise null. - - - - - - - - - - - - - - -Method Detail -============= - -.. _getMatchedCount: - -.. _getMatchedCount__: - -.. _UpdateResult_getMatchedCount: - -.. _UpdateResult_getMatchedCount__: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getMatchedCount: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getMatchedCount__: - - - -getMatchedCount ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getMatchedCount ` () - | - - - - - * - Returns the number of documents matched by the query. - - - - - - - **Returns** - - the number of documents matched. - - - - - - - - - - - -.. _getModifiedCount: - -.. _getModifiedCount__: - -.. _UpdateResult_getModifiedCount: - -.. _UpdateResult_getModifiedCount__: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getModifiedCount: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getModifiedCount__: - - - -getModifiedCount ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getModifiedCount ` () - | - - - - - * - Returns the number of documents modified. - - - - - - - **Returns** - - the number of documents modified. - - - - - - - - - - - -.. _getUpsertedId: - -.. _getUpsertedId__: - -.. _UpdateResult_getUpsertedId: - -.. _UpdateResult_getUpsertedId__: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getUpsertedId: - -.. _io_realm_mongodb_mongo_result_UpdateResult_getUpsertedId__: - - - -getUpsertedId -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **BsonValue** :ref:`getUpsertedId ` () - | - - - - - * - If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null. - - - - - - - **Returns** - - if the replace resulted in an inserted document, the _id of the inserted document, otherwise null. - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/push.txt b/source/sdk/java/api/io/realm/mongodb/push.txt deleted file mode 100644 index e758b02d69..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/push.txt +++ /dev/null @@ -1,30 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.push -^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - Push - - - -| - -- :ref:`io.realm.mongodb.push.Push ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/push/Push.txt b/source/sdk/java/api/io/realm/mongodb/push/Push.txt deleted file mode 100644 index 94ef5ea831..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/push/Push.txt +++ /dev/null @@ -1,462 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Push -^^^^^^^^^^ - -.. _io_realm_mongodb_push_Push: - - - -io.realm.mongodb.push -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.push.Push - - -The Push client allows to register/deregister for push notifications from a client app. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Push ` ( - | **OsPush** osPush - | ) - - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`deregisterDevice ` () - | - - - Deregisters the FCM registration token bound to the currently logged in user's device on MongoDB Realm. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`deregisterDeviceAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Deregisters the FCM registration token bound to the currently logged in user's device on MongoDB Realm. - - - - - * - public **void** - - | :ref:`registerDevice ` ( - | `String `__ registrationToken - | ) - - - Registers the given FCM registration token with the currently logged in user's device on MongoDB Realm. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`registerDeviceAsync ` ( - | `String `__ registrationToken, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - Registers the given FCM registration token with the currently logged in user's device on MongoDB Realm. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Push: - -.. _Push__: - -.. _io_realm_mongodb_push_Push: - -.. _io_realm_mongodb_push_Push__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Push ` ( - | **OsPush** osPush - | ) - - - - - * - - - - - - - - - - - - - - -Method Detail -============= - -.. _deregisterDevice: - -.. _deregisterDevice__: - -.. _Push_deregisterDevice: - -.. _Push_deregisterDevice__: - -.. _io_realm_mongodb_push_Push_deregisterDevice: - -.. _io_realm_mongodb_push_Push_deregisterDevice__: - - - -deregisterDevice ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`deregisterDevice ` () - | - - - - - * - Deregisters the FCM registration token bound to the currently logged in user's device on MongoDB Realm. - - - - - - - - - - - - - - - -.. _deregisterDeviceAsync: - -.. _deregisterDeviceAsync__: - -.. _Push_deregisterDeviceAsync: - -.. _Push_deregisterDeviceAsync__: - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync: - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync__: - - - -deregisterDeviceAsync ---------------------- - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync_Callback_: - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync_App_Callback_: - -.. _deregisterDeviceAsync_io_realm_mongodb_App_Callback_: - -.. _deregisterDeviceAsync_Callback_: - -.. _deregisterDeviceAsync_App_Callback_: - -.. _Push_deregisterDeviceAsync_io_realm_mongodb_App_Callback_: - -.. _Push_deregisterDeviceAsync_Callback_: - -.. _Push_deregisterDeviceAsync_App_Callback_: - -.. _io_realm_mongodb_push_Push_deregisterDeviceAsync_App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`deregisterDeviceAsync ` ( - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Deregisters the FCM registration token bound to the currently logged in user's device on MongoDB Realm. - - - - - **Parameters** - - - ``callback`` - The callback used when the device has been registered or the call failed - it will always happen on the same thread as this method was called on. - - - - - - - - - - - - - - - - -.. _registerDevice: - -.. _registerDevice__: - -.. _Push_registerDevice: - -.. _Push_registerDevice__: - -.. _io_realm_mongodb_push_Push_registerDevice: - -.. _io_realm_mongodb_push_Push_registerDevice__: - - - -registerDevice --------------- - -.. _io_realm_mongodb_push_Push_registerDevice_java_lang_String_: - -.. _io_realm_mongodb_push_Push_registerDevice_String_: - -.. _registerDevice_java_lang_String_: - -.. _registerDevice_String_: - -.. _Push_registerDevice_java_lang_String_: - -.. _Push_registerDevice_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`registerDevice ` ( - | `String `__ registrationToken - | ) - - - - - * - Registers the given FCM registration token with the currently logged in user's device on MongoDB Realm. - - - - - **Parameters** - - - ``registrationToken`` - The registration token to register. - - - - - - - - - - - - - - - - -.. _registerDeviceAsync: - -.. _registerDeviceAsync__: - -.. _Push_registerDeviceAsync: - -.. _Push_registerDeviceAsync__: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync__: - - - -registerDeviceAsync -------------------- - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String__Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_java_lang_String__App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String_io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String__io_realm_mongodb_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String__Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String_App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String__App_Callback_: - -.. _registerDeviceAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _registerDeviceAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _registerDeviceAsync_java_lang_String_Callback_: - -.. _registerDeviceAsync_java_lang_String__Callback_: - -.. _registerDeviceAsync_java_lang_String_App_Callback_: - -.. _registerDeviceAsync_java_lang_String__App_Callback_: - -.. _registerDeviceAsync_String_io_realm_mongodb_App_Callback_: - -.. _registerDeviceAsync_String__io_realm_mongodb_App_Callback_: - -.. _registerDeviceAsync_String_Callback_: - -.. _registerDeviceAsync_String__Callback_: - -.. _registerDeviceAsync_String_App_Callback_: - -.. _registerDeviceAsync_String__App_Callback_: - -.. _Push_registerDeviceAsync_java_lang_String_io_realm_mongodb_App_Callback_: - -.. _Push_registerDeviceAsync_java_lang_String__io_realm_mongodb_App_Callback_: - -.. _Push_registerDeviceAsync_java_lang_String_Callback_: - -.. _Push_registerDeviceAsync_java_lang_String__Callback_: - -.. _Push_registerDeviceAsync_java_lang_String_App_Callback_: - -.. _Push_registerDeviceAsync_java_lang_String__App_Callback_: - -.. _Push_registerDeviceAsync_String_io_realm_mongodb_App_Callback_: - -.. _Push_registerDeviceAsync_String__io_realm_mongodb_App_Callback_: - -.. _Push_registerDeviceAsync_String_Callback_: - -.. _Push_registerDeviceAsync_String__Callback_: - -.. _Push_registerDeviceAsync_String_App_Callback_: - -.. _Push_registerDeviceAsync_String__App_Callback_: - -.. _io_realm_mongodb_push_Push_registerDeviceAsync_String__App_Callback_Void__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`registerDeviceAsync ` ( - | `String `__ registrationToken, - | :ref:`io.realm.mongodb.App.Callback\ ` callback - | ) - - - - - * - Registers the given FCM registration token with the currently logged in user's device on MongoDB Realm. - - - - - **Parameters** - - - ``registrationToken`` - The registration token to register. - - - - - ``callback`` - The callback used when the device has been registered or the call failed - it will always happen on the same thread as this method was called on. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync.txt b/source/sdk/java/api/io/realm/mongodb/sync.txt deleted file mode 100644 index 76203d5152..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync.txt +++ /dev/null @@ -1,78 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.mongodb.sync -^^^^^^^^^^^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - ConnectionListener - ConnectionState - DiscardUnsyncedChangesStrategy - ManuallyRecoverUnsyncedChangesStrategy - MutableSubscriptionSet - Progress - ProgressListener - ProgressMode - Subscription - SubscriptionSet - SubscriptionSet.State - SubscriptionSet.StateChangeCallback - SubscriptionSet.UpdateAsyncCallback - SubscriptionSet.UpdateCallback - Sync - Sync.Debug - SyncClientResetStrategy - SyncConfiguration - SyncConfiguration.Builder - SyncConfiguration.InitialFlexibleSyncSubscriptions - SyncSession - SyncSession.ClientResetHandler - SyncSession.ErrorHandler - SyncSession.State - ClientResetRequiredError - - - -| - -- :ref:`io.realm.mongodb.sync.ConnectionListener ` -- :ref:`io.realm.mongodb.sync.ConnectionState ` -- :ref:`io.realm.mongodb.sync.DiscardUnsyncedChangesStrategy ` -- :ref:`io.realm.mongodb.sync.ManuallyRecoverUnsyncedChangesStrategy ` -- :ref:`io.realm.mongodb.sync.MutableSubscriptionSet ` -- :ref:`io.realm.mongodb.sync.Progress ` -- :ref:`io.realm.mongodb.sync.ProgressListener ` -- :ref:`io.realm.mongodb.sync.ProgressMode ` -- :ref:`io.realm.mongodb.sync.Subscription ` -- :ref:`io.realm.mongodb.sync.SubscriptionSet ` -- :ref:`io.realm.mongodb.sync.SubscriptionSet.State ` -- :ref:`io.realm.mongodb.sync.SubscriptionSet.StateChangeCallback ` -- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateAsyncCallback ` -- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateCallback ` -- :ref:`io.realm.mongodb.sync.Sync ` -- :ref:`io.realm.mongodb.sync.Sync.Debug ` -- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` -- :ref:`io.realm.mongodb.sync.SyncConfiguration ` -- :ref:`io.realm.mongodb.sync.SyncConfiguration.Builder ` -- :ref:`io.realm.mongodb.sync.SyncConfiguration.InitialFlexibleSyncSubscriptions ` -- :ref:`io.realm.mongodb.sync.SyncSession ` -- :ref:`io.realm.mongodb.sync.SyncSession.ClientResetHandler ` -- :ref:`io.realm.mongodb.sync.SyncSession.ErrorHandler ` -- :ref:`io.realm.mongodb.sync.SyncSession.State ` -- :ref:`io.realm.mongodb.sync.ClientResetRequiredError ` - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt b/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt deleted file mode 100644 index 0fbae5dc2f..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ClientResetRequiredError.txt +++ /dev/null @@ -1,319 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Exception ClientResetRequiredError -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ClientResetRequiredError: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | `java.lang.Throwable `__ - | `java.lang.Exception `__ - | `java.lang.RuntimeException `__ - | :ref:`io.realm.mongodb.AppException ` - | io.realm.mongodb.sync.ClientResetRequiredError - - -Class encapsulating information needed for handling a Client Reset event. - - -.. seealso:: - - - - - :ref:`SyncSession.ErrorHandler.onError(SyncSession, AppException) for more information about when and why Client Reset occurs and how to deal with it. ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`executeClientReset ` () - | - - - Calling this method will execute the Client Reset manually instead of waiting until next app restart. - - - - - * - public `File `__ - - | :ref:`getBackupFile ` () - | - - - Returns the location of the backed up Realm file. - - - - - * - public :ref:`RealmConfiguration ` - - | :ref:`getBackupRealmConfiguration ` () - | - - - The configuration that can be used to open the backup Realm offline. - - - - - * - public `File `__ - - | :ref:`getOriginalFile ` () - | - - - Returns the location of the original Realm file. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Throwable `__ : ``getMessage`` , ``getLocalizedMessage`` , ``getCause`` , ``initCause`` , ``toString`` , ``printStackTrace`` , ``printStackTrace`` , ``printStackTrace`` , ``fillInStackTrace`` , ``getStackTrace`` , ``setStackTrace`` , ``addSuppressed`` , ``getSuppressed`` -- Methods inherited from class :ref:`io.realm.mongodb.AppException ` : ``getErrorCode`` , ``getErrorType`` , ``getErrorIntValue`` , ``getErrorMessage`` , ``getException`` , ``getCategory`` , ``toString`` - - - - -Method Detail -============= - -.. _executeClientReset: - -.. _executeClientReset__: - -.. _ClientResetRequiredError_executeClientReset: - -.. _ClientResetRequiredError_executeClientReset__: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_executeClientReset: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_executeClientReset__: - - - -executeClientReset ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`executeClientReset ` () - | - - - - - * - Calling this method will execute the Client Reset manually instead of waiting until next app restart. This will only be possible if all instances of that Realm have been closed, otherwise a `IllegalStateException `__ will be thrown. - - After this method returns, the backup file can be found in the location returned by :ref:`getBackupFile() ` . The file at :ref:`getOriginalFile() ` have been deleted, but will be recreated from scratch next time a Realm instance is opened. - - - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if not all instances have been closed. - - - - - - - - - - - - -.. _getBackupFile: - -.. _getBackupFile__: - -.. _ClientResetRequiredError_getBackupFile: - -.. _ClientResetRequiredError_getBackupFile__: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getBackupFile: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getBackupFile__: - - - -getBackupFile -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `File `__ :ref:`getBackupFile ` () - | - - - - - * - Returns the location of the backed up Realm file. The file will not be present until the Client Reset has been fully executed. - - - - - - - **Returns** - - a reference to the location of the backup file once Client Reset has been executed. Use ``file.exists()`` to check if the file exists or not. - - - - - - - - - - - - - -.. _getBackupRealmConfiguration: - -.. _getBackupRealmConfiguration__: - -.. _ClientResetRequiredError_getBackupRealmConfiguration: - -.. _ClientResetRequiredError_getBackupRealmConfiguration__: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getBackupRealmConfiguration: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getBackupRealmConfiguration__: - - - -getBackupRealmConfiguration ---------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmConfiguration ` :ref:`getBackupRealmConfiguration ` () - | - - - - - * - The configuration that can be used to open the backup Realm offline. This configuration can only be used in combination with a :ref:`DynamicRealm ` . - - - - - - - - - **Returns** - - the configuration that can be used to open the backup Realm offline. - - - - - - - - - - - -.. _getOriginalFile: - -.. _getOriginalFile__: - -.. _ClientResetRequiredError_getOriginalFile: - -.. _ClientResetRequiredError_getOriginalFile__: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getOriginalFile: - -.. _io_realm_mongodb_sync_ClientResetRequiredError_getOriginalFile__: - - - -getOriginalFile ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public `File `__ :ref:`getOriginalFile ` () - | - - - - - * - Returns the location of the original Realm file. After the Client Reset has completed, the file at this location will be deleted. - - - - - - - **Returns** - - a reference to the location of the original Realm file. After Client Reset has been executed this file will no longer exists. Use ``file.exists()`` to check this. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionListener.txt b/source/sdk/java/api/io/realm/mongodb/sync/ConnectionListener.txt deleted file mode 100644 index da166fb7a4..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionListener.txt +++ /dev/null @@ -1,181 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface ConnectionListener -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ConnectionListener: - - - -io.realm.mongodb.sync -===================== - -Interface used when reporting changes that happened to the connection used by the session.Multiple sessions might re-use the same connection. In that case, any connection change will be reported to all sessions. - -If a disconnect happened due to an error, that error will be reported to the sessions :ref:`SyncSession.ErrorHandler ` . - - - - - - -.. seealso:: - - - - - :ref:`SyncSession.isConnected() ` - - - - - :ref:`SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | :ref:`ConnectionState ` oldState, - | :ref:`ConnectionState ` newState - | ) - - - A change in the connection to the server was detected. - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _ConnectionListener_onChange: - -.. _ConnectionListener_onChange__: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange__: - - - -onChange --------- - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState__ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_ConnectionState_ConnectionState_: - -.. _io_realm_mongodb_sync_ConnectionListener_onChange_ConnectionState__ConnectionState_: - -.. _onChange_io_realm_mongodb_sync_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _onChange_io_realm_mongodb_sync_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _onChange_io_realm_mongodb_sync_ConnectionState_ConnectionState_: - -.. _onChange_io_realm_mongodb_sync_ConnectionState__ConnectionState_: - -.. _onChange_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _onChange_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _onChange_ConnectionState_ConnectionState_: - -.. _onChange_ConnectionState__ConnectionState_: - -.. _ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState_ConnectionState_: - -.. _ConnectionListener_onChange_io_realm_mongodb_sync_ConnectionState__ConnectionState_: - -.. _ConnectionListener_onChange_ConnectionState_io_realm_mongodb_sync_ConnectionState_: - -.. _ConnectionListener_onChange_ConnectionState__io_realm_mongodb_sync_ConnectionState_: - -.. _ConnectionListener_onChange_ConnectionState_ConnectionState_: - -.. _ConnectionListener_onChange_ConnectionState__ConnectionState_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | :ref:`ConnectionState ` oldState, - | :ref:`ConnectionState ` newState - | ) - - - - - * - A change in the connection to the server was detected. - - - - - **Parameters** - - - ``oldState`` - the state the connection transitioned from. - - - - - ``newState`` - the state the connection transitioned to. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt b/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt deleted file mode 100644 index 241531f0ec..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ConnectionState.txt +++ /dev/null @@ -1,266 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum ConnectionState -^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ConnectionState: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.sync.ConnectionState - - -Enum describing the states of the underlying connection used by a :ref:`SyncSession ` . - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`CONNECTED ` - - A connection was successfully established to the server. - - - - - * - :ref:`CONNECTING ` - - A connection is currently in progress of being established. - - - - - * - :ref:`DISCONNECTED ` - - No connection to the server exists. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`ConnectionState ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`ConnectionState ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_sync_ConnectionState_CONNECTED: - -.. _ConnectionState_CONNECTED: - - - -``CONNECTED`` --------------- - -public static final :ref:`ConnectionState ` - -A connection was successfully established to the server. If the SyncSession is :ref:`SyncSession.State.ACTIVE ` data will now be transferred between the device and the server. - - - - - -.. _io_realm_mongodb_sync_ConnectionState_CONNECTING: - -.. _ConnectionState_CONNECTING: - - - -``CONNECTING`` ---------------- - -public static final :ref:`ConnectionState ` - -A connection is currently in progress of being established. If successful the next state is :ref:`CONNECTED ` . If the connection fails it will be :ref:`DISCONNECTED ` . - - - - - -.. _io_realm_mongodb_sync_ConnectionState_DISCONNECTED: - -.. _ConnectionState_DISCONNECTED: - - - -``DISCONNECTED`` ------------------ - -public static final :ref:`ConnectionState ` - -No connection to the server exists. No data is being transferred even if the session is :ref:`SyncSession.State.ACTIVE ` . If the connection entered this state due to an error, this error will be reported to the :ref:`SyncSession.ErrorHandler ` . - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _ConnectionState_valueOf: - -.. _ConnectionState_valueOf__: - -.. _io_realm_mongodb_sync_ConnectionState_valueOf: - -.. _io_realm_mongodb_sync_ConnectionState_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_sync_ConnectionState_valueOf_java_lang_String_: - -.. _io_realm_mongodb_sync_ConnectionState_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _ConnectionState_valueOf_java_lang_String_: - -.. _ConnectionState_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ConnectionState ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _ConnectionState_values: - -.. _ConnectionState_values__: - -.. _io_realm_mongodb_sync_ConnectionState_values: - -.. _io_realm_mongodb_sync_ConnectionState_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ConnectionState ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt deleted file mode 100644 index 611cb85aaf..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/DiscardUnsyncedChangesStrategy.txt +++ /dev/null @@ -1,383 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface DiscardUnsyncedChangesStrategy -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` - - -Strategy that automatically resolves a Client Reset by discarding any unsynced data, but otherwise keep the Realm open. Any changes will be reported through the normal collection and object notifications.A synced Realm may need to be reset because the MongoDB Realm Server encountered an error and had to be restored from a backup or because it has been too long since the client connected to the server so the server has rotated the logs. - -The Client Reset thus occurs because the server does not have the full information required to bring the Client fully up to date. - -The discard unsynced changes reset process is as follows: when a client reset is triggered the :ref:`onBeforeReset(Realm) ` callback is invoked, providing an instance of the Realm before the reset and another after the reset, both read-only. Once the reset has concluded the callback :ref:`onAfterReset(Realm, Realm) ` would be invoked with an instance of the final Realm. - - - -In the event that discarding the unsynced data is not enough to resolve the reset the :ref:`onError(SyncSession, ClientResetRequiredError) ` would be invoked, it allows to manually resolve the reset as it would be done in :ref:`ManuallyRecoverUnsyncedChangesStrategy.onClientReset(SyncSession, ClientResetRequiredError) ` . - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onAfterReset ` ( - | :ref:`Realm ` before, - | :ref:`Realm ` after - | ) - - - Callback invoked once the Client Reset happens. - - - - - * - public **void** - - | :ref:`onBeforeReset ` ( - | :ref:`Realm ` realm - | ) - - - Callback that indicates a Client Reset is about to happen. - - - - - * - public **void** - - | :ref:`onError ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - Callback that indicates the seamless Client reset couldn't complete. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _onAfterReset: - -.. _onAfterReset__: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset__: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset__: - - - -onAfterReset ------------- - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_io_realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__io_realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm_io_realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm__io_realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onAfterReset_Realm__Realm_: - -.. _onAfterReset_io_realm_Realm_io_realm_Realm_: - -.. _onAfterReset_io_realm_Realm__io_realm_Realm_: - -.. _onAfterReset_io_realm_Realm_Realm_: - -.. _onAfterReset_io_realm_Realm__Realm_: - -.. _onAfterReset_Realm_io_realm_Realm_: - -.. _onAfterReset_Realm__io_realm_Realm_: - -.. _onAfterReset_Realm_Realm_: - -.. _onAfterReset_Realm__Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_io_realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__io_realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_io_realm_Realm__Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm_io_realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm__io_realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onAfterReset_Realm__Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onAfterReset ` ( - | :ref:`Realm ` before, - | :ref:`Realm ` after - | ) - - - - - * - Callback invoked once the Client Reset happens. It provides of two Realm instances, a frozen one displaying the state before the reset and a regular Realm with the current state, that can be used to recover objects from the reset. - - - - - **Parameters** - - - ``before`` - :ref:`Realm ` frozen Realm in the before after the reset. - - - - - - - ``after`` - :ref:`Realm ` Realm after the reset. - - - - - - - - - - - - - - - - - - -.. _onBeforeReset: - -.. _onBeforeReset__: - -.. _DiscardUnsyncedChangesStrategy_onBeforeReset: - -.. _DiscardUnsyncedChangesStrategy_onBeforeReset__: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset__: - - - -onBeforeReset -------------- - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset_io_realm_Realm_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onBeforeReset_Realm_: - -.. _onBeforeReset_io_realm_Realm_: - -.. _onBeforeReset_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onBeforeReset_io_realm_Realm_: - -.. _DiscardUnsyncedChangesStrategy_onBeforeReset_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onBeforeReset ` ( - | :ref:`Realm ` realm - | ) - - - - - * - Callback that indicates a Client Reset is about to happen. It provides with a frozen instance of the Realm that is will be reset. - - - - - **Parameters** - - - ``realm`` - frozen :ref:`Realm ` in its state before the reset. - - - - - - - - - - - - - - - - - - -.. _onError: - -.. _onError__: - -.. _DiscardUnsyncedChangesStrategy_onError: - -.. _DiscardUnsyncedChangesStrategy_onError__: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError__: - - - -onError -------- - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_onError_SyncSession__ClientResetRequiredError_: - -.. _onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onError_SyncSession_ClientResetRequiredError_: - -.. _onError_SyncSession__ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_SyncSession_ClientResetRequiredError_: - -.. _DiscardUnsyncedChangesStrategy_onError_SyncSession__ClientResetRequiredError_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - - - * - Callback that indicates the seamless Client reset couldn't complete. It should be handled as :ref:`ManuallyRecoverUnsyncedChangesStrategy.onClientReset(SyncSession, ClientResetRequiredError) ` . - - - - - - - **Parameters** - - - ``session`` - :ref:`SyncSession ` this error happened on. - - - - - - - ``error`` - :ref:`ClientResetRequiredError ` the specific Client Reset error. - - - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt deleted file mode 100644 index a70c14d6b8..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ManuallyRecoverUnsyncedChangesStrategy.txt +++ /dev/null @@ -1,197 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface ManuallyRecoverUnsyncedChangesStrategy -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` - - -Strategy to manually resolve a Client Reset, determined by the error code :ref:`ErrorCode.CLIENT_RESET ` . - -A synced Realm may need to be reset because the MongoDB Realm Server encountered an error and had to be restored from a backup or because it has been too long since the client connected to the server so the server has rotated the logs. - -The Client Reset thus occurs because the server does not have the full information required to bring the Client fully up to date. - -The manual reset process is as follows: the local copy of the Realm is copied into a recovery directory for safekeeping, and then deleted from the original location. The next time the Realm for that URL is opened, the Realm will automatically be re-downloaded from MongoDB Realm, and can be used as normal. - -Data written to the Realm after the local copy of the Realm diverged from the backup remote copy will be present in the local recovery copy of the Realm file. The re-downloaded Realm will initially contain only the data present at the time the Realm was backed up on the server. - -The client reset process can be initiated in one of two ways: - - - -1. Run :ref:`ClientResetRequiredError.executeClientReset() ` manually. All Realm instances must be closed before this method is called. - - - - -#. If Client Reset isn't executed manually, it will automatically be carried out the next time all Realm instances have been closed and re-opened. This will most likely be when the app is restarted. - - - - -**WARNING:** Any writes to the Realm file between this callback and Client Reset has been executed, will not be synchronized to MongoDB Realm. Those changes will only be present in the backed up file. It is therefore recommended to close all open Realm instances as soon as possible. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onClientReset ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - Callback that indicates a Client Reset has happened. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _onClientReset: - -.. _onClientReset__: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset__: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset__: - - - -onClientReset -------------- - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_ClientResetRequiredError_: - -.. _io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _onClientReset_SyncSession_ClientResetRequiredError_: - -.. _onClientReset_SyncSession__ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_io_realm_mongodb_sync_SyncSession__ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__io_realm_mongodb_sync_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession_ClientResetRequiredError_: - -.. _ManuallyRecoverUnsyncedChangesStrategy_onClientReset_SyncSession__ClientResetRequiredError_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onClientReset ` ( - | :ref:`SyncSession ` session, - | :ref:`ClientResetRequiredError ` error - | ) - - - - - * - Callback that indicates a Client Reset has happened. This should be handled as quickly as possible as any further changes to the Realm will not be synchronized with the server and must be moved manually from the backup Realm to the new one. - - - - - **Parameters** - - - ``session`` - :ref:`SyncSession ` this error happened on. - - - - - - - ``error`` - :ref:`ClientResetRequiredError ` the specific Client Reset error. - - - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt b/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt deleted file mode 100644 index c941774a77..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/MutableSubscriptionSet.txt +++ /dev/null @@ -1,580 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface MutableSubscriptionSet -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_MutableSubscriptionSet: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- :ref:`io.realm.mongodb.sync.SubscriptionSet ` -- `java.lang.Iterable `__ - - -A mutable subscription set is available when calling :ref:`SubscriptionSet.update(UpdateCallback) ` This is the only way to modify a :ref:`SubscriptionSet ` . :ref:`Subscription ` s can be either - -*managed* or *unmanaged*. Unmanaged subscriptions are those created by using :ref:`Subscription.create(RealmQuery) ` or :ref:`Subscription.create(String, RealmQuery) ` , while managed subscriptions are the ones being returned from the subscription set. - - - - -.. seealso:: - - - - - :ref:`SubscriptionSet for more information about subscription sets and flexible sync. ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`Subscription ` - - | :ref:`add ` ( - | :ref:`Subscription ` subscription - | ) - - - Adds a new unmanaged subscription to the subscription set. - - - - - * - public :ref:`Subscription ` - - | :ref:`addOrUpdate ` ( - | :ref:`Subscription ` subscription - | ) - - - Add a new subscription or update an existing named subscription. - - - - - * - public **boolean** - - | :ref:`remove ` ( - | `String `__ name - | ) - - - Remove a named subscription. - - - - - * - public **boolean** - - | :ref:`remove ` ( - | :ref:`Subscription ` subscription - | ) - - - Remove a managed subscription. - - - - - * - public **boolean** - - | :ref:`removeAll ` () - | - - - Remove all current managed subscriptions. - - - - - * - public **boolean** - - | :ref:`removeAll ` <**T** >( - | `java.lang.Class\ `__ clazz - | ) - - - Remove all subscriptions with queries on a given given model class. - - - - - * - public **boolean** - - | :ref:`removeAll ` ( - | `String `__ objectType - | ) - - - Remove all subscriptions on a given :ref:`Subscription.getObjectType() ` . - - - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _add: - -.. _add__: - -.. _MutableSubscriptionSet_add: - -.. _MutableSubscriptionSet_add__: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_add: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_add__: - - - -add ----- - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_add_io_realm_mongodb_sync_Subscription_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_add_Subscription_: - -.. _add_io_realm_mongodb_sync_Subscription_: - -.. _add_Subscription_: - -.. _MutableSubscriptionSet_add_io_realm_mongodb_sync_Subscription_: - -.. _MutableSubscriptionSet_add_Subscription_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Subscription ` :ref:`add ` ( - | :ref:`Subscription ` subscription - | ) - - - - - * - Adds a new unmanaged subscription to the subscription set. - - - - - **Parameters** - - - ``subscription`` - unmanaged subscription to add. - - - - - - - - **Returns** - - the newly added managed subscription. - - - - - **Throws** - - - `IllegalArgumentException `__ - if a subscription matching the provided one already exists. - - - - - - - - - - - - -.. _addOrUpdate: - -.. _addOrUpdate__: - -.. _MutableSubscriptionSet_addOrUpdate: - -.. _MutableSubscriptionSet_addOrUpdate__: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate__: - - - -addOrUpdate ------------ - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate_io_realm_mongodb_sync_Subscription_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_addOrUpdate_Subscription_: - -.. _addOrUpdate_io_realm_mongodb_sync_Subscription_: - -.. _addOrUpdate_Subscription_: - -.. _MutableSubscriptionSet_addOrUpdate_io_realm_mongodb_sync_Subscription_: - -.. _MutableSubscriptionSet_addOrUpdate_Subscription_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Subscription ` :ref:`addOrUpdate ` ( - | :ref:`Subscription ` subscription - | ) - - - - - * - Add a new subscription or update an existing named subscription. It isn't possible to update an anonymous subscription. These must removed and re-inserted. - - - - - **Parameters** - - - ``subscription`` - anonymous or named subscription created via ``Subscription.create(...)`` , used to update a matching one within a specific set. It creates a new one in case there is no match.. - - - - - - - - - - **Returns** - - the updated or inserted managed subscription. - - - - - - - - - - - -.. _remove: - -.. _remove__: - -.. _MutableSubscriptionSet_remove: - -.. _MutableSubscriptionSet_remove__: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove__: - - - -remove ------- - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_java_lang_String_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_String_: - -.. _remove_java_lang_String_: - -.. _remove_String_: - -.. _MutableSubscriptionSet_remove_java_lang_String_: - -.. _MutableSubscriptionSet_remove_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`remove ` ( - | `String `__ name - | ) - - - - - * - Remove a named subscription. - - - - - **Parameters** - - - ``name`` - name of managed subscription to remove. - - - - - - - - **Returns** - - ``true`` if the subscription was removed, ``false`` if not. - - - - - - - - - - - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_io_realm_mongodb_sync_Subscription_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_remove_Subscription_: - -.. _remove_io_realm_mongodb_sync_Subscription_: - -.. _remove_Subscription_: - -.. _MutableSubscriptionSet_remove_io_realm_mongodb_sync_Subscription_: - -.. _MutableSubscriptionSet_remove_Subscription_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`remove ` ( - | :ref:`Subscription ` subscription - | ) - - - - - * - Remove a managed subscription. - - - - - **Parameters** - - - ``subscription`` - managed subscription to remove - - - - - - - - **Returns** - - ``true`` if the subscription was removed, ``false`` if not. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the subscription provided is unmanaged. Only managed subscriptions can be used as input. - - - - - - - - - - - - -.. _removeAll: - -.. _removeAll__: - -.. _MutableSubscriptionSet_removeAll: - -.. _MutableSubscriptionSet_removeAll__: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll__: - - - -removeAll ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`removeAll ` () - | - - - - - * - Remove all current managed subscriptions. - - - - - - - **Returns** - - ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. - - - - - - - - - - - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_java_lang_Class_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_Class_: - -.. _removeAll_java_lang_Class_: - -.. _removeAll_Class_: - -.. _MutableSubscriptionSet_removeAll_java_lang_Class_: - -.. _MutableSubscriptionSet_removeAll_Class_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_Class_T__: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`removeAll ` <**T** >( - | `java.lang.Class\ `__ clazz - | ) - - - - - * - Remove all subscriptions with queries on a given given model class. - - - - - **Parameters** - - - ``clazz`` - subscriptions on this type will be removed. - - - - - - - - **Returns** - - ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. - - - - - - - - - - - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_java_lang_String_: - -.. _io_realm_mongodb_sync_MutableSubscriptionSet_removeAll_String_: - -.. _removeAll_java_lang_String_: - -.. _removeAll_String_: - -.. _MutableSubscriptionSet_removeAll_java_lang_String_: - -.. _MutableSubscriptionSet_removeAll_String_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`removeAll ` ( - | `String `__ objectType - | ) - - - - - * - Remove all subscriptions on a given :ref:`Subscription.getObjectType() ` . - - - - - - - **Parameters** - - - ``objectType`` - subscriptions on this object type will be removed. - - - - - - - - **Returns** - - ``true`` if 1 or more subscriptions were removed, ``false`` if no subscriptions were removed. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt b/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt deleted file mode 100644 index 788696011c..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/Progress.txt +++ /dev/null @@ -1,524 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Progress -^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_Progress: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.sync.Progress - - -Class used to encapsulate progress notifications when either downloading or uploading Realm data. Each instance of this class is an immutable snapshot of the current progress.If the :ref:`ProgressListener ` was registered with :ref:`ProgressMode.INDEFINITELY ` , the progress reported by :ref:`getFractionTransferred() ` can both increase and decrease since more changes might be added while the progres listener is registered. This means it is possible for one notification to report ``true`` for :ref:`isTransferComplete() ` , and then on the next event report ``false`` . - - - -If the :ref:`ProgressListener ` was registered with :ref:`ProgressMode.CURRENT_CHANGES ` , progress can only ever increase, and once :ref:`isTransferComplete() ` returns ``true`` , no further events will be generated. - - - - - - -.. seealso:: - - - - - :ref:`SyncSession.addDownloadProgressListener(ProgressMode, ProgressListener) ` - - - - - :ref:`SyncSession.addUploadProgressListener(ProgressMode, ProgressListener) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public **double** - - | :ref:`getFractionTransferred ` () - | - - - The fraction of bytes transferred out of all transferable bytes. - - - - - * - public **long** - - | :ref:`getTransferableBytes ` () - | - - - Returns the total number of transferable bytes (bytes that have been transferred + bytes pending transfer). - - - - - * - public **long** - - | :ref:`getTransferredBytes ` () - | - - - Returns the total number of bytes that has been transferred since the :ref:`ProgressListener ` was added. - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isTransferComplete ` () - | - - - Returns ``true`` when all pending bytes have been transferred. - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _Progress_equals: - -.. _Progress_equals__: - -.. _io_realm_mongodb_sync_Progress_equals: - -.. _io_realm_mongodb_sync_Progress_equals__: - - - -equals ------- - -.. _io_realm_mongodb_sync_Progress_equals_java_lang_Object_: - -.. _io_realm_mongodb_sync_Progress_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _Progress_equals_java_lang_Object_: - -.. _Progress_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getFractionTransferred: - -.. _getFractionTransferred__: - -.. _Progress_getFractionTransferred: - -.. _Progress_getFractionTransferred__: - -.. _io_realm_mongodb_sync_Progress_getFractionTransferred: - -.. _io_realm_mongodb_sync_Progress_getFractionTransferred__: - - - -getFractionTransferred ----------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **double** :ref:`getFractionTransferred ` () - | - - - - - * - The fraction of bytes transferred out of all transferable bytes. Counting from since the :ref:`ProgressListener ` was added. - - - - - - - - - **Returns** - - a number between ``0.0`` and ``1.0`` , where ``0.0`` represents that no data has been transferred yet, and ``1.0`` that all data has been transferred. - - - - - - - - - - - - - -.. _getTransferableBytes: - -.. _getTransferableBytes__: - -.. _Progress_getTransferableBytes: - -.. _Progress_getTransferableBytes__: - -.. _io_realm_mongodb_sync_Progress_getTransferableBytes: - -.. _io_realm_mongodb_sync_Progress_getTransferableBytes__: - - - -getTransferableBytes --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getTransferableBytes ` () - | - - - - - * - Returns the total number of transferable bytes (bytes that have been transferred + bytes pending transfer).If the :ref:`ProgressListener ` is tracking downloads, this number represents the size of the changesets generated by all other clients using the Realm. - - - - If the :ref:`ProgressListener ` is tracking uploads, this number represents the size of changesets created locally. - - - - - - - - - - - **Returns** - - the total number of bytes that has been transferred + number of bytes still pending transfer. - - - - - - - - - - - -.. _getTransferredBytes: - -.. _getTransferredBytes__: - -.. _Progress_getTransferredBytes: - -.. _Progress_getTransferredBytes__: - -.. _io_realm_mongodb_sync_Progress_getTransferredBytes: - -.. _io_realm_mongodb_sync_Progress_getTransferredBytes__: - - - -getTransferredBytes -------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getTransferredBytes ` () - | - - - - - * - Returns the total number of bytes that has been transferred since the :ref:`ProgressListener ` was added. - - - - - - - - - **Returns** - - the total number of bytes transferred since the :ref:`ProgressListener ` was added. - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _Progress_hashCode: - -.. _Progress_hashCode__: - -.. _io_realm_mongodb_sync_Progress_hashCode: - -.. _io_realm_mongodb_sync_Progress_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _isTransferComplete: - -.. _isTransferComplete__: - -.. _Progress_isTransferComplete: - -.. _Progress_isTransferComplete__: - -.. _io_realm_mongodb_sync_Progress_isTransferComplete: - -.. _io_realm_mongodb_sync_Progress_isTransferComplete__: - - - -isTransferComplete ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isTransferComplete ` () - | - - - - - * - Returns ``true`` when all pending bytes have been transferred. - - If the :ref:`ProgressListener ` was registered with :ref:`ProgressMode.INDEFINITELY ` , this method can return ``false`` for subsequent events after returning ``true`` . - - - - If the :ref:`ProgressListener ` was registered with :ref:`ProgressMode.CURRENT_CHANGES ` , when this method returns ``true`` , no more progress events will be sent. - - - - - - - - - - - **Returns** - - ``true`` if all changes have been transferred, ``false`` otherwise. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _Progress_toString: - -.. _Progress_toString__: - -.. _io_realm_mongodb_sync_Progress_toString: - -.. _io_realm_mongodb_sync_Progress_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ProgressListener.txt b/source/sdk/java/api/io/realm/mongodb/sync/ProgressListener.txt deleted file mode 100644 index c73eecd782..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ProgressListener.txt +++ /dev/null @@ -1,145 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface ProgressListener -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ProgressListener: - - - -io.realm.mongodb.sync -===================== - -Interface used when interested in updates on data either being uploaded to or downloaded from a Realm Object Server. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onChange ` ( - | :ref:`Progress ` progress - | ) - - - This method will be called periodically from the underlying Object Server Client responsible for uploading and downloading changes from the remote Object Server. - - - - - - - -Method Detail -============= - -.. _onChange: - -.. _onChange__: - -.. _ProgressListener_onChange: - -.. _ProgressListener_onChange__: - -.. _io_realm_mongodb_sync_ProgressListener_onChange: - -.. _io_realm_mongodb_sync_ProgressListener_onChange__: - - - -onChange --------- - -.. _io_realm_mongodb_sync_ProgressListener_onChange_io_realm_mongodb_sync_Progress_: - -.. _io_realm_mongodb_sync_ProgressListener_onChange_Progress_: - -.. _onChange_io_realm_mongodb_sync_Progress_: - -.. _onChange_Progress_: - -.. _ProgressListener_onChange_io_realm_mongodb_sync_Progress_: - -.. _ProgressListener_onChange_Progress_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onChange ` ( - | :ref:`Progress ` progress - | ) - - - - - * - This method will be called periodically from the underlying Object Server Client responsible for uploading and downloading changes from the remote Object Server.This callback will *not* happen on the UI thread, but on the worker thread controlling the Object Server Client. Use ``Activity.runOnUiThread(Runnable)`` or similar to update any UI elements. - - - - - - .. code-block:: java - - - // Adding an upload progress listener that completes when all known changes have been - // uploaded. - session.addUploadProgressListener(ProgressMode.CURRENT_CHANGES, new ProgressListener() { - @Override - public void onChange(Progress progress) { - activity.runOnUiThread(new Runnable() { - @Override - public void run() { - updateProgressBar(progress); - } - }); - if (progress.isTransferComplete() { - session.removeProgressListener(this); - } - } - }); - - - - - - - - - - - **Parameters** - - - ``progress`` - an immutable progress change event with information about current progress. This object is thread safe. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt b/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt deleted file mode 100644 index c4c3e05137..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/ProgressMode.txt +++ /dev/null @@ -1,254 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum ProgressMode -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_ProgressMode: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.sync.ProgressMode - - -Enum describing how to listen to progress changes. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`CURRENT_CHANGES ` - - When registering the :ref:`ProgressListener ` , it will record the current size of changes, and will only continue to report progress updates until those changes have been either downloaded or uploaded. - - - - - - - * - :ref:`INDEFINITELY ` - - A :ref:`ProgressListener ` registered in this mode, will continue to report progress changes, even if changes are being added after the listener was registered. - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`ProgressMode ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`ProgressMode ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_sync_ProgressMode_CURRENT_CHANGES: - -.. _ProgressMode_CURRENT_CHANGES: - - - -``CURRENT_CHANGES`` --------------------- - -public static final :ref:`ProgressMode ` - -When registering the :ref:`ProgressListener ` , it will record the current size of changes, and will only continue to report progress updates until those changes have been either downloaded or uploaded. After that the progress listener will not report any further changes. - -This means that listeners registered in this mode should be done *before* changes are written to the Realm. - -Progress reported in this mode will only ever increase. - -This is useful when e.g. reporting progress when downloading a Realm for the first time. - - - - - -.. _io_realm_mongodb_sync_ProgressMode_INDEFINITELY: - -.. _ProgressMode_INDEFINITELY: - - - -``INDEFINITELY`` ------------------ - -public static final :ref:`ProgressMode ` - -A :ref:`ProgressListener ` registered in this mode, will continue to report progress changes, even if changes are being added after the listener was registered. - -Progress reported in this mode can both increase and decrease, e.g. if large amounts of data is written after registering the listener. - -This is useful when you want to track if all changes have been uploaded to the server from the device. - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _ProgressMode_valueOf: - -.. _ProgressMode_valueOf__: - -.. _io_realm_mongodb_sync_ProgressMode_valueOf: - -.. _io_realm_mongodb_sync_ProgressMode_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_sync_ProgressMode_valueOf_java_lang_String_: - -.. _io_realm_mongodb_sync_ProgressMode_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _ProgressMode_valueOf_java_lang_String_: - -.. _ProgressMode_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ProgressMode ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _ProgressMode_values: - -.. _ProgressMode_values__: - -.. _io_realm_mongodb_sync_ProgressMode_values: - -.. _io_realm_mongodb_sync_ProgressMode_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`ProgressMode ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt b/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt deleted file mode 100644 index 754e11a2cd..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/Subscription.txt +++ /dev/null @@ -1,529 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface Subscription -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_Subscription: - - - -io.realm.mongodb.sync -===================== - -A subscription defines a specific server query and its metadata. The result of this query is continuously being synchronized with the device as long as the subscription is part of a :ref:`SubscriptionSet ` with a state of :ref:`SubscriptionSet.State.COMPLETE ` . Subscriptions are immutable once created, but they can be updated by using a :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`Subscription ` - - | :ref:`create ` ( - | :ref:`io.realm.RealmQuery ` query - | ) - - - Create an unmanaged anonymous subscription for a flexible sync enabled Realm. - - - - - * - public static :ref:`Subscription ` - - | :ref:`create ` ( - | `String `__ name, - | :ref:`io.realm.RealmQuery ` query - | ) - - - Create an unmanaged named subscription for a flexible sync enabled Realm. - - - - - * - public `Date `__ - - | :ref:`getCreatedAt ` () - | - - - Returns the timestamp for when this subscription was persisted. - - - - - * - public `String `__ - - | :ref:`getName ` () - | - - - Returns the name of subscription or ``null`` if no name was defined. - - - - - - - * - public `String `__ - - | :ref:`getObjectType ` () - | - - - Returns the type that is being queried. - - - - - * - public `String `__ - - | :ref:`getQuery ` () - | - - - Returns the subscription query that is running on objects of type :ref:`getObjectType() ` . - - - - - - - * - public `Date `__ - - | :ref:`getUpdatedAt ` () - | - - - Returns the timestamp for when a persisted subscription was updated. - - - - - - - -Method Detail -============= - -.. _create: - -.. _create__: - -.. _Subscription_create: - -.. _Subscription_create__: - -.. _io_realm_mongodb_sync_Subscription_create: - -.. _io_realm_mongodb_sync_Subscription_create__: - - - -create ------- - -.. _io_realm_mongodb_sync_Subscription_create_io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_RealmQuery_: - -.. _create_io_realm_RealmQuery_: - -.. _create_RealmQuery_: - -.. _Subscription_create_io_realm_RealmQuery_: - -.. _Subscription_create_RealmQuery_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Subscription ` :ref:`create ` ( - | :ref:`io.realm.RealmQuery ` query - | ) - - - - - * - Create an unmanaged anonymous subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . - - - - - - - **Parameters** - - - ``query`` - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries. - - - - - - - - **Returns** - - the unmanaged subscription. - - - - - - - - - -.. _io_realm_mongodb_sync_Subscription_create_java_lang_String_io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_java_lang_String__io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_java_lang_String_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_java_lang_String__RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_String_io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_String__io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_String_RealmQuery_: - -.. _io_realm_mongodb_sync_Subscription_create_String__RealmQuery_: - -.. _create_java_lang_String_io_realm_RealmQuery_: - -.. _create_java_lang_String__io_realm_RealmQuery_: - -.. _create_java_lang_String_RealmQuery_: - -.. _create_java_lang_String__RealmQuery_: - -.. _create_String_io_realm_RealmQuery_: - -.. _create_String__io_realm_RealmQuery_: - -.. _create_String_RealmQuery_: - -.. _create_String__RealmQuery_: - -.. _Subscription_create_java_lang_String_io_realm_RealmQuery_: - -.. _Subscription_create_java_lang_String__io_realm_RealmQuery_: - -.. _Subscription_create_java_lang_String_RealmQuery_: - -.. _Subscription_create_java_lang_String__RealmQuery_: - -.. _Subscription_create_String_io_realm_RealmQuery_: - -.. _Subscription_create_String__io_realm_RealmQuery_: - -.. _Subscription_create_String_RealmQuery_: - -.. _Subscription_create_String__RealmQuery_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`Subscription ` :ref:`create ` ( - | `String `__ name, - | :ref:`io.realm.RealmQuery ` query - | ) - - - - - * - Create an unmanaged named subscription for a flexible sync enabled Realm. The subscription will not take effect until it has been stored using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . - - - - - - - **Parameters** - - - ``name`` - the name of the subscription - - - - - ``query`` - the query that is subscribed to. Note, subscription queries have restrictions compared to normal queries. - - - - - - - - **Returns** - - the unmanaged subscription. - - - - - - - - - - - -.. _getCreatedAt: - -.. _getCreatedAt__: - -.. _Subscription_getCreatedAt: - -.. _Subscription_getCreatedAt__: - -.. _io_realm_mongodb_sync_Subscription_getCreatedAt: - -.. _io_realm_mongodb_sync_Subscription_getCreatedAt__: - - - -getCreatedAt ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`getCreatedAt ` () - | - - - - - * - Returns the timestamp for when this subscription was persisted. This will return ``null`` until the Subscription has been added using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . - - - - - - - - - **Returns** - - the time this subscription was persisted, or ``null`` if the subscription hasn't been persisted yet. - - - - - - - - - - - - - -.. _getName: - -.. _getName__: - -.. _Subscription_getName: - -.. _Subscription_getName__: - -.. _io_realm_mongodb_sync_Subscription_getName: - -.. _io_realm_mongodb_sync_Subscription_getName__: - - - -getName -------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getName ` () - | - - - - - * - Returns the name of subscription or ``null`` if no name was defined. - - - - - - - - - **Returns** - - the name of the subscription. - - - - - - - - - - - -.. _getObjectType: - -.. _getObjectType__: - -.. _Subscription_getObjectType: - -.. _Subscription_getObjectType__: - -.. _io_realm_mongodb_sync_Subscription_getObjectType: - -.. _io_realm_mongodb_sync_Subscription_getObjectType__: - - - -getObjectType -------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getObjectType ` () - | - - - - - * - Returns the type that is being queried. - - - - - - - **Returns** - - the type that is being queried. - - - - - - - - - - - -.. _getQuery: - -.. _getQuery__: - -.. _Subscription_getQuery: - -.. _Subscription_getQuery__: - -.. _io_realm_mongodb_sync_Subscription_getQuery: - -.. _io_realm_mongodb_sync_Subscription_getQuery__: - - - -getQuery --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getQuery ` () - | - - - - - * - Returns the subscription query that is running on objects of type :ref:`getObjectType() ` . - - - - - - - - - **Returns** - - the query covered by this subscription. - - - - - - - - - - - -.. _getUpdatedAt: - -.. _getUpdatedAt__: - -.. _Subscription_getUpdatedAt: - -.. _Subscription_getUpdatedAt__: - -.. _io_realm_mongodb_sync_Subscription_getUpdatedAt: - -.. _io_realm_mongodb_sync_Subscription_getUpdatedAt__: - - - -getUpdatedAt ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `Date `__ :ref:`getUpdatedAt ` () - | - - - - - * - Returns the timestamp for when a persisted subscription was updated. This will return ``null`` until the Subscription has been added using either :ref:`MutableSubscriptionSet.add(Subscription) ` or :ref:`MutableSubscriptionSet.addOrUpdate(Subscription) ` . - - - - - - - - - **Returns** - - the time this subscription was updated, or ``null`` if the subscription hasn't been persisted yet. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt deleted file mode 100644 index d356a5da92..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet.txt +++ /dev/null @@ -1,1073 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SubscriptionSet -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SubscriptionSet: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- `java.lang.Iterable `__ - - -A subscription set is an immutable view of all current :ref:`Subscription ` s for a given Realm that has been configured for flexible sync. - -Flexible Sync is a way of defining which data gets synchronized to and from the device using :ref:`RealmQuery ` s. The query and its metadata are represented by a :ref:`Subscription ` . - - - -A subscription set thus defines all the data that is available to the device and being synchronized with the server. If the subscription set encounters an error, e.g. by containing an invalid query, the entire subscription set will enter an :ref:`SubscriptionSet.State.ERROR ` state, and no synchronization will happen until the error has been fixed. - - - -If a subscription is removed, so is the corresponding data, but it is only removed from the device. It isn't deleted on the server. - -It is possible to modify a subscription set while offline, but modification isn't accepted by the server before :ref:`getState() ` returns :ref:`SubscriptionSet.State.COMPLETE ` . - - - -It is possible to force the subscription set to be synchronized with the server by using :ref:`waitForSynchronization() ` and its variants. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`SubscriptionSet.State ` - - - * - ``public static interface`` - - :ref:`SubscriptionSet.UpdateCallback ` - - - * - ``public static interface`` - - :ref:`SubscriptionSet.UpdateAsyncCallback ` - - - * - ``public static interface`` - - :ref:`SubscriptionSet.StateChangeCallback ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`Subscription ` - - | :ref:`find ` ( - | `String `__ name - | ) - - - Find the subscription with a given name. - - - - - * - public :ref:`Subscription ` - - | :ref:`find ` ( - | :ref:`io.realm.RealmQuery ` query - | ) - - - Find the first subscription that contains the given query. - - - - - * - public `String `__ - - | :ref:`getErrorMessage ` () - | - - - If :ref:`getState() ` returns :ref:`State.ERROR ` , this method will return the reason. - - - - - - - * - public :ref:`SubscriptionSet.State ` - - | :ref:`getState ` () - | - - - Returns the current state of the SubscriptionSet. - - - - - * - public **int** - - | :ref:`size ` () - | - - - Returns how many subscriptions are currently in this subscription set. - - - - - * - public :ref:`SubscriptionSet ` - - | :ref:`update ` ( - | :ref:`SubscriptionSet.UpdateCallback ` action - | ) - - - Modify the subscription set. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`updateAsync ` ( - | :ref:`SubscriptionSet.UpdateAsyncCallback ` callback - | ) - - - Asynchronously modify the subscription set. - - - - - * - public **boolean** - - | :ref:`waitForSynchronization ` ( - | `Long `__ timeOut, - | `TimeUnit `__ unit - | ) - - - Wait for the subscription set to synchronize with the server. - - - - - * - public **boolean** - - | :ref:`waitForSynchronization ` () - | - - - Wait for the subscription set to synchronize with the server. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`waitForSynchronizationAsync ` ( - | `Long `__ timeOut, - | `TimeUnit `__ unit, - | :ref:`SubscriptionSet.StateChangeCallback ` callback - | ) - - - Asynchronously wait for the subscription set to synchronize with the server. - - - - - * - public :ref:`RealmAsyncTask ` - - | :ref:`waitForSynchronizationAsync ` ( - | :ref:`SubscriptionSet.StateChangeCallback ` callback - | ) - - - Asynchronously wait for the subscription set to synchronize with the server. - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _find: - -.. _find__: - -.. _SubscriptionSet_find: - -.. _SubscriptionSet_find__: - -.. _io_realm_mongodb_sync_SubscriptionSet_find: - -.. _io_realm_mongodb_sync_SubscriptionSet_find__: - - - -find ----- - -.. _io_realm_mongodb_sync_SubscriptionSet_find_java_lang_String_: - -.. _io_realm_mongodb_sync_SubscriptionSet_find_String_: - -.. _find_java_lang_String_: - -.. _find_String_: - -.. _SubscriptionSet_find_java_lang_String_: - -.. _SubscriptionSet_find_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Subscription ` :ref:`find ` ( - | `String `__ name - | ) - - - - - * - Find the subscription with a given name. - - - - - **Parameters** - - - ``name`` - name of subscription to search for. - - - - - - - - **Returns** - - the matching subscription or ``null`` if no subscription with that name was found. - - - - - - - - - - - -.. _io_realm_mongodb_sync_SubscriptionSet_find_io_realm_RealmQuery_: - -.. _io_realm_mongodb_sync_SubscriptionSet_find_RealmQuery_: - -.. _find_io_realm_RealmQuery_: - -.. _find_RealmQuery_: - -.. _SubscriptionSet_find_io_realm_RealmQuery_: - -.. _SubscriptionSet_find_RealmQuery_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Subscription ` :ref:`find ` ( - | :ref:`io.realm.RealmQuery ` query - | ) - - - - - * - Find the first subscription that contains the given query. It is possible for multiple named subscriptions to contain the same query. - - - - - **Parameters** - - - ``query`` - query to search for. - - - - - - - - **Returns** - - the first subscription containing the query or ``null`` if no match was found. - - - - - - - - - - - - - -.. _getErrorMessage: - -.. _getErrorMessage__: - -.. _SubscriptionSet_getErrorMessage: - -.. _SubscriptionSet_getErrorMessage__: - -.. _io_realm_mongodb_sync_SubscriptionSet_getErrorMessage: - -.. _io_realm_mongodb_sync_SubscriptionSet_getErrorMessage__: - - - -getErrorMessage ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getErrorMessage ` () - | - - - - - * - If :ref:`getState() ` returns :ref:`State.ERROR ` , this method will return the reason. Errors can be fixed by modifying the subscription accordingly and then calling :ref:`waitForSynchronization() ` . - - - - - - - - - **Returns** - - the underlying error if the subscription set is in the :ref:`State.ERROR ` state. For all other states ``null`` will be returned. - - - - - - - - - - - - - -.. _getState: - -.. _getState__: - -.. _SubscriptionSet_getState: - -.. _SubscriptionSet_getState__: - -.. _io_realm_mongodb_sync_SubscriptionSet_getState: - -.. _io_realm_mongodb_sync_SubscriptionSet_getState__: - - - -getState --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SubscriptionSet.State ` :ref:`getState ` () - | - - - - - * - Returns the current state of the SubscriptionSet. See :ref:`SubscriptionSet.State ` for more details about each state. - - - - - - - - - **Returns** - - current state of the SubscriptionSet. - - - - - - - - - - - -.. _size: - -.. _size__: - -.. _SubscriptionSet_size: - -.. _SubscriptionSet_size__: - -.. _io_realm_mongodb_sync_SubscriptionSet_size: - -.. _io_realm_mongodb_sync_SubscriptionSet_size__: - - - -size ----- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`size ` () - | - - - - - * - Returns how many subscriptions are currently in this subscription set. - - - - - - - **Returns** - - the number of of subscriptions in the subscription set. - - - - - - - - - - - -.. _update: - -.. _update__: - -.. _SubscriptionSet_update: - -.. _SubscriptionSet_update__: - -.. _io_realm_mongodb_sync_SubscriptionSet_update: - -.. _io_realm_mongodb_sync_SubscriptionSet_update__: - - - -update ------- - -.. _io_realm_mongodb_sync_SubscriptionSet_update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_update_UpdateCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_update_SubscriptionSet_UpdateCallback_: - -.. _update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: - -.. _update_UpdateCallback_: - -.. _update_SubscriptionSet_UpdateCallback_: - -.. _SubscriptionSet_update_io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_: - -.. _SubscriptionSet_update_UpdateCallback_: - -.. _SubscriptionSet_update_SubscriptionSet_UpdateCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SubscriptionSet ` :ref:`update ` ( - | :ref:`SubscriptionSet.UpdateCallback ` action - | ) - - - - - * - Modify the subscription set. If an exception is thrown during the update, no changes will be applied. If the update succeeds, this subscription set is updated with the modified state. - - - - - **Parameters** - - - ``action`` - the block that modifies the subscription set. It will run on the caller thread. - - - - - - - - **Returns** - - this subscription set, that now has been updated. - - - - - **Throws** - - - `Exception `__ - any exception thrown during the update, will propagate back. - - - - - - - - - - - - -.. _updateAsync: - -.. _updateAsync__: - -.. _SubscriptionSet_updateAsync: - -.. _SubscriptionSet_updateAsync__: - -.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync: - -.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync__: - - - -updateAsync ------------ - -.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_UpdateAsyncCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_updateAsync_SubscriptionSet_UpdateAsyncCallback_: - -.. _updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: - -.. _updateAsync_UpdateAsyncCallback_: - -.. _updateAsync_SubscriptionSet_UpdateAsyncCallback_: - -.. _SubscriptionSet_updateAsync_io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_: - -.. _SubscriptionSet_updateAsync_UpdateAsyncCallback_: - -.. _SubscriptionSet_updateAsync_SubscriptionSet_UpdateAsyncCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`updateAsync ` ( - | :ref:`SubscriptionSet.UpdateAsyncCallback ` callback - | ) - - - - - * - Asynchronously modify the subscription set. If an exception is thrown during the update, no changes will be applied. \* - - - - - **Parameters** - - - ``callback`` - callback that controls the asynct ask. Succces or failure will be reported here. - - - - - - - - **Returns** - - task controlling the async execution. - - - - - - - - - - - -.. _waitForSynchronization: - -.. _waitForSynchronization__: - -.. _SubscriptionSet_waitForSynchronization: - -.. _SubscriptionSet_waitForSynchronization__: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization__: - - - -waitForSynchronization ----------------------- - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_java_lang_Long__TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long_TimeUnit_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronization_Long__TimeUnit_: - -.. _waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: - -.. _waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: - -.. _waitForSynchronization_java_lang_Long_TimeUnit_: - -.. _waitForSynchronization_java_lang_Long__TimeUnit_: - -.. _waitForSynchronization_Long_java_util_concurrent_TimeUnit_: - -.. _waitForSynchronization_Long__java_util_concurrent_TimeUnit_: - -.. _waitForSynchronization_Long_TimeUnit_: - -.. _waitForSynchronization_Long__TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_java_lang_Long_java_util_concurrent_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_java_lang_Long__java_util_concurrent_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_java_lang_Long_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_java_lang_Long__TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_Long_java_util_concurrent_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_Long__java_util_concurrent_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_Long_TimeUnit_: - -.. _SubscriptionSet_waitForSynchronization_Long__TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`waitForSynchronization ` ( - | `Long `__ timeOut, - | `TimeUnit `__ unit - | ) - - - - - * - Wait for the subscription set to synchronize with the server. It will return when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . - - - - - - - **Parameters** - - - ``timeOut`` - how long to wait for the synchronization to either succeed or fail. - - - - - ``unit`` - unit of time used for the timeout. - - - - - - - - **Returns** - - ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. - - - - - - - **Throws** - - - `RuntimeException `__ - if the timeout is exceeded. - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`waitForSynchronization ` () - | - - - - - * - Wait for the subscription set to synchronize with the server. It will return when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . - - - - - - - - - **Returns** - - ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. - - - - - - - - - - - - - -.. _waitForSynchronizationAsync: - -.. _waitForSynchronizationAsync__: - -.. _SubscriptionSet_waitForSynchronizationAsync: - -.. _SubscriptionSet_waitForSynchronizationAsync__: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync__: - - - -waitForSynchronizationAsync ---------------------------- - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_java_lang_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_java_util_concurrent_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__java_util_concurrent_TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long_TimeUnit_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_Long__TimeUnit__SubscriptionSet_StateChangeCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`waitForSynchronizationAsync ` ( - | `Long `__ timeOut, - | `TimeUnit `__ unit, - | :ref:`SubscriptionSet.StateChangeCallback ` callback - | ) - - - - - * - Asynchronously wait for the subscription set to synchronize with the server. The callback is invoked when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . - - - - - - - **Parameters** - - - ``timeOut`` - how long to wait for the synchronization to either succeed or fail. - - - - - ``unit`` - unit of time used for the timeout. - - - - - ``callback`` - callback to trigger when the synchronization either succeed or fail. Results will be reported on the UI thread. - - - - - - - - **Returns** - - ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. - - - - - - - - - - - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_StateChangeCallback_: - -.. _io_realm_mongodb_sync_SubscriptionSet_waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _waitForSynchronizationAsync_StateChangeCallback_: - -.. _waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_StateChangeCallback_: - -.. _SubscriptionSet_waitForSynchronizationAsync_SubscriptionSet_StateChangeCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmAsyncTask ` :ref:`waitForSynchronizationAsync ` ( - | :ref:`SubscriptionSet.StateChangeCallback ` callback - | ) - - - - - * - Asynchronously wait for the subscription set to synchronize with the server. It will invoke the callback when the server either accepts the set of queries and has downloaded data for them, or if an error has occurred. Note, that you will either need to manually call **Realm.refresh()** or wait for change listeners to trigger to see the downloaded data. If an error occurred, the underlying reason can be found through :ref:`getErrorMessage() ` . - - - - - - - **Parameters** - - - ``callback`` - callback to trigger when the synchronization either succeed or fail. Results will be reported on the UI thread. - - - - - - - - **Returns** - - ``true`` if all current subscriptions were accepted by the server and data has been downloaded, or ``false`` if an error occurred. - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt deleted file mode 100644 index 531a782037..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/State.txt +++ /dev/null @@ -1,412 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum SubscriptionSet.State -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SubscriptionSet_State: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.sync.SubscriptionSet.State - - - - -**Enclosing class:** - -:ref:`SubscriptionSet ` - - - -The possible states a subscription set can be in. - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`BOOTSTRAPPING ` - - A subscription set was accepted by the server and initial data is being sent to the device. - - - - - * - :ref:`COMPLETE ` - - A subscription set is actively synchronizing data between the server and the device. - - - - - * - :ref:`ERROR ` - - An error occurred in the subscription set or one of the subscriptions. - - - - - * - :ref:`PENDING ` - - A subscription set has been modified locally, but is still waiting to be sent to the server. - - - - - * - :ref:`SUPERSEDED ` - - Another subscription set was stored before this one, the changes made to this set are ignorde by the server. - - - - - * - :ref:`UNCOMMITTED ` - - The initial state of subscriptions when opening a new Realm or when entering a **update(UpdateCallback)**. - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`SubscriptionSet.State ` - - | :ref:`fromNativeValue ` ( - | **long** value - | ) - - - - - - - - * - public static :ref:`SubscriptionSet.State ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`SubscriptionSet.State ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_BOOTSTRAPPING: - -.. _SubscriptionSet_State_BOOTSTRAPPING: - - - -``BOOTSTRAPPING`` ------------------- - -public static final :ref:`SubscriptionSet.State ` - -A subscription set was accepted by the server and initial data is being sent to the device. - - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_COMPLETE: - -.. _SubscriptionSet_State_COMPLETE: - - - -``COMPLETE`` -------------- - -public static final :ref:`SubscriptionSet.State ` - -A subscription set is actively synchronizing data between the server and the device. - - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_ERROR: - -.. _SubscriptionSet_State_ERROR: - - - -``ERROR`` ----------- - -public static final :ref:`SubscriptionSet.State ` - -An error occurred in the subscription set or one of the subscriptions. The cause is found in **getErrorMessage()**. - - - - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_PENDING: - -.. _SubscriptionSet_State_PENDING: - - - -``PENDING`` ------------- - -public static final :ref:`SubscriptionSet.State ` - -A subscription set has been modified locally, but is still waiting to be sent to the server. - - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_SUPERSEDED: - -.. _SubscriptionSet_State_SUPERSEDED: - - - -``SUPERSEDED`` ---------------- - -public static final :ref:`SubscriptionSet.State ` - -Another subscription set was stored before this one, the changes made to this set are ignorde by the server. Get the latest subscription set by calling **Realm.getSubscriptions()**. - - - - - -.. _io_realm_mongodb_sync_SubscriptionSet_State_UNCOMMITTED: - -.. _SubscriptionSet_State_UNCOMMITTED: - - - -``UNCOMMITTED`` ----------------- - -public static final :ref:`SubscriptionSet.State ` - -The initial state of subscriptions when opening a new Realm or when entering a **update(UpdateCallback)**. - - - - - - -Method Detail -============= - -.. _fromNativeValue: - -.. _fromNativeValue__: - -.. _State_fromNativeValue: - -.. _State_fromNativeValue__: - -.. _SubscriptionSet_State_fromNativeValue: - -.. _SubscriptionSet_State_fromNativeValue__: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue__: - - - -fromNativeValue ---------------- - -.. _io_realm_mongodb_sync_SubscriptionSet_State_fromNativeValue_long_: - -.. _fromNativeValue_long_: - -.. _SubscriptionSet_State_fromNativeValue_long_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SubscriptionSet.State ` :ref:`fromNativeValue ` ( - | **long** value - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _valueOf: - -.. _valueOf__: - -.. _State_valueOf: - -.. _State_valueOf__: - -.. _SubscriptionSet_State_valueOf: - -.. _SubscriptionSet_State_valueOf__: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf_java_lang_String_: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _SubscriptionSet_State_valueOf_java_lang_String_: - -.. _SubscriptionSet_State_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SubscriptionSet.State ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _State_values: - -.. _State_values__: - -.. _SubscriptionSet_State_values: - -.. _SubscriptionSet_State_values__: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_values: - -.. _io_realm_mongodb_sync_SubscriptionSet_State_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SubscriptionSet.State ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt deleted file mode 100644 index 5fd0fbbaad..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/StateChangeCallback.txt +++ /dev/null @@ -1,191 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SubscriptionSet.StateChangeCallback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback: - - - -io.realm.mongodb.sync -===================== - - - -**Enclosing class:** - -:ref:`SubscriptionSet ` - - - -Callback used when asynchronously waiting for the server to process the subscription set. When the server either succeed or fail to apply the subscription set, the result is returned in ``onStateChange`` . This include errors from the server. If a local exception is thrown, it is reported through on ``onError()`` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ e - | ) - - - - - - - - * - public **void** - - | :ref:`onStateChange ` ( - | :ref:`SubscriptionSet ` subscriptions - | ) - - - - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _StateChangeCallback_onError: - -.. _StateChangeCallback_onError__: - -.. _SubscriptionSet_StateChangeCallback_onError: - -.. _SubscriptionSet_StateChangeCallback_onError__: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError__: - - - -onError -------- - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError_java_lang_Throwable_: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _SubscriptionSet_StateChangeCallback_onError_java_lang_Throwable_: - -.. _SubscriptionSet_StateChangeCallback_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ e - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _onStateChange: - -.. _onStateChange__: - -.. _StateChangeCallback_onStateChange: - -.. _StateChangeCallback_onStateChange__: - -.. _SubscriptionSet_StateChangeCallback_onStateChange: - -.. _SubscriptionSet_StateChangeCallback_onStateChange__: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange__: - - - -onStateChange -------------- - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange_io_realm_mongodb_sync_SubscriptionSet_: - -.. _io_realm_mongodb_sync_SubscriptionSet_StateChangeCallback_onStateChange_SubscriptionSet_: - -.. _onStateChange_io_realm_mongodb_sync_SubscriptionSet_: - -.. _onStateChange_SubscriptionSet_: - -.. _SubscriptionSet_StateChangeCallback_onStateChange_io_realm_mongodb_sync_SubscriptionSet_: - -.. _SubscriptionSet_StateChangeCallback_onStateChange_SubscriptionSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onStateChange ` ( - | :ref:`SubscriptionSet ` subscriptions - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt deleted file mode 100644 index 493c318d43..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateAsyncCallback.txt +++ /dev/null @@ -1,203 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SubscriptionSet.UpdateAsyncCallback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- :ref:`io.realm.mongodb.sync.SubscriptionSet.UpdateCallback ` - - - - -**Enclosing class:** - -:ref:`SubscriptionSet ` - - - -Callback used when asynchronously updating a subscription set. If an exception is throwing during the update, all changes will be rolled back and the exception will be reported in ``onError()`` . - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - - - - - - * - public **void** - - | :ref:`onSuccess ` ( - | :ref:`SubscriptionSet ` subscriptions - | ) - - - - - - - - - - -Inherited Methods -================= - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _UpdateAsyncCallback_onError: - -.. _UpdateAsyncCallback_onError__: - -.. _SubscriptionSet_UpdateAsyncCallback_onError: - -.. _SubscriptionSet_UpdateAsyncCallback_onError__: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError__: - - - -onError -------- - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError_java_lang_Throwable_: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onError_Throwable_: - -.. _onError_java_lang_Throwable_: - -.. _onError_Throwable_: - -.. _SubscriptionSet_UpdateAsyncCallback_onError_java_lang_Throwable_: - -.. _SubscriptionSet_UpdateAsyncCallback_onError_Throwable_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | `Throwable `__ exception - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _onSuccess: - -.. _onSuccess__: - -.. _UpdateAsyncCallback_onSuccess: - -.. _UpdateAsyncCallback_onSuccess__: - -.. _SubscriptionSet_UpdateAsyncCallback_onSuccess: - -.. _SubscriptionSet_UpdateAsyncCallback_onSuccess__: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess__: - - - -onSuccess ---------- - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess_io_realm_mongodb_sync_SubscriptionSet_: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateAsyncCallback_onSuccess_SubscriptionSet_: - -.. _onSuccess_io_realm_mongodb_sync_SubscriptionSet_: - -.. _onSuccess_SubscriptionSet_: - -.. _SubscriptionSet_UpdateAsyncCallback_onSuccess_io_realm_mongodb_sync_SubscriptionSet_: - -.. _SubscriptionSet_UpdateAsyncCallback_onSuccess_SubscriptionSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onSuccess ` ( - | :ref:`SubscriptionSet ` subscriptions - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt b/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt deleted file mode 100644 index 1bc534cff8..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SubscriptionSet/UpdateCallback.txt +++ /dev/null @@ -1,129 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SubscriptionSet.UpdateCallback -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback: - - - -io.realm.mongodb.sync -===================== - - - -**Enclosing class:** - -:ref:`SubscriptionSet ` - - - -Interface used when modifying a subscription set. See **update(UpdateCallback)** and **updateAsync(UpdateAsyncCallback)**. - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`update ` ( - | :ref:`MutableSubscriptionSet ` subscriptions - | ) - - - Updates the current subscription set by passing in a version of it that can be modified. - - - - - - - -Method Detail -============= - -.. _update: - -.. _update__: - -.. _UpdateCallback_update: - -.. _UpdateCallback_update__: - -.. _SubscriptionSet_UpdateCallback_update: - -.. _SubscriptionSet_UpdateCallback_update__: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update__: - - - -update ------- - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SubscriptionSet_UpdateCallback_update_MutableSubscriptionSet_: - -.. _update_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _update_MutableSubscriptionSet_: - -.. _SubscriptionSet_UpdateCallback_update_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _SubscriptionSet_UpdateCallback_update_MutableSubscriptionSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`update ` ( - | :ref:`MutableSubscriptionSet ` subscriptions - | ) - - - - - * - Updates the current subscription set by passing in a version of it that can be modified. If an exception is throwing during the update, all changes will be rolled back. - - - - - **Parameters** - - - ``subscriptions`` - a modifiable version of the subscription set. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt b/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt deleted file mode 100644 index bf39f400f9..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/Sync.txt +++ /dev/null @@ -1,427 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Sync -^^^^^^^^^^ - -.. _io_realm_mongodb_sync_Sync: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.sync.Sync - - -A *sync* manager handling synchronization of local Realms with remote Realm Apps.The primary role of this is to access the :ref:`SyncSession ` for a synchronized Realm. After opening the synchronized Realm you can access the :ref:`SyncSession ` and perform synchronization related operations as shown below: - - - - - -.. code-block:: java - - App app = new App("app-id"); - User user = app.login(Credentials.anonymous()); - SyncConfiguration syncConfiguration = new SyncConfiguration.Builder(user, "") - .build(); - Realm instance = Realm.getInstance(syncConfiguration); - SyncSession session = app.getSync().getSession(syncConfiguration); - - instance.executeTransaction(realm -> { - realm.insert(...); - }); - session.uploadAllLocalChanges(); - instance.close(); - - - - - -.. seealso:: - - - - - :ref:`App.getSync() ` - - - - - :ref:`Sync.getSession(SyncConfiguration) ` - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static`` - - :ref:`Sync.Debug ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public synchronized `Collection `__ - - | :ref:`getAllSessions ` () - | - - - Gets a collection of all the cached :ref:`SyncSession ` . - - - - - - - * - public synchronized :ref:`SyncSession ` - - | :ref:`getOrCreateSession ` ( - | :ref:`SyncConfiguration ` syncConfiguration - | ) - - - Gets any cached :ref:`SyncSession ` for the given :ref:`SyncConfiguration ` or create a new one if no one exists. - - - - - - - * - public synchronized :ref:`SyncSession ` - - | :ref:`getSession ` ( - | :ref:`SyncConfiguration ` syncConfiguration - | ) - - - Gets a cached :ref:`SyncSession ` for the given :ref:`SyncConfiguration ` or throw if no one exists yet. - - - - - - - * - public **void** - - | :ref:`reconnect ` () - | - - - Realm will automatically detect when a device gets connectivity after being offline and resume syncing. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _getAllSessions: - -.. _getAllSessions__: - -.. _Sync_getAllSessions: - -.. _Sync_getAllSessions__: - -.. _io_realm_mongodb_sync_Sync_getAllSessions: - -.. _io_realm_mongodb_sync_Sync_getAllSessions__: - - - -getAllSessions --------------- - -.. list-table:: - :header-rows: 1 - - * - | public synchronized `Collection `__ :ref:`getAllSessions ` () - | - - - - - * - Gets a collection of all the cached :ref:`SyncSession ` . - - - - - - - - - **Returns** - - a collection of :ref:`SyncSession ` . - - - - - - - - - - - - - -.. _getOrCreateSession: - -.. _getOrCreateSession__: - -.. _Sync_getOrCreateSession: - -.. _Sync_getOrCreateSession__: - -.. _io_realm_mongodb_sync_Sync_getOrCreateSession: - -.. _io_realm_mongodb_sync_Sync_getOrCreateSession__: - - - -getOrCreateSession ------------------- - -.. _io_realm_mongodb_sync_Sync_getOrCreateSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _io_realm_mongodb_sync_Sync_getOrCreateSession_SyncConfiguration_: - -.. _getOrCreateSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _getOrCreateSession_SyncConfiguration_: - -.. _Sync_getOrCreateSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _Sync_getOrCreateSession_SyncConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`SyncSession ` :ref:`getOrCreateSession ` ( - | :ref:`SyncConfiguration ` syncConfiguration - | ) - - - - - * - Gets any cached :ref:`SyncSession ` for the given :ref:`SyncConfiguration ` or create a new one if no one exists. Note: This is mainly for internal usage, consider using :ref:`getSession(SyncConfiguration) ` instead. - - - - - - - **Parameters** - - - ``syncConfiguration`` - configuration object for the synchronized Realm. - - - - - - - - **Returns** - - the :ref:`SyncSession ` for the specified Realm. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . - - - - - - - - - - - - - - -.. _getSession: - -.. _getSession__: - -.. _Sync_getSession: - -.. _Sync_getSession__: - -.. _io_realm_mongodb_sync_Sync_getSession: - -.. _io_realm_mongodb_sync_Sync_getSession__: - - - -getSession ----------- - -.. _io_realm_mongodb_sync_Sync_getSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _io_realm_mongodb_sync_Sync_getSession_SyncConfiguration_: - -.. _getSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _getSession_SyncConfiguration_: - -.. _Sync_getSession_io_realm_mongodb_sync_SyncConfiguration_: - -.. _Sync_getSession_SyncConfiguration_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized :ref:`SyncSession ` :ref:`getSession ` ( - | :ref:`SyncConfiguration ` syncConfiguration - | ) - - - - - * - Gets a cached :ref:`SyncSession ` for the given :ref:`SyncConfiguration ` or throw if no one exists yet. A session should exist after you open a Realm with a :ref:`SyncConfiguration ` . - - - - - - - **Parameters** - - - ``syncConfiguration`` - configuration object for the synchronized Realm. - - - - - - - - **Returns** - - the :ref:`SyncSession ` for the specified Realm. - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if syncConfiguration is ``null`` . - - - - - - - `IllegalStateException `__ - if the session could not be found using the provided ``SyncConfiguration`` . - - - - - - - - - - - - - - -.. _reconnect: - -.. _reconnect__: - -.. _Sync_reconnect: - -.. _Sync_reconnect__: - -.. _io_realm_mongodb_sync_Sync_reconnect: - -.. _io_realm_mongodb_sync_Sync_reconnect__: - - - -reconnect ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`reconnect ` () - | - - - - - * - Realm will automatically detect when a device gets connectivity after being offline and resume syncing.However, as some of these checks are performed using incremental backoff, this will in some cases not happen immediately. - - In those cases it can be beneficial to call this method manually, which will force all sessions to attempt to reconnect immediately and reset any timers they are using for incremental backoff. - - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt b/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt deleted file mode 100644 index c9d62c557a..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/Sync/Debug.txt +++ /dev/null @@ -1,154 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class Sync.Debug -^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_Sync_Debug: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.sync.Sync.Debug - - - - -**Enclosing class:** - -:ref:`Sync ` - - - -Debugging related options. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Debug ` () - | - - - - - - - - - - -Field Summary -============= - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Field and Description - - * - public static **boolean** - - - - :ref:`separatedDirForSyncManager ` - - Set this to true to init a SyncManager with a directory named by the process ID. This is useful for integration tests which are emulating multiple sync client by using multiple processes. - - - * - public static **boolean** - - - - :ref:`skipOnlineChecking ` - - Set this to true to bypass checking if the device is offline before making HTTP requests. - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Field Detail -============ - -.. _io_realm_mongodb_sync_Sync_Debug_separatedDirForSyncManager: - - - -``separatedDirForSyncManager`` -------------------------------- - -Set this to true to init a SyncManager with a directory named by the process ID. This is useful for integration tests which are emulating multiple sync client by using multiple processes. - - -.. _io_realm_mongodb_sync_Sync_Debug_skipOnlineChecking: - - - -``skipOnlineChecking`` ------------------------ - -Set this to true to bypass checking if the device is offline before making HTTP requests. - - - - -Constructor Detail -================== - -.. _Debug: - -.. _Debug__: - -.. _io_realm_mongodb_sync_Sync_Debug: - -.. _io_realm_mongodb_sync_Sync_Debug__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Debug ` () - | - - - - - * - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt deleted file mode 100644 index 0833c35929..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncClientResetStrategy.txt +++ /dev/null @@ -1,26 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SyncClientResetStrategy -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncClientResetStrategy: - - - -io.realm.mongodb.sync -===================== - -Interface that defines a generic sync client reset strategy, it could be either :ref:`ManuallyRecoverUnsyncedChangesStrategy ` or :ref:`DiscardUnsyncedChangesStrategy ` . - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt deleted file mode 100644 index 5c593205b5..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration.txt +++ /dev/null @@ -1,2122 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class SyncConfiguration -^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncConfiguration: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | :ref:`io.realm.RealmConfiguration ` - | io.realm.mongodb.sync.SyncConfiguration - - -A :ref:`SyncConfiguration ` is used to setup a realm that can be synchronized between devices using MongoDB Realm. - -A valid :ref:`User ` is required to create a :ref:`SyncConfiguration ` . See :ref:`Credentials ` and :ref:`App.loginAsync(Credentials, App.Callback) ` for more information on how to get a user object. - - - -A minimal :ref:`SyncConfiguration ` can be found below. - - - - - -.. code-block:: java - - - App app = new App("app-id"); - User user = app.login(Credentials.anonymous()); - SyncConfiguration config = SyncConfiguration.defaultConfiguration(user, "partition-value"); - Realm realm = Realm.getInstance(config); - - - - - -Synchronized Realms only support additive migrations which can be detected and performed automatically, so the following builder options are not accessible compared to a normal Realm: - - - -- ``deleteRealmIfMigrationNeeded()`` - - - - -- ``migration(Migration)`` - - - - - - -Synchronized Realms are created by using :ref:`Realm.getInstance(RealmConfiguration) ` and :ref:`Realm.getDefaultInstance() ` like ordinary unsynchronized Realms. - - - - -.. seealso:: - - - - - `The docs `__ for more information about synchronization. - - - - - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static interface`` - - :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` - - - * - ``public static final`` - - :ref:`SyncConfiguration.Builder ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`SyncConfiguration ` - - | :ref:`defaultConfig ` ( - | :ref:`User ` user, - | **ObjectId** partitionValue - | ) - - - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - * - public static :ref:`SyncConfiguration ` - - | :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `Integer `__ partitionValue - | ) - - - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - * - public static :ref:`SyncConfiguration ` - - | :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `Long `__ partitionValue - | ) - - - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - * - public static :ref:`SyncConfiguration ` - - | :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `String `__ partitionValue - | ) - - - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - * - public static :ref:`SyncConfiguration ` - - | :ref:`defaultConfig ` ( - | :ref:`User ` user - | ) - - - Returns a default Flexible Sync configuration for the given user. - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public static :ref:`RealmConfiguration ` - - | :ref:`forRecovery ` ( - | `String `__ canonicalPath - | ) - - - Returns a :ref:`RealmConfiguration ` appropriate to open a read-only, non-synced Realm to recover any pending changes. - - - - - - - * - public static :ref:`RealmConfiguration ` - - | :ref:`forRecovery ` ( - | `String `__ canonicalPath, - | **byte[]** encryptionKey, - | `java.lang.Object[] `__ modules - | ) - - - Returns a :ref:`RealmConfiguration ` appropriate to open a read-only, non-synced Realm to recover any pending changes. - - - - - - - * - public :ref:`SyncSession.ClientResetHandler ` - - | :ref:`getClientResetHandler ` () - | - - - Returns the Client Reset handler for this *SyncConfiguration*. - - - - - * - public :ref:`SyncSession.ErrorHandler ` - - | :ref:`getErrorHandler ` () - | - - - Returns the error handler for this *SyncConfiguration*. - - - - - * - protected :ref:`Realm.Transaction ` - - | :ref:`getInitialDataTransaction ` () - | - - - Returns the transaction instance with initial data. - - - - - * - public **long** - - | :ref:`getInitialRemoteDataTimeout ` ( - | `TimeUnit `__ unit - | ) - - - Returns the timeout defined when downloading any initial data the first time the Realm is opened. - - - - - * - public :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` - - | :ref:`getInitialSubscriptionsHandler ` () - | - - - Returns the configured initial subscription handler for this realm. - - - - - * - public **BsonValue** - - | :ref:`getPartitionValue ` () - | - - - Returns the value this Realm is partitioned on. - - - - - * - public `URI `__ - - | :ref:`getServerUrl ` () - | - - - Returns the server URI for the remote MongoDB Realm the local Realm is synchronizing with. - - - - - * - public **OsRealmConfig.SyncSessionStopPolicy** - - | :ref:`getSessionStopPolicy ` () - | - - - NOTE: Only for internal usage. - - - - - * - public :ref:`SyncClientResetStrategy ` - - | :ref:`getSyncClientResetStrategy ` () - | - - - Returns the sync client reset strategy for this *SyncConfiguration*. - - - - - * - public `String `__ - - | :ref:`getUrlPrefix ` () - | - - - Returns the url prefix used when establishing a sync connection to the Realm Object Server. - - - - - * - public :ref:`User ` - - | :ref:`getUser ` () - | - - - Returns the user. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public **boolean** - - | :ref:`isFlexibleSyncConfiguration ` () - | - - - Returns whether or not this configuration is for opening a Realm configured for Flexible Sync. - - - - - * - public **boolean** - - | :ref:`isPartitionBasedSyncConfiguration ` () - | - - - Returns whether or not this configuration is for opening a Realm configured for Partition-based Sync. - - - - - * - protected **boolean** - - | :ref:`isSyncConfiguration ` () - | - - - - - - - - * - protected **boolean** - - | :ref:`realmExists ` () - | - - - Checks if the Realm file defined by this configuration already exists. - - - - - * - public **boolean** - - | :ref:`shouldDeleteRealmOnLogout ` () - | - - - Returns ``true`` if the Realm file must be deleted once the :ref:`User ` owning it logs out. - - - - - - - * - public **boolean** - - | :ref:`shouldWaitForInitialRemoteData ` () - | - - - Returns ``true`` if the Realm will download all known changes from the remote server before being opened the first time. - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class :ref:`io.realm.RealmConfiguration ` : ``getRealmDirectory`` , ``getRealmFileName`` , ``getEncryptionKey`` , ``getSchemaVersion`` , ``getMigration`` , ``shouldDeleteRealmIfMigrationNeeded`` , ``getDurability`` , ``getSchemaMediator`` , ``getInitialDataTransaction`` , ``hasAssetFile`` , ``getAssetFilePath`` , ``getCompactOnLaunchCallback`` , ``getRealmObjectClasses`` , ``getPath`` , ``realmExists`` , ``getRxFactory`` , ``getFlowFactory`` , ``isReadOnly`` , ``isRecoveryConfiguration`` , ``getMaxNumberOfActiveVersions`` , ``isAllowWritesOnUiThread`` , ``isAllowQueriesOnUiThread`` , ``equals`` , ``getInstance`` , ``hashCode`` , ``createSchemaMediator`` , ``toString`` , ``isSyncConfiguration`` , ``forRecovery`` - - - - -Method Detail -============= - -.. _defaultConfig: - -.. _defaultConfig__: - -.. _SyncConfiguration_defaultConfig: - -.. _SyncConfiguration_defaultConfig__: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig__: - - - -defaultConfig -------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_ObjectId_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__ObjectId_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_ObjectId_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__ObjectId_: - -.. _defaultConfig_io_realm_mongodb_User_ObjectId_: - -.. _defaultConfig_io_realm_mongodb_User__ObjectId_: - -.. _defaultConfig_User_ObjectId_: - -.. _defaultConfig_User__ObjectId_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_ObjectId_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__ObjectId_: - -.. _SyncConfiguration_defaultConfig_User_ObjectId_: - -.. _SyncConfiguration_defaultConfig_User__ObjectId_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( - | :ref:`User ` user, - | **ObjectId** partitionValue - | ) - - - - - * - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - **Returns** - - the default configuration for the given user and partition value. - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_java_lang_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__java_lang_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_Integer_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__Integer_: - -.. _defaultConfig_io_realm_mongodb_User_java_lang_Integer_: - -.. _defaultConfig_io_realm_mongodb_User__java_lang_Integer_: - -.. _defaultConfig_io_realm_mongodb_User_Integer_: - -.. _defaultConfig_io_realm_mongodb_User__Integer_: - -.. _defaultConfig_User_java_lang_Integer_: - -.. _defaultConfig_User__java_lang_Integer_: - -.. _defaultConfig_User_Integer_: - -.. _defaultConfig_User__Integer_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_Integer_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_Integer_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_Integer_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__Integer_: - -.. _SyncConfiguration_defaultConfig_User_java_lang_Integer_: - -.. _SyncConfiguration_defaultConfig_User__java_lang_Integer_: - -.. _SyncConfiguration_defaultConfig_User_Integer_: - -.. _SyncConfiguration_defaultConfig_User__Integer_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `Integer `__ partitionValue - | ) - - - - - * - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - **Returns** - - the default configuration for the given user and partition value. - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_java_lang_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__java_lang_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_Long_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__Long_: - -.. _defaultConfig_io_realm_mongodb_User_java_lang_Long_: - -.. _defaultConfig_io_realm_mongodb_User__java_lang_Long_: - -.. _defaultConfig_io_realm_mongodb_User_Long_: - -.. _defaultConfig_io_realm_mongodb_User__Long_: - -.. _defaultConfig_User_java_lang_Long_: - -.. _defaultConfig_User__java_lang_Long_: - -.. _defaultConfig_User_Long_: - -.. _defaultConfig_User__Long_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_Long_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_Long_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_Long_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__Long_: - -.. _SyncConfiguration_defaultConfig_User_java_lang_Long_: - -.. _SyncConfiguration_defaultConfig_User__java_lang_Long_: - -.. _SyncConfiguration_defaultConfig_User_Long_: - -.. _SyncConfiguration_defaultConfig_User__Long_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `Long `__ partitionValue - | ) - - - - - * - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - **Returns** - - the default configuration for the given user and partition value. - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User__String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User__String_: - -.. _defaultConfig_io_realm_mongodb_User_java_lang_String_: - -.. _defaultConfig_io_realm_mongodb_User__java_lang_String_: - -.. _defaultConfig_io_realm_mongodb_User_String_: - -.. _defaultConfig_io_realm_mongodb_User__String_: - -.. _defaultConfig_User_java_lang_String_: - -.. _defaultConfig_User__java_lang_String_: - -.. _defaultConfig_User_String_: - -.. _defaultConfig_User__String_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_java_lang_String_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__java_lang_String_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_String_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User__String_: - -.. _SyncConfiguration_defaultConfig_User_java_lang_String_: - -.. _SyncConfiguration_defaultConfig_User__java_lang_String_: - -.. _SyncConfiguration_defaultConfig_User_String_: - -.. _SyncConfiguration_defaultConfig_User__String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( - | :ref:`User ` user, - | `String `__ partitionValue - | ) - - - - - * - Returns a default Partition-based Sync configuration for the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - **Returns** - - the default configuration for the given user and partition value. - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_io_realm_mongodb_User_: - -.. _io_realm_mongodb_sync_SyncConfiguration_defaultConfig_User_: - -.. _defaultConfig_io_realm_mongodb_User_: - -.. _defaultConfig_User_: - -.. _SyncConfiguration_defaultConfig_io_realm_mongodb_User_: - -.. _SyncConfiguration_defaultConfig_User_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncConfiguration ` :ref:`defaultConfig ` ( - | :ref:`User ` user - | ) - - - - - * - Returns a default Flexible Sync configuration for the given user. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - - - - **Returns** - - the default Flexible Sync configuration for the given user. - - - - - - - - - .. seealso:: - - - - - **{\@link SubscriptionSet} for more information about Flexible Sync.** - - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _SyncConfiguration_equals: - -.. _SyncConfiguration_equals__: - -.. _io_realm_mongodb_sync_SyncConfiguration_equals: - -.. _io_realm_mongodb_sync_SyncConfiguration_equals__: - - - -equals ------- - -.. _io_realm_mongodb_sync_SyncConfiguration_equals_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _SyncConfiguration_equals_java_lang_Object_: - -.. _SyncConfiguration_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class :ref:`RealmConfiguration ` - - - - - - -.. _forRecovery: - -.. _forRecovery__: - -.. _SyncConfiguration_forRecovery: - -.. _SyncConfiguration_forRecovery__: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery__: - - - -forRecovery ------------ - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_: - -.. _forRecovery_java_lang_String_: - -.. _forRecovery_String_: - -.. _SyncConfiguration_forRecovery_java_lang_String_: - -.. _SyncConfiguration_forRecovery_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath - | ) - - - - - * - Returns a :ref:`RealmConfiguration ` appropriate to open a read-only, non-synced Realm to recover any pending changes. This is useful when trying to open a backup/recovery Realm (after a client reset). Note: This will use the default Realm module (composed of all :ref:`RealmModel ` ), and assume no encryption should be used as well. - - - - - - - **Parameters** - - - ``canonicalPath`` - the absolute path to the Realm file defined by this configuration. - - - - - - - - **Returns** - - RealmConfiguration that can be used offline - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte__java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte__Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte_Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte__Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte____java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte_____java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte____Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte_____Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String_byte____Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_java_lang_String__byte_____Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte__java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte__Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte_Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte__Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte____java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte_____java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte____Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte_____Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String_byte____Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte_____Object____: - -.. _forRecovery_java_lang_String_byte_java_lang_Object_: - -.. _forRecovery_java_lang_String__byte__java_lang_Object_: - -.. _forRecovery_java_lang_String_byte_Object_: - -.. _forRecovery_java_lang_String__byte__Object_: - -.. _forRecovery_java_lang_String_byte_Object____: - -.. _forRecovery_java_lang_String__byte__Object____: - -.. _forRecovery_java_lang_String_byte____java_lang_Object_: - -.. _forRecovery_java_lang_String__byte_____java_lang_Object_: - -.. _forRecovery_java_lang_String_byte____Object_: - -.. _forRecovery_java_lang_String__byte_____Object_: - -.. _forRecovery_java_lang_String_byte____Object____: - -.. _forRecovery_java_lang_String__byte_____Object____: - -.. _forRecovery_String_byte_java_lang_Object_: - -.. _forRecovery_String__byte__java_lang_Object_: - -.. _forRecovery_String_byte_Object_: - -.. _forRecovery_String__byte__Object_: - -.. _forRecovery_String_byte_Object____: - -.. _forRecovery_String__byte__Object____: - -.. _forRecovery_String_byte____java_lang_Object_: - -.. _forRecovery_String__byte_____java_lang_Object_: - -.. _forRecovery_String_byte____Object_: - -.. _forRecovery_String__byte_____Object_: - -.. _forRecovery_String_byte____Object____: - -.. _forRecovery_String__byte_____Object____: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte_java_lang_Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte__java_lang_Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte_Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte__Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte_Object____: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte__Object____: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte____java_lang_Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte_____java_lang_Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte____Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte_____Object_: - -.. _SyncConfiguration_forRecovery_java_lang_String_byte____Object____: - -.. _SyncConfiguration_forRecovery_java_lang_String__byte_____Object____: - -.. _SyncConfiguration_forRecovery_String_byte_java_lang_Object_: - -.. _SyncConfiguration_forRecovery_String__byte__java_lang_Object_: - -.. _SyncConfiguration_forRecovery_String_byte_Object_: - -.. _SyncConfiguration_forRecovery_String__byte__Object_: - -.. _SyncConfiguration_forRecovery_String_byte_Object____: - -.. _SyncConfiguration_forRecovery_String__byte__Object____: - -.. _SyncConfiguration_forRecovery_String_byte____java_lang_Object_: - -.. _SyncConfiguration_forRecovery_String__byte_____java_lang_Object_: - -.. _SyncConfiguration_forRecovery_String_byte____Object_: - -.. _SyncConfiguration_forRecovery_String__byte_____Object_: - -.. _SyncConfiguration_forRecovery_String_byte____Object____: - -.. _SyncConfiguration_forRecovery_String__byte_____Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_forRecovery_String__byte[]__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`RealmConfiguration ` :ref:`forRecovery ` ( - | `String `__ canonicalPath, - | **byte[]** encryptionKey, - | `java.lang.Object[] `__ modules - | ) - - - - - * - Returns a :ref:`RealmConfiguration ` appropriate to open a read-only, non-synced Realm to recover any pending changes. This is useful when trying to open a backup/recovery Realm (after a client reset). - - - - - - - **Parameters** - - - ``canonicalPath`` - the absolute path to the Realm file defined by this configuration. - - - - - ``encryptionKey`` - the key used to encrypt/decrypt the Realm file. - - - - - ``modules`` - if specified it will restricts Realm schema to the provided module. - - - - - - - - **Returns** - - RealmConfiguration that can be used offline - - - - - - - - - - - -.. _getClientResetHandler: - -.. _getClientResetHandler__: - -.. _SyncConfiguration_getClientResetHandler: - -.. _SyncConfiguration_getClientResetHandler__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getClientResetHandler: - -.. _io_realm_mongodb_sync_SyncConfiguration_getClientResetHandler__: - - - -getClientResetHandler ---------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncSession.ClientResetHandler ` :ref:`getClientResetHandler ` () - | - - - - - * - Returns the Client Reset handler for this *SyncConfiguration*. - - - - - - - **Returns** - - the Client Reset handler. - - - - - - - - - - - -.. _getErrorHandler: - -.. _getErrorHandler__: - -.. _SyncConfiguration_getErrorHandler: - -.. _SyncConfiguration_getErrorHandler__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getErrorHandler: - -.. _io_realm_mongodb_sync_SyncConfiguration_getErrorHandler__: - - - -getErrorHandler ---------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncSession.ErrorHandler ` :ref:`getErrorHandler ` () - | - - - - - * - Returns the error handler for this *SyncConfiguration*. - - - - - - - **Returns** - - the error handler. - - - - - - - - - - - -.. _getInitialDataTransaction: - -.. _getInitialDataTransaction__: - -.. _SyncConfiguration_getInitialDataTransaction: - -.. _SyncConfiguration_getInitialDataTransaction__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialDataTransaction: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialDataTransaction__: - - - -getInitialDataTransaction -------------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected :ref:`Realm.Transaction ` :ref:`getInitialDataTransaction ` () - | - - - - - * - Returns the transaction instance with initial data. - - - - - - - **Returns** - - the initial data transaction. - - - - - - - **Overrides** - - ``getInitialDataTransaction`` in class :ref:`RealmConfiguration ` - - - - - - -.. _getInitialRemoteDataTimeout: - -.. _getInitialRemoteDataTimeout__: - -.. _SyncConfiguration_getInitialRemoteDataTimeout: - -.. _SyncConfiguration_getInitialRemoteDataTimeout__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialRemoteDataTimeout: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialRemoteDataTimeout__: - - - -getInitialRemoteDataTimeout ---------------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialRemoteDataTimeout_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialRemoteDataTimeout_TimeUnit_: - -.. _getInitialRemoteDataTimeout_java_util_concurrent_TimeUnit_: - -.. _getInitialRemoteDataTimeout_TimeUnit_: - -.. _SyncConfiguration_getInitialRemoteDataTimeout_java_util_concurrent_TimeUnit_: - -.. _SyncConfiguration_getInitialRemoteDataTimeout_TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public **long** :ref:`getInitialRemoteDataTimeout ` ( - | `TimeUnit `__ unit - | ) - - - - - * - Returns the timeout defined when downloading any initial data the first time the Realm is opened.This value is only applicable if :ref:`shouldWaitForInitialRemoteData() ` returns ``true`` . - - - - - - - - - - - **Returns** - - the time Realm will wait for all changes to be downloaded before it is aborted and an exception is thrown. - - - - - - - - - .. seealso:: - - - - - :ref:`SyncConfiguration.Builder.waitForInitialRemoteData(long, TimeUnit) ` - - - - - - - - - - - - -.. _getInitialSubscriptionsHandler: - -.. _getInitialSubscriptionsHandler__: - -.. _SyncConfiguration_getInitialSubscriptionsHandler: - -.. _SyncConfiguration_getInitialSubscriptionsHandler__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialSubscriptionsHandler: - -.. _io_realm_mongodb_sync_SyncConfiguration_getInitialSubscriptionsHandler__: - - - -getInitialSubscriptionsHandler ------------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` :ref:`getInitialSubscriptionsHandler ` () - | - - - - - * - Returns the configured initial subscription handler for this realm. - - - - - - - **Returns** - - the handler used to configure initial subscriptions for this realm. - - - - - - - - - - - -.. _getPartitionValue: - -.. _getPartitionValue__: - -.. _SyncConfiguration_getPartitionValue: - -.. _SyncConfiguration_getPartitionValue__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getPartitionValue: - -.. _io_realm_mongodb_sync_SyncConfiguration_getPartitionValue__: - - - -getPartitionValue ------------------ - -.. list-table:: - :header-rows: 1 - - * - | public **BsonValue** :ref:`getPartitionValue ` () - | - - - - - * - Returns the value this Realm is partitioned on. The partition key is a property defined in MongoDB Realm. All classes with a property with this value will be synchronized to the Realm. - - - - - - - **Returns** - - the value being used by MongoDB Realm to partition the server side MongoDB Database into Realms that can be synchronized independently. - - - - - **Throws** - - - `IllegalStateException `__ - if this configuration is for a realm configured for flexible sync. You can use :ref:`isPartitionBasedSyncConfiguration() ` before calling this method to check. - - - - - - - - - - - - - - -.. _getServerUrl: - -.. _getServerUrl__: - -.. _SyncConfiguration_getServerUrl: - -.. _SyncConfiguration_getServerUrl__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getServerUrl: - -.. _io_realm_mongodb_sync_SyncConfiguration_getServerUrl__: - - - -getServerUrl ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `URI `__ :ref:`getServerUrl ` () - | - - - - - * - Returns the server URI for the remote MongoDB Realm the local Realm is synchronizing with. - - - - - - - **Returns** - - `URI `__ identifying the MongoDB Realm this local Realm is synchronized with. - - - - - - - - - - - - - -.. _getSessionStopPolicy: - -.. _getSessionStopPolicy__: - -.. _SyncConfiguration_getSessionStopPolicy: - -.. _SyncConfiguration_getSessionStopPolicy__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getSessionStopPolicy: - -.. _io_realm_mongodb_sync_SyncConfiguration_getSessionStopPolicy__: - - - -getSessionStopPolicy --------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **OsRealmConfig.SyncSessionStopPolicy** :ref:`getSessionStopPolicy ` () - | - - - - - * - NOTE: Only for internal usage. May change without warning. Returns the stop policy for the session for this Realm once the Realm has been closed. - - - - - - - **Returns** - - the stop policy used by the session once the Realm is closed. - - - - - - - - - - - -.. _getSyncClientResetStrategy: - -.. _getSyncClientResetStrategy__: - -.. _SyncConfiguration_getSyncClientResetStrategy: - -.. _SyncConfiguration_getSyncClientResetStrategy__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getSyncClientResetStrategy: - -.. _io_realm_mongodb_sync_SyncConfiguration_getSyncClientResetStrategy__: - - - -getSyncClientResetStrategy --------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncClientResetStrategy ` :ref:`getSyncClientResetStrategy ` () - | - - - - - * - Returns the sync client reset strategy for this *SyncConfiguration*. - - - - - - - **Returns** - - the sync client reset strategy. - - - - - - - - - - - -.. _getUrlPrefix: - -.. _getUrlPrefix__: - -.. _SyncConfiguration_getUrlPrefix: - -.. _SyncConfiguration_getUrlPrefix__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getUrlPrefix: - -.. _io_realm_mongodb_sync_SyncConfiguration_getUrlPrefix__: - - - -getUrlPrefix ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`getUrlPrefix ` () - | - - - - - * - Returns the url prefix used when establishing a sync connection to the Realm Object Server. - - - - - - - - - - - - - - - -.. _getUser: - -.. _getUser__: - -.. _SyncConfiguration_getUser: - -.. _SyncConfiguration_getUser__: - -.. _io_realm_mongodb_sync_SyncConfiguration_getUser: - -.. _io_realm_mongodb_sync_SyncConfiguration_getUser__: - - - -getUser -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`getUser ` () - | - - - - - * - Returns the user. - - - - - - - **Returns** - - the user. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _SyncConfiguration_hashCode: - -.. _SyncConfiguration_hashCode__: - -.. _io_realm_mongodb_sync_SyncConfiguration_hashCode: - -.. _io_realm_mongodb_sync_SyncConfiguration_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class :ref:`RealmConfiguration ` - - - - - - -.. _isFlexibleSyncConfiguration: - -.. _isFlexibleSyncConfiguration__: - -.. _SyncConfiguration_isFlexibleSyncConfiguration: - -.. _SyncConfiguration_isFlexibleSyncConfiguration__: - -.. _io_realm_mongodb_sync_SyncConfiguration_isFlexibleSyncConfiguration: - -.. _io_realm_mongodb_sync_SyncConfiguration_isFlexibleSyncConfiguration__: - - - -isFlexibleSyncConfiguration ---------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isFlexibleSyncConfiguration ` () - | - - - - - * - Returns whether or not this configuration is for opening a Realm configured for Flexible Sync. - - - - - - - **Returns** - - ``true`` if this configuration is for a Flexible Sync Realm, ``false`` if not. - - - - - - - - - - - - - -.. _isPartitionBasedSyncConfiguration: - -.. _isPartitionBasedSyncConfiguration__: - -.. _SyncConfiguration_isPartitionBasedSyncConfiguration: - -.. _SyncConfiguration_isPartitionBasedSyncConfiguration__: - -.. _io_realm_mongodb_sync_SyncConfiguration_isPartitionBasedSyncConfiguration: - -.. _io_realm_mongodb_sync_SyncConfiguration_isPartitionBasedSyncConfiguration__: - - - -isPartitionBasedSyncConfiguration ---------------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isPartitionBasedSyncConfiguration ` () - | - - - - - * - Returns whether or not this configuration is for opening a Realm configured for Partition-based Sync. - - - - - - - **Returns** - - ``true`` if this configuration is for a Partition-based Sync Realm, ``false`` if not. - - - - - - - - - - - - - -.. _isSyncConfiguration: - -.. _isSyncConfiguration__: - -.. _SyncConfiguration_isSyncConfiguration: - -.. _SyncConfiguration_isSyncConfiguration__: - -.. _io_realm_mongodb_sync_SyncConfiguration_isSyncConfiguration: - -.. _io_realm_mongodb_sync_SyncConfiguration_isSyncConfiguration__: - - - -isSyncConfiguration -------------------- - -.. list-table:: - :header-rows: 1 - - * - | protected **boolean** :ref:`isSyncConfiguration ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``isSyncConfiguration`` in class :ref:`RealmConfiguration ` - - - - - - -.. _realmExists: - -.. _realmExists__: - -.. _SyncConfiguration_realmExists: - -.. _SyncConfiguration_realmExists__: - -.. _io_realm_mongodb_sync_SyncConfiguration_realmExists: - -.. _io_realm_mongodb_sync_SyncConfiguration_realmExists__: - - - -realmExists ------------ - -.. list-table:: - :header-rows: 1 - - * - | protected **boolean** :ref:`realmExists ` () - | - - - - - * - Checks if the Realm file defined by this configuration already exists.WARNING: This method is just a point-in-time check. Unless protected by external synchronization another thread or process might have created or deleted the Realm file right after this method has returned. - - - - - - - - - **Returns** - - ``true`` if the Realm file exists, ``false`` otherwise. - - - - - - - - - **Overrides** - - ``realmExists`` in class :ref:`RealmConfiguration ` - - - - - - -.. _shouldDeleteRealmOnLogout: - -.. _shouldDeleteRealmOnLogout__: - -.. _SyncConfiguration_shouldDeleteRealmOnLogout: - -.. _SyncConfiguration_shouldDeleteRealmOnLogout__: - -.. _io_realm_mongodb_sync_SyncConfiguration_shouldDeleteRealmOnLogout: - -.. _io_realm_mongodb_sync_SyncConfiguration_shouldDeleteRealmOnLogout__: - - - -shouldDeleteRealmOnLogout -------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`shouldDeleteRealmOnLogout ` () - | - - - - - * - Returns ``true`` if the Realm file must be deleted once the :ref:`User ` owning it logs out. - - - - - - - - - **Returns** - - ``true`` if the Realm file must be deleted if the :ref:`User ` logs out. ``false`` if the file is allowed to remain behind. - - - - - - - - - - - - - -.. _shouldWaitForInitialRemoteData: - -.. _shouldWaitForInitialRemoteData__: - -.. _SyncConfiguration_shouldWaitForInitialRemoteData: - -.. _SyncConfiguration_shouldWaitForInitialRemoteData__: - -.. _io_realm_mongodb_sync_SyncConfiguration_shouldWaitForInitialRemoteData: - -.. _io_realm_mongodb_sync_SyncConfiguration_shouldWaitForInitialRemoteData__: - - - -shouldWaitForInitialRemoteData ------------------------------- - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`shouldWaitForInitialRemoteData ` () - | - - - - - * - Returns ``true`` if the Realm will download all known changes from the remote server before being opened the first time. - - - - - - - - - **Returns** - - ``true`` if all remote changes will be downloaded before the Realm can be opened. ``false`` if the Realm can be opened immediately. - - - - - - - - - - - - - -.. _toString: - -.. _toString__: - -.. _SyncConfiguration_toString: - -.. _SyncConfiguration_toString__: - -.. _io_realm_mongodb_sync_SyncConfiguration_toString: - -.. _io_realm_mongodb_sync_SyncConfiguration_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class :ref:`RealmConfiguration ` - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt deleted file mode 100644 index c48a0bf3aa..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/Builder.txt +++ /dev/null @@ -1,2388 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class SyncConfiguration.Builder -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.sync.SyncConfiguration.Builder - - - - -**Enclosing class:** - -:ref:`SyncConfiguration ` - - - -Builder used to construct instances of a SyncConfiguration in a fluent manner. - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`Builder ` ( - | :ref:`User ` user - | ) - - - Creates an instance of the builder for a Flexible Sync *SyncConfiguration* with the given user. - - - - - * - | :ref:`Builder ` ( - | :ref:`User ` user, - | `String `__ partitionValue - | ) - - - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. - - - - - * - | :ref:`Builder ` ( - | :ref:`User ` user, - | **ObjectId** partitionValue - | ) - - - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`addModule ` ( - | `Object `__ module - | ) - - - Adds a module to the already defined modules. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`allowQueriesOnUiThread ` ( - | **boolean** allowQueriesOnUiThread - | ) - - - Sets whether or not ``RealmQueries`` are allowed from the UI thread. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`allowWritesOnUiThread ` ( - | **boolean** allowWritesOnUiThread - | ) - - - Sets whether or not calls to :ref:`Realm.executeTransaction ` are allowed from the UI thread. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`assetFile ` ( - | `String `__ assetFile - | ) - - - When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided asset file and used instead. - - - - - * - public :ref:`SyncConfiguration ` - - | :ref:`build ` () - | - - - Creates the RealmConfiguration based on the builder parameters. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`clientResetHandler ` ( - | :ref:`SyncSession.ClientResetHandler ` handler - | ) - - - Sets the handler for when a Client Reset occurs. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`compactOnLaunch ` ( - | :ref:`CompactOnLaunchCallback ` compactOnLaunch - | ) - - - Sets this to determine if the Realm file should be compacted before returned to the user. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`compactOnLaunch ` () - | - - - Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - Sets the io.realm.Realm#ENCRYPTION_KEY_LENGTH bytes key used to encrypt and decrypt the Realm file. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`errorHandler ` ( - | :ref:`SyncSession.ErrorHandler ` errorHandler - | ) - - - Sets the error handler used by this configuration. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`flowFactory ` ( - | :ref:`FlowFactory ` factory - | ) - - - Sets the :ref:`FlowFactory ` used to create coroutines Flows from Realm objects. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`inMemory ` () - | - - - Setting this will create an in-memory Realm instead of saving it to disk. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`initialData ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - Sets the initial data in :ref:`io.realm.Realm ` . - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`initialSubscriptions ` ( - | :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` action - | ) - - - Sets the initial :ref:`Subscription ` s for the :ref:`io.realm.Realm ` . - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`maxNumberOfActiveVersions ` ( - | **long** number - | ) - - - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`modules ` ( - | `java.lang.Iterable\ `__ modules - | ) - - - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules - | ) - - - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`name ` ( - | `String `__ filename - | ) - - - Sets the filename for the Realm file on this device. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`readOnly ` () - | - - - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`rxFactory ` ( - | :ref:`RxObservableFactory ` factory - | ) - - - Sets the :ref:`RxObservableFactory ` used to create Rx Observables from Realm objects. - - - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`schemaVersion ` ( - | **long** schemaVersion - | ) - - - Sets the schema version of the Realm. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`syncClientResetStrategy ` ( - | :ref:`DiscardUnsyncedChangesStrategy ` handler - | ) - - - Sets the handler for when a Client Reset occurs. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`syncClientResetStrategy ` ( - | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` handler - | ) - - - Sets the handler for when a Client Reset occurs. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`urlPrefix ` ( - | `String `__ urlPrefix - | ) - - - The prefix that is prepended to the path in the WebSocket request that initiates a sync connection to MongoDB Realm. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`waitForInitialRemoteData ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. - - - - - * - public :ref:`SyncConfiguration.Builder ` - - | :ref:`waitForInitialRemoteData ` () - | - - - Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _Builder: - -.. _Builder__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Builder ` ( - | :ref:`User ` user - | ) - - - - - * - Creates an instance of the builder for a Flexible Sync *SyncConfiguration* with the given user. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - - - - - - .. seealso:: - - - - - **{\@link SubscriptionSet} for more information about Flexible Sync.** - - - - - - - - - - - - -.. _Builder: - -.. _Builder__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Builder ` ( - | :ref:`User ` user, - | `String `__ partitionValue - | ) - - - - - * - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - - - - - -.. _Builder: - -.. _Builder__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`Builder ` ( - | :ref:`User ` user, - | **ObjectId** partitionValue - | ) - - - - - * - Creates an instance of the builder for a Partition-based Sync *SyncConfiguration* with the given user and partition value. - - - - - **Parameters** - - - ``user`` - The user that will be used for accessing the Realm App. - - - - - ``partitionValue`` - The partition value identifying the remote Realm that will be synchronized. - - - - - - - - - - - - - - -Method Detail -============= - -.. _addModule: - -.. _addModule__: - -.. _Builder_addModule: - -.. _Builder_addModule__: - -.. _SyncConfiguration_Builder_addModule: - -.. _SyncConfiguration_Builder_addModule__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_addModule: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_addModule__: - - - -addModule ---------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_addModule_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_addModule_Object_: - -.. _addModule_java_lang_Object_: - -.. _addModule_Object_: - -.. _SyncConfiguration_Builder_addModule_java_lang_Object_: - -.. _SyncConfiguration_Builder_addModule_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`addModule ` ( - | `Object `__ module - | ) - - - - - * - Adds a module to the already defined modules. - - - - - - - - - - - - - - - -.. _allowQueriesOnUiThread: - -.. _allowQueriesOnUiThread__: - -.. _Builder_allowQueriesOnUiThread: - -.. _Builder_allowQueriesOnUiThread__: - -.. _SyncConfiguration_Builder_allowQueriesOnUiThread: - -.. _SyncConfiguration_Builder_allowQueriesOnUiThread__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowQueriesOnUiThread: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowQueriesOnUiThread__: - - - -allowQueriesOnUiThread ----------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowQueriesOnUiThread_boolean_: - -.. _allowQueriesOnUiThread_boolean_: - -.. _SyncConfiguration_Builder_allowQueriesOnUiThread_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`allowQueriesOnUiThread ` ( - | **boolean** allowQueriesOnUiThread - | ) - - - - - * - Sets whether or not ``RealmQueries`` are allowed from the UI thread. - - By default Realm allows queries on the main thread. However, by doing so your application may experience a drop of frames or even ANRs. We recommend diverting queries to non-UI threads or, alternatively, using :ref:`RealmQuery.findAllAsync() ` or :ref:`RealmQuery.findFirstAsync() ` . - - - - - - - - - - - - - - - - - - - -.. _allowWritesOnUiThread: - -.. _allowWritesOnUiThread__: - -.. _Builder_allowWritesOnUiThread: - -.. _Builder_allowWritesOnUiThread__: - -.. _SyncConfiguration_Builder_allowWritesOnUiThread: - -.. _SyncConfiguration_Builder_allowWritesOnUiThread__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowWritesOnUiThread: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowWritesOnUiThread__: - - - -allowWritesOnUiThread ---------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_allowWritesOnUiThread_boolean_: - -.. _allowWritesOnUiThread_boolean_: - -.. _SyncConfiguration_Builder_allowWritesOnUiThread_boolean_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`allowWritesOnUiThread ` ( - | **boolean** allowWritesOnUiThread - | ) - - - - - * - Sets whether or not calls to :ref:`Realm.executeTransaction ` are allowed from the UI thread. - - **WARNING: Realm does not allow synchronous transactions to be run on the main thread unless users explicitly opt in with this method.** We recommend diverting calls to ``executeTransaction`` to non-UI threads or, alternatively, using :ref:`Realm.executeTransactionAsync ` . - - - - - - - - - - - - - - - - - - - -.. _assetFile: - -.. _assetFile__: - -.. _Builder_assetFile: - -.. _Builder_assetFile__: - -.. _SyncConfiguration_Builder_assetFile: - -.. _SyncConfiguration_Builder_assetFile__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile__: - - - -assetFile ---------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_assetFile_String_: - -.. _assetFile_java_lang_String_: - -.. _assetFile_String_: - -.. _SyncConfiguration_Builder_assetFile_java_lang_String_: - -.. _SyncConfiguration_Builder_assetFile_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`assetFile ` ( - | `String `__ assetFile - | ) - - - - - * - When opening the Realm for the first time, instead of creating an empty file, the Realm file will be copied from the provided asset file and used instead.This can be used to pre-populate the Realm with data, so it doesn't have to be downloaded from the server. - - The provided Realm file must be a valid synced Realm for the given user, and it must have been created using the **Realm.writeCopyTo(File)** API. - - - - WARNING: This could potentially be a lengthy operation and should ideally be done on a background thread. - - - - - - - **Parameters** - - - ``assetFile`` - path to the asset database file. - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if this Realm is also marked as :ref:`inMemory() ` . - - - - - - - - - - - - - - -.. _build: - -.. _build__: - -.. _Builder_build: - -.. _Builder_build__: - -.. _SyncConfiguration_Builder_build: - -.. _SyncConfiguration_Builder_build__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_build: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_build__: - - - -build ------ - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration ` :ref:`build ` () - | - - - - - * - Creates the RealmConfiguration based on the builder parameters. - - - - - - - **Returns** - - the created :ref:`SyncConfiguration ` . - - - - - - - **Throws** - - - `IllegalStateException `__ - if the configuration parameters are invalid or inconsistent. - - - - - - - - - - - - -.. _clientResetHandler: - -.. _clientResetHandler__: - -.. _Builder_clientResetHandler: - -.. _Builder_clientResetHandler__: - -.. _SyncConfiguration_Builder_clientResetHandler: - -.. _SyncConfiguration_Builder_clientResetHandler__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_clientResetHandler: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_clientResetHandler__: - - - -clientResetHandler ------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_clientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_clientResetHandler_ClientResetHandler_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_clientResetHandler_SyncSession_ClientResetHandler_: - -.. _clientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _clientResetHandler_ClientResetHandler_: - -.. _clientResetHandler_SyncSession_ClientResetHandler_: - -.. _SyncConfiguration_Builder_clientResetHandler_io_realm_mongodb_sync_SyncSession_ClientResetHandler_: - -.. _SyncConfiguration_Builder_clientResetHandler_ClientResetHandler_: - -.. _SyncConfiguration_Builder_clientResetHandler_SyncSession_ClientResetHandler_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`clientResetHandler ` ( - | :ref:`SyncSession.ClientResetHandler ` handler - | ) - - - - - * - Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. - - - - - **Parameters** - - - ``handler`` - custom handler in case of a Client Reset. - - - - - - - - - - - - - - - - -.. _compactOnLaunch: - -.. _compactOnLaunch__: - -.. _Builder_compactOnLaunch: - -.. _Builder_compactOnLaunch__: - -.. _SyncConfiguration_Builder_compactOnLaunch: - -.. _SyncConfiguration_Builder_compactOnLaunch__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_compactOnLaunch: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_compactOnLaunch__: - - - -compactOnLaunch ---------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_compactOnLaunch_CompactOnLaunchCallback_: - -.. _compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _compactOnLaunch_CompactOnLaunchCallback_: - -.. _SyncConfiguration_Builder_compactOnLaunch_io_realm_CompactOnLaunchCallback_: - -.. _SyncConfiguration_Builder_compactOnLaunch_CompactOnLaunchCallback_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`compactOnLaunch ` ( - | :ref:`CompactOnLaunchCallback ` compactOnLaunch - | ) - - - - - * - Sets this to determine if the Realm file should be compacted before returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - **Parameters** - - - ``compactOnLaunch`` - a callback called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the bytes used by data in the file. - - - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`compactOnLaunch ` () - | - - - - - * - Setting this will cause Realm to compact the Realm file if the Realm file has grown too large and a significant amount of space can be recovered. See :ref:`DefaultCompactOnLaunchCallback ` for details. - - - - - - - - - - - - - - - - - -.. _encryptionKey: - -.. _encryptionKey__: - -.. _Builder_encryptionKey: - -.. _Builder_encryptionKey__: - -.. _SyncConfiguration_Builder_encryptionKey: - -.. _SyncConfiguration_Builder_encryptionKey__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_encryptionKey: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_encryptionKey__: - - - -encryptionKey -------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_encryptionKey_byte_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_encryptionKey_byte____: - -.. _encryptionKey_byte_: - -.. _encryptionKey_byte____: - -.. _SyncConfiguration_Builder_encryptionKey_byte_: - -.. _SyncConfiguration_Builder_encryptionKey_byte____: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_encryptionKey_byte[]_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`encryptionKey ` ( - | **byte[]** key - | ) - - - - - * - Sets the io.realm.Realm#ENCRYPTION_KEY_LENGTH bytes key used to encrypt and decrypt the Realm file. - - - - - - - **Parameters** - - - ``key`` - the encryption key. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if key is invalid. - - - - - - - - - - - - -.. _errorHandler: - -.. _errorHandler__: - -.. _Builder_errorHandler: - -.. _Builder_errorHandler__: - -.. _SyncConfiguration_Builder_errorHandler: - -.. _SyncConfiguration_Builder_errorHandler__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_errorHandler: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_errorHandler__: - - - -errorHandler ------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_errorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_errorHandler_ErrorHandler_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_errorHandler_SyncSession_ErrorHandler_: - -.. _errorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _errorHandler_ErrorHandler_: - -.. _errorHandler_SyncSession_ErrorHandler_: - -.. _SyncConfiguration_Builder_errorHandler_io_realm_mongodb_sync_SyncSession_ErrorHandler_: - -.. _SyncConfiguration_Builder_errorHandler_ErrorHandler_: - -.. _SyncConfiguration_Builder_errorHandler_SyncSession_ErrorHandler_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`errorHandler ` ( - | :ref:`SyncSession.ErrorHandler ` errorHandler - | ) - - - - - * - Sets the error handler used by this configuration.Only errors not handled by the defined ``SyncPolicy`` will be reported to this error handler. - - - - - - - - - **Parameters** - - - ``errorHandler`` - error handler used to report back errors when communicating with the Realm Object Server. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if ``null`` is given as an error handler. - - - - - - - - - - - - - - -.. _flowFactory: - -.. _flowFactory__: - -.. _Builder_flowFactory: - -.. _Builder_flowFactory__: - -.. _SyncConfiguration_Builder_flowFactory: - -.. _SyncConfiguration_Builder_flowFactory__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_flowFactory: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_flowFactory__: - - - -flowFactory ------------ - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_flowFactory_io_realm_coroutines_FlowFactory_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_flowFactory_FlowFactory_: - -.. _flowFactory_io_realm_coroutines_FlowFactory_: - -.. _flowFactory_FlowFactory_: - -.. _SyncConfiguration_Builder_flowFactory_io_realm_coroutines_FlowFactory_: - -.. _SyncConfiguration_Builder_flowFactory_FlowFactory_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`flowFactory ` ( - | :ref:`FlowFactory ` factory - | ) - - - - - * - Sets the :ref:`FlowFactory ` used to create coroutines Flows from Realm objects. The default factory is :ref:`RealmFlowFactory ` . - - - - - - - **Parameters** - - - ``factory`` - factory to use. - - - - - - - - - - - - - - - - -.. _inMemory: - -.. _inMemory__: - -.. _Builder_inMemory: - -.. _Builder_inMemory__: - -.. _SyncConfiguration_Builder_inMemory: - -.. _SyncConfiguration_Builder_inMemory__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_inMemory: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_inMemory__: - - - -inMemory --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`inMemory ` () - | - - - - - * - Setting this will create an in-memory Realm instead of saving it to disk. In-memory Realms might still use disk space if memory is running low, but all files created by an in-memory Realm will be deleted when the Realm is closed.Note that because in-memory Realms are not persisted, you must be sure to hold on to at least one non-closed reference to the in-memory Realm object with the specific name as long as you want the data to last. - - - - - - - - - - - - - - - - - -.. _initialData: - -.. _initialData__: - -.. _Builder_initialData: - -.. _Builder_initialData__: - -.. _SyncConfiguration_Builder_initialData: - -.. _SyncConfiguration_Builder_initialData__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialData: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialData__: - - - -initialData ------------ - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialData_io_realm_Realm_Transaction_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialData_Transaction_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialData_Realm_Transaction_: - -.. _initialData_io_realm_Realm_Transaction_: - -.. _initialData_Transaction_: - -.. _initialData_Realm_Transaction_: - -.. _SyncConfiguration_Builder_initialData_io_realm_Realm_Transaction_: - -.. _SyncConfiguration_Builder_initialData_Transaction_: - -.. _SyncConfiguration_Builder_initialData_Realm_Transaction_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`initialData ` ( - | :ref:`Realm.Transaction ` transaction - | ) - - - - - * - Sets the initial data in :ref:`io.realm.Realm ` . This transaction will be executed only the first time the Realm file is opened (created) or while migrating the data if :ref:`RealmConfiguration.Builder.deleteRealmIfMigrationNeeded() ` is set. - - - - - - - **Parameters** - - - ``transaction`` - transaction to execute. - - - - - - - - - - - - - - - - -.. _initialSubscriptions: - -.. _initialSubscriptions__: - -.. _Builder_initialSubscriptions: - -.. _Builder_initialSubscriptions__: - -.. _SyncConfiguration_Builder_initialSubscriptions: - -.. _SyncConfiguration_Builder_initialSubscriptions__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions__: - - - -initialSubscriptions --------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_InitialFlexibleSyncSubscriptions_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. _initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. _initialSubscriptions_InitialFlexibleSyncSubscriptions_: - -.. _initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. _SyncConfiguration_Builder_initialSubscriptions_io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. _SyncConfiguration_Builder_initialSubscriptions_InitialFlexibleSyncSubscriptions_: - -.. _SyncConfiguration_Builder_initialSubscriptions_SyncConfiguration_InitialFlexibleSyncSubscriptions_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`initialSubscriptions ` ( - | :ref:`SyncConfiguration.InitialFlexibleSyncSubscriptions ` action - | ) - - - - - * - Sets the initial :ref:`Subscription ` s for the :ref:`io.realm.Realm ` . This will only be executed the first time the Realm file is opened (and the file created). If :ref:`waitForInitialRemoteData() ` is configured as well, the realm file isn't fully opened until all subscription data also has been uploaded. - - - - - - - **Parameters** - - - ``action`` - :ref:`MutableSubscriptionSet ` where subscriptions can be added. - - - - - - - - - - - - - - - - - - -.. _maxNumberOfActiveVersions: - -.. _maxNumberOfActiveVersions__: - -.. _Builder_maxNumberOfActiveVersions: - -.. _Builder_maxNumberOfActiveVersions__: - -.. _SyncConfiguration_Builder_maxNumberOfActiveVersions: - -.. _SyncConfiguration_Builder_maxNumberOfActiveVersions__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_maxNumberOfActiveVersions: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_maxNumberOfActiveVersions__: - - - -maxNumberOfActiveVersions -------------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_maxNumberOfActiveVersions_long_: - -.. _maxNumberOfActiveVersions_long_: - -.. _SyncConfiguration_Builder_maxNumberOfActiveVersions_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`maxNumberOfActiveVersions ` ( - | **long** number - | ) - - - - - * - Sets the maximum number of live versions in the Realm file before an `IllegalStateException `__ is thrown when attempting to write more data. - - Realm is capable of concurrently handling many different versions of Realm objects. This can happen if you have a Realm open on many different threads or are freezing objects while data is being written to the file. - - Under normal circumstances this is not a problem, but if the number of active versions grow too large, it will have a negative effect on the filesize on disk. Setting this parameters can therefore be used to prevent uses of Realm that can result in very large Realms. - - Note, the version number will also increase when changes from other devices are integrated on this device, so the number of active versions will also depend on what other devices writing to the same Realm are doing. - - - - - - - **Parameters** - - - ``number`` - the maximum number of active versions before an exception is thrown. - - - - - - - - - - - - - - .. seealso:: - - - - - `FAQ `__ - - - - - - - - - - - - - -.. _modules: - -.. _modules__: - -.. _Builder_modules: - -.. _Builder_modules__: - -.. _SyncConfiguration_Builder_modules: - -.. _SyncConfiguration_Builder_modules__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules__: - - - -modules -------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Iterable_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Iterable_: - -.. _modules_java_lang_Iterable_: - -.. _modules_Iterable_: - -.. _SyncConfiguration_Builder_modules_java_lang_Iterable_: - -.. _SyncConfiguration_Builder_modules_Iterable_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Iterable_Object__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`modules ` ( - | `java.lang.Iterable\ `__ modules - | ) - - - - - * - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. Using this method will replace the current schema for this Realm with the schema defined by the provided modules. - - A reference to the default Realm module containing all Realm classes in the project (but not dependencies), can be found using :ref:`Realm.getDefaultModule() ` . Combining the schema from the app project and a library dependency is thus done using the following code: - - - - ``builder.modules(Realm.getDefaultMode(), new MyLibraryModule());`` - - - - - - - - - **Parameters** - - - ``modules`` - list of modules tthe first Realm module (required). - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Realm.getDefaultModule() ` - - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object__java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object__Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object_Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_java_lang_Object__Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object_java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object__java_lang_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object_Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object__Object_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object_Object____: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_modules_Object__Object____: - -.. _modules_java_lang_Object_java_lang_Object_: - -.. _modules_java_lang_Object__java_lang_Object_: - -.. _modules_java_lang_Object_Object_: - -.. _modules_java_lang_Object__Object_: - -.. _modules_java_lang_Object_Object____: - -.. _modules_java_lang_Object__Object____: - -.. _modules_Object_java_lang_Object_: - -.. _modules_Object__java_lang_Object_: - -.. _modules_Object_Object_: - -.. _modules_Object__Object_: - -.. _modules_Object_Object____: - -.. _modules_Object__Object____: - -.. _SyncConfiguration_Builder_modules_java_lang_Object_java_lang_Object_: - -.. _SyncConfiguration_Builder_modules_java_lang_Object__java_lang_Object_: - -.. _SyncConfiguration_Builder_modules_java_lang_Object_Object_: - -.. _SyncConfiguration_Builder_modules_java_lang_Object__Object_: - -.. _SyncConfiguration_Builder_modules_java_lang_Object_Object____: - -.. _SyncConfiguration_Builder_modules_java_lang_Object__Object____: - -.. _SyncConfiguration_Builder_modules_Object_java_lang_Object_: - -.. _SyncConfiguration_Builder_modules_Object__java_lang_Object_: - -.. _SyncConfiguration_Builder_modules_Object_Object_: - -.. _SyncConfiguration_Builder_modules_Object__Object_: - -.. _SyncConfiguration_Builder_modules_Object_Object____: - -.. _SyncConfiguration_Builder_modules_Object__Object____: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`modules ` ( - | `Object `__ baseModule, - | `java.lang.Object[] `__ additionalModules - | ) - - - - - * - Replaces the existing module(s) with one or more :ref:`RealmModule ` s. Using this method will replace the current schema for this Realm with the schema defined by the provided modules. - - A reference to the default Realm module containing all Realm classes in the project (but not dependencies), can be found using :ref:`Realm.getDefaultModule() ` . Combining the schema from the app project and a library dependency is thus done using the following code: - - - - ``builder.modules(Realm.getDefaultMode(), new MyLibraryModule());`` - - - - - - - - - **Parameters** - - - ``baseModule`` - the first Realm module (required). - - - - - ``additionalModules`` - the additional Realm modules - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if any of the modules don't have the :ref:`RealmModule ` annotation. - - - - - - - - - - - - .. seealso:: - - - - - :ref:`Realm.getDefaultModule() ` - - - - - - - - - - - - -.. _name: - -.. _name__: - -.. _Builder_name: - -.. _Builder_name__: - -.. _SyncConfiguration_Builder_name: - -.. _SyncConfiguration_Builder_name__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name__: - - - -name ----- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_name_String_: - -.. _name_java_lang_String_: - -.. _name_String_: - -.. _SyncConfiguration_Builder_name_java_lang_String_: - -.. _SyncConfiguration_Builder_name_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`name ` ( - | `String `__ filename - | ) - - - - - * - Sets the filename for the Realm file on this device. - - - - - **Parameters** - - - ``filename`` - name for the Realm file. - - - - - - - - - - - - - - - - -.. _readOnly: - -.. _readOnly__: - -.. _Builder_readOnly: - -.. _Builder_readOnly__: - -.. _SyncConfiguration_Builder_readOnly: - -.. _SyncConfiguration_Builder_readOnly__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_readOnly: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_readOnly__: - - - -readOnly --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`readOnly ` () - | - - - - - * - Setting this will cause the Realm to become read only and all write transactions made against this Realm will fail with an `IllegalStateException `__ . - - This in particular mean that :ref:`initialData(Realm.Transaction) ` will not work in combination with a read only Realm and setting this will result in a `IllegalStateException `__ being thrown. - - - - Marking a Realm as read only only applies to the Realm in this process. Other processes and devices can still write to the Realm. - - - - - - - - - - - - - - - -.. _rxFactory: - -.. _rxFactory__: - -.. _Builder_rxFactory: - -.. _Builder_rxFactory__: - -.. _SyncConfiguration_Builder_rxFactory: - -.. _SyncConfiguration_Builder_rxFactory__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_rxFactory: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_rxFactory__: - - - -rxFactory ---------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_rxFactory_io_realm_rx_RxObservableFactory_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_rxFactory_RxObservableFactory_: - -.. _rxFactory_io_realm_rx_RxObservableFactory_: - -.. _rxFactory_RxObservableFactory_: - -.. _SyncConfiguration_Builder_rxFactory_io_realm_rx_RxObservableFactory_: - -.. _SyncConfiguration_Builder_rxFactory_RxObservableFactory_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`rxFactory ` ( - | :ref:`RxObservableFactory ` factory - | ) - - - - - * - Sets the :ref:`RxObservableFactory ` used to create Rx Observables from Realm objects. The default factory is :ref:`RealmObservableFactory ` . - - - - - - - **Parameters** - - - ``factory`` - factory to use. - - - - - - - - - - - - - - - - -.. _schemaVersion: - -.. _schemaVersion__: - -.. _Builder_schemaVersion: - -.. _Builder_schemaVersion__: - -.. _SyncConfiguration_Builder_schemaVersion: - -.. _SyncConfiguration_Builder_schemaVersion__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_schemaVersion: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_schemaVersion__: - - - -schemaVersion -------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_schemaVersion_long_: - -.. _schemaVersion_long_: - -.. _SyncConfiguration_Builder_schemaVersion_long_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`schemaVersion ` ( - | **long** schemaVersion - | ) - - - - - * - Sets the schema version of the Realm.Synced Realms only support additive schema changes which can be applied without requiring a manual migration. The schema version will only be used as an indication to the underlying storage layer to remove or add indexes. These will be recalculated if the provided schema version differ from the version in the Realm file. **WARNING:** There is no guarantee that the value inserted here is the same returned by **Realm.getVersion()**. Due to the nature of synced Realms, the value can both be higher and lower. - - - - - - - It will be lower if another client with a lesser ``schemaVersion`` connected to the server for the first time after this schemaVersion was used. - - - - - - It will be higher if another client with a higher ``schemaVersion`` connected to the server after this Realm was created. - - - - - - - - - - - - **Parameters** - - - ``schemaVersion`` - the schema version. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if schema version is invalid. - - - - - - - - - - - - -.. _syncClientResetStrategy: - -.. _syncClientResetStrategy__: - -.. _Builder_syncClientResetStrategy: - -.. _Builder_syncClientResetStrategy__: - -.. _SyncConfiguration_Builder_syncClientResetStrategy: - -.. _SyncConfiguration_Builder_syncClientResetStrategy__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy__: - - - -syncClientResetStrategy ------------------------ - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. _syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. _SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_DiscardUnsyncedChangesStrategy_: - -.. _SyncConfiguration_Builder_syncClientResetStrategy_DiscardUnsyncedChangesStrategy_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`syncClientResetStrategy ` ( - | :ref:`DiscardUnsyncedChangesStrategy ` handler - | ) - - - - - * - Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. This strategy is only available for synced realms using partition based sync. Realms using flexible sync currently only support :ref:`syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ` . - - - - - - - **Parameters** - - - ``handler`` - custom seamless loss handler in case of a Client Reset. - - - - - - - - - - - - - - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _SyncConfiguration_Builder_syncClientResetStrategy_io_realm_mongodb_sync_ManuallyRecoverUnsyncedChangesStrategy_: - -.. _SyncConfiguration_Builder_syncClientResetStrategy_ManuallyRecoverUnsyncedChangesStrategy_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`syncClientResetStrategy ` ( - | :ref:`ManuallyRecoverUnsyncedChangesStrategy ` handler - | ) - - - - - * - Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. - - - - - **Parameters** - - - ``handler`` - custom manual handler in case of a Client Reset. - - - - - - - - - - - - - - - - -.. _urlPrefix: - -.. _urlPrefix__: - -.. _Builder_urlPrefix: - -.. _Builder_urlPrefix__: - -.. _SyncConfiguration_Builder_urlPrefix: - -.. _SyncConfiguration_Builder_urlPrefix__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_urlPrefix: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_urlPrefix__: - - - -urlPrefix ---------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_urlPrefix_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_urlPrefix_String_: - -.. _urlPrefix_java_lang_String_: - -.. _urlPrefix_String_: - -.. _SyncConfiguration_Builder_urlPrefix_java_lang_String_: - -.. _SyncConfiguration_Builder_urlPrefix_String_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`urlPrefix ` ( - | `String `__ urlPrefix - | ) - - - - - * - The prefix that is prepended to the path in the WebSocket request that initiates a sync connection to MongoDB Realm. The value specified must match the server’s configuration otherwise the device will not be able to create a connection. This value is optional and should only be set if a specific firewall rule requires it. - - - - - **Parameters** - - - ``urlPrefix`` - The prefix to append to the sync connection url. - - - - - - - - - - - - - - - - -.. _waitForInitialRemoteData: - -.. _waitForInitialRemoteData__: - -.. _Builder_waitForInitialRemoteData: - -.. _Builder_waitForInitialRemoteData__: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData__: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData__: - - - -waitForInitialRemoteData ------------------------- - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData_long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData_long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData_long_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncConfiguration_Builder_waitForInitialRemoteData_long__TimeUnit_: - -.. _waitForInitialRemoteData_long_java_util_concurrent_TimeUnit_: - -.. _waitForInitialRemoteData_long__java_util_concurrent_TimeUnit_: - -.. _waitForInitialRemoteData_long_TimeUnit_: - -.. _waitForInitialRemoteData_long__TimeUnit_: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData_long_java_util_concurrent_TimeUnit_: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData_long__java_util_concurrent_TimeUnit_: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData_long_TimeUnit_: - -.. _SyncConfiguration_Builder_waitForInitialRemoteData_long__TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`waitForInitialRemoteData ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - - - * - Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. The Realm will not open until all the data has been downloaded. This means that if a device is offline the Realm will not open.Since downloading all changes can be an lengthy operation that might block the UI thread, Realms with this setting enabled should only be opened on background threads or with :ref:`Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) ` on the UI thread. - - - - This check is only enforced the first time a Realm is created. If you otherwise want to make sure a Realm has the latest changes, use :ref:`SyncSession.downloadAllServerChanges() ` . - - - - - - - - - **Parameters** - - - ``timeout`` - how long to wait for the download to complete before an :ref:`io.realm.exceptions.DownloadingRealmInterruptedException ` is thrown. - - - - - - - ``unit`` - the unit of time used to define the timeout. - - - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration.Builder ` :ref:`waitForInitialRemoteData ` () - | - - - - - * - Setting this will cause the Realm to download all known changes from the server the first time a Realm is opened. The Realm will not open until all the data has been downloaded. This means that if a device is offline the Realm will not open.Since downloading all changes can be an lengthy operation that might block the UI thread, Realms with this setting enabled should only be opened on background threads or with :ref:`Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) ` on the UI thread. - - - - This check is only enforced the first time a Realm is created. If you otherwise want to make sure a Realm has the latest changes, use :ref:`SyncSession.downloadAllServerChanges() ` . - - - - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt deleted file mode 100644 index 498300e3e2..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncConfiguration/InitialFlexibleSyncSubscriptions.txt +++ /dev/null @@ -1,171 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SyncConfiguration.InitialFlexibleSyncSubscriptions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions: - - - -io.realm.mongodb.sync -===================== - - - -**Enclosing class:** - -:ref:`SyncConfiguration ` - - - -Interface for configuring the initial set of of subscriptions. This should only be used for synced realms configured for flexible sync. - - -.. seealso:: - - - - - :ref:`Builder.initialSubscriptions(SyncConfiguration.InitialFlexibleSyncSubscriptions) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`configure ` ( - | :ref:`Realm ` realm, - | :ref:`MutableSubscriptionSet ` subscriptions - | ) - - - - - - - - - - -Method Detail -============= - -.. _configure: - -.. _configure__: - -.. _InitialFlexibleSyncSubscriptions_configure: - -.. _InitialFlexibleSyncSubscriptions_configure__: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure__: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure__: - - - -configure ---------- - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_MutableSubscriptionSet_: - -.. _io_realm_mongodb_sync_SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__MutableSubscriptionSet_: - -.. _configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _configure_io_realm_Realm_MutableSubscriptionSet_: - -.. _configure_io_realm_Realm__MutableSubscriptionSet_: - -.. _configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _configure_Realm_MutableSubscriptionSet_: - -.. _configure_Realm__MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_io_realm_Realm__MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__io_realm_mongodb_sync_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm_MutableSubscriptionSet_: - -.. _SyncConfiguration_InitialFlexibleSyncSubscriptions_configure_Realm__MutableSubscriptionSet_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`configure ` ( - | :ref:`Realm ` realm, - | :ref:`MutableSubscriptionSet ` subscriptions - | ) - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt deleted file mode 100644 index 44ace5361f..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession.txt +++ /dev/null @@ -1,1456 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class SyncSession -^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncSession: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | io.realm.mongodb.sync.SyncSession - - -A session controls how data is synchronized between a single Realm on the device and the server Realm on the Realm Object Server.A Session is created by opening a Realm instance using a :ref:`SyncConfiguration ` . Once a session has been created, it will continue to exist until the app is closed or all threads using this :ref:`SyncConfiguration ` closes their respective :ref:`Realm ` s. - - - -A session is controlled by Realm, but can provide additional information in case of errors. These errors are passed along in the :ref:`SyncSession.ErrorHandler ` . - - - -When creating a session, Realm will establish a connection to the server. This connection is controlled by Realm and might be shared between multiple sessions. It is possible to get insight into the connection using :ref:`addConnectionChangeListener(ConnectionListener) ` and :ref:`isConnected() ` . - - - -The session itself has a different lifecycle than the underlying connection. The state of the session can be found using :ref:`getState() ` . - - - -The :ref:`SyncSession ` object is thread safe. - - - - - - -Nested Class Summary -==================== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Class and Description - - * - ``public static final`` - - :ref:`SyncSession.State ` - - - * - ``public static interface`` - - :ref:`SyncSession.ErrorHandler ` - - - * - ``public static interface`` - - :ref:`SyncSession.ClientResetHandler ` - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public synchronized **void** - - | :ref:`addConnectionChangeListener ` ( - | :ref:`ConnectionListener ` listener - | ) - - - Adds a listener tracking changes to the connection backing this session. - - - - - * - public synchronized **void** - - | :ref:`addDownloadProgressListener ` ( - | :ref:`ProgressMode ` mode, - | :ref:`ProgressListener ` listener - | ) - - - Adds a progress listener tracking changes that need to be downloaded from the Realm Object Server. - - - - - * - public synchronized **void** - - | :ref:`addUploadProgressListener ` ( - | :ref:`ProgressMode ` mode, - | :ref:`ProgressListener ` listener - | ) - - - Adds a progress listener tracking changes that need to be uploaded from the device to the Realm Object Server. - - - - - * - public **boolean** - - | :ref:`downloadAllServerChanges ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - Calling this method will block until all known remote changes have been downloaded and applied to the Realm or the specified timeout is hit. - - - - - * - public **void** - - | :ref:`downloadAllServerChanges ` () - | - - - Calling this method will block until all known remote changes have been downloaded and applied to the Realm. - - - - - * - public :ref:`SyncConfiguration ` - - | :ref:`getConfiguration ` () - | - - - Returns the :ref:`SyncConfiguration ` that is responsible for controlling the session. - - - - - - - * - public :ref:`ConnectionState ` - - | :ref:`getConnectionState ` () - | - - - Get the current state of the connection used by the session as defined in :ref:`ConnectionState ` . - - - - - - - * - public `URI `__ - - | :ref:`getServerUrl ` () - | - - - Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. - - - - - - - * - public :ref:`SyncSession.State ` - - | :ref:`getState ` () - | - - - Get the current session's state, as defined in :ref:`SyncSession.State ` . - - - - - - - * - public :ref:`User ` - - | :ref:`getUser ` () - | - - - Returns the :ref:`User ` defined by the :ref:`SyncConfiguration ` that is used to connect to MongoDB Realm. - - - - - - - * - public **boolean** - - | :ref:`isConnected ` () - | - - - Checks if the session is connected to the server and can synchronize data. - - - - - * - public synchronized **void** - - | :ref:`removeConnectionChangeListener ` ( - | :ref:`ConnectionListener ` listener - | ) - - - Removes a previously registered :ref:`ConnectionListener ` . - - - - - - - * - public synchronized **void** - - | :ref:`removeProgressListener ` ( - | :ref:`ProgressListener ` listener - | ) - - - Removes a progress listener. - - - - - * - public synchronized **void** - - | :ref:`start ` () - | - - - Attempts to start the session and enable synchronization with the Realm Object Server. - - - - - * - public synchronized **void** - - | :ref:`stop ` () - | - - - Stops any synchronization with the Realm Object Server until the Realm is re-opened again after fully closing it. - - - - - * - public **boolean** - - | :ref:`uploadAllLocalChanges ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - Calling this method will block until all known local changes have been uploaded to the server or the specified timeout is hit. - - - - - * - public **void** - - | :ref:`uploadAllLocalChanges ` () - | - - - Calling this method will block until all known local changes have been uploaded to the server. - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Method Detail -============= - -.. _addConnectionChangeListener: - -.. _addConnectionChangeListener__: - -.. _SyncSession_addConnectionChangeListener: - -.. _SyncSession_addConnectionChangeListener__: - -.. _io_realm_mongodb_sync_SyncSession_addConnectionChangeListener: - -.. _io_realm_mongodb_sync_SyncSession_addConnectionChangeListener__: - - - -addConnectionChangeListener ---------------------------- - -.. _io_realm_mongodb_sync_SyncSession_addConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _io_realm_mongodb_sync_SyncSession_addConnectionChangeListener_ConnectionListener_: - -.. _addConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _addConnectionChangeListener_ConnectionListener_: - -.. _SyncSession_addConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _SyncSession_addConnectionChangeListener_ConnectionListener_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`addConnectionChangeListener ` ( - | :ref:`ConnectionListener ` listener - | ) - - - - - * - Adds a listener tracking changes to the connection backing this session. See :ref:`ConnectionState ` for further details. - - - - - - - **Parameters** - - - ``listener`` - the listener to register. - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the listener is ``null`` . - - - - - - - - - - - - .. seealso:: - - - - - :ref:`ConnectionState ` - - - - - - - - - - - - -.. _addDownloadProgressListener: - -.. _addDownloadProgressListener__: - -.. _SyncSession_addDownloadProgressListener: - -.. _SyncSession_addDownloadProgressListener__: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener__: - - - -addDownloadProgressListener ---------------------------- - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_ProgressMode_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addDownloadProgressListener_ProgressMode__ProgressListener_: - -.. _addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _addDownloadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _addDownloadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _addDownloadProgressListener_ProgressMode_ProgressListener_: - -.. _addDownloadProgressListener_ProgressMode__ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_ProgressMode_ProgressListener_: - -.. _SyncSession_addDownloadProgressListener_ProgressMode__ProgressListener_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`addDownloadProgressListener ` ( - | :ref:`ProgressMode ` mode, - | :ref:`ProgressListener ` listener - | ) - - - - - * - Adds a progress listener tracking changes that need to be downloaded from the Realm Object Server.The :ref:`ProgressListener ` will be triggered immediately when registered, and periodically afterwards. - - - - - - - - - **Parameters** - - - ``mode`` - type of mode used. See :ref:`ProgressMode ` for more information. - - - - - - - ``listener`` - the listener to register. - - - - - - - - - - - - - - - - -.. _addUploadProgressListener: - -.. _addUploadProgressListener__: - -.. _SyncSession_addUploadProgressListener: - -.. _SyncSession_addUploadProgressListener__: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener__: - - - -addUploadProgressListener -------------------------- - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_ProgressMode_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_addUploadProgressListener_ProgressMode__ProgressListener_: - -.. _addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _addUploadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _addUploadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _addUploadProgressListener_ProgressMode_ProgressListener_: - -.. _addUploadProgressListener_ProgressMode__ProgressListener_: - -.. _SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_io_realm_mongodb_sync_ProgressMode__ProgressListener_: - -.. _SyncSession_addUploadProgressListener_ProgressMode_io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_ProgressMode__io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_ProgressMode_ProgressListener_: - -.. _SyncSession_addUploadProgressListener_ProgressMode__ProgressListener_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`addUploadProgressListener ` ( - | :ref:`ProgressMode ` mode, - | :ref:`ProgressListener ` listener - | ) - - - - - * - Adds a progress listener tracking changes that need to be uploaded from the device to the Realm Object Server.The :ref:`ProgressListener ` will be triggered immediately when registered, and periodically afterwards. - - - - - - - - - **Parameters** - - - ``mode`` - type of mode used. See :ref:`ProgressMode ` for more information. - - - - - - - ``listener`` - the listener to register. - - - - - - - - - - - - - - - - -.. _downloadAllServerChanges: - -.. _downloadAllServerChanges__: - -.. _SyncSession_downloadAllServerChanges: - -.. _SyncSession_downloadAllServerChanges__: - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges: - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges__: - - - -downloadAllServerChanges ------------------------- - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges_long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges_long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges_long_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_downloadAllServerChanges_long__TimeUnit_: - -.. _downloadAllServerChanges_long_java_util_concurrent_TimeUnit_: - -.. _downloadAllServerChanges_long__java_util_concurrent_TimeUnit_: - -.. _downloadAllServerChanges_long_TimeUnit_: - -.. _downloadAllServerChanges_long__TimeUnit_: - -.. _SyncSession_downloadAllServerChanges_long_java_util_concurrent_TimeUnit_: - -.. _SyncSession_downloadAllServerChanges_long__java_util_concurrent_TimeUnit_: - -.. _SyncSession_downloadAllServerChanges_long_TimeUnit_: - -.. _SyncSession_downloadAllServerChanges_long__TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`downloadAllServerChanges ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - - - * - Calling this method will block until all known remote changes have been downloaded and applied to the Realm or the specified timeout is hit. This will involve network access, so calling this method should only be done from a non-UI thread.This method cannot be called before the Realm has been opened. - - - - - - - - - **Returns** - - ``true`` if the data was downloaded before the timeout. ``false`` if the operation timed out or otherwise failed. - - - - - - - **Throws** - - - `IllegalStateException `__ - if called on the Android main thread. - - - - - `InterruptedException `__ - if the download took longer than the specified timeout or the thread was interrupted while downloading was in progress. The download will continue in the background even after this exception is thrown. - - - - - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`downloadAllServerChanges ` () - | - - - - - * - Calling this method will block until all known remote changes have been downloaded and applied to the Realm. This will involve network access, so calling this method should only be done from a non-UI thread.If the device is offline, this method might never return. - - This method cannot be called before the session has been started. - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called on the Android main thread. - - - - - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. - - - - - - - - - - - - -.. _getConfiguration: - -.. _getConfiguration__: - -.. _SyncSession_getConfiguration: - -.. _SyncSession_getConfiguration__: - -.. _io_realm_mongodb_sync_SyncSession_getConfiguration: - -.. _io_realm_mongodb_sync_SyncSession_getConfiguration__: - - - -getConfiguration ----------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncConfiguration ` :ref:`getConfiguration ` () - | - - - - - * - Returns the :ref:`SyncConfiguration ` that is responsible for controlling the session. - - - - - - - - - **Returns** - - SyncConfiguration that defines and controls this session. - - - - - - - - - - - -.. _getConnectionState: - -.. _getConnectionState__: - -.. _SyncSession_getConnectionState: - -.. _SyncSession_getConnectionState__: - -.. _io_realm_mongodb_sync_SyncSession_getConnectionState: - -.. _io_realm_mongodb_sync_SyncSession_getConnectionState__: - - - -getConnectionState ------------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ConnectionState ` :ref:`getConnectionState ` () - | - - - - - * - Get the current state of the connection used by the session as defined in :ref:`ConnectionState ` . - - - - - - - - - **Returns** - - the state of connection used by the session. - - - - - - - - - .. seealso:: - - - - - :ref:`ConnectionState ` - - - - - - - - - - - - -.. _getServerUrl: - -.. _getServerUrl__: - -.. _SyncSession_getServerUrl: - -.. _SyncSession_getServerUrl__: - -.. _io_realm_mongodb_sync_SyncSession_getServerUrl: - -.. _io_realm_mongodb_sync_SyncSession_getServerUrl__: - - - -getServerUrl ------------- - -.. list-table:: - :header-rows: 1 - - * - | public `URI `__ :ref:`getServerUrl ` () - | - - - - - * - Returns the `URI `__ describing the remote Realm which this session connects to and synchronizes changes with. - - - - - - - - - **Returns** - - `URI `__ describing the remote Realm. - - - - - - - - - - - - - -.. _getState: - -.. _getState__: - -.. _SyncSession_getState: - -.. _SyncSession_getState__: - -.. _io_realm_mongodb_sync_SyncSession_getState: - -.. _io_realm_mongodb_sync_SyncSession_getState__: - - - -getState --------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`SyncSession.State ` :ref:`getState ` () - | - - - - - * - Get the current session's state, as defined in :ref:`SyncSession.State ` . - - Note that the state may change after this method returns. - - - - - - - - - **Returns** - - the state of the session. - - - - - - - - - .. seealso:: - - - - - :ref:`SyncSession.State ` - - - - - - - - - - - - -.. _getUser: - -.. _getUser__: - -.. _SyncSession_getUser: - -.. _SyncSession_getUser__: - -.. _io_realm_mongodb_sync_SyncSession_getUser: - -.. _io_realm_mongodb_sync_SyncSession_getUser__: - - - -getUser -------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`User ` :ref:`getUser ` () - | - - - - - * - Returns the :ref:`User ` defined by the :ref:`SyncConfiguration ` that is used to connect to MongoDB Realm. - - - - - - - - - **Returns** - - :ref:`User ` used to authenticate the session on MongoDB Realm. - - - - - - - - - - - - - -.. _isConnected: - -.. _isConnected__: - -.. _SyncSession_isConnected: - -.. _SyncSession_isConnected__: - -.. _io_realm_mongodb_sync_SyncSession_isConnected: - -.. _io_realm_mongodb_sync_SyncSession_isConnected__: - - - -isConnected ------------ - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`isConnected ` () - | - - - - - * - Checks if the session is connected to the server and can synchronize data. This is a best guess effort. To conserve battery the underlying implementation uses heartbeats to detect if the connection is still available. So if no data is actively being synced and some time has elapsed since the last heartbeat, the connection could have been dropped but this method will still return ``true`` . - - - - - - - - - **Returns** - - ``true`` if the session is connected and ready to synchronize data, ``false`` if not or if it is in the process of connecting. - - - - - - - - - - - - - -.. _removeConnectionChangeListener: - -.. _removeConnectionChangeListener__: - -.. _SyncSession_removeConnectionChangeListener: - -.. _SyncSession_removeConnectionChangeListener__: - -.. _io_realm_mongodb_sync_SyncSession_removeConnectionChangeListener: - -.. _io_realm_mongodb_sync_SyncSession_removeConnectionChangeListener__: - - - -removeConnectionChangeListener ------------------------------- - -.. _io_realm_mongodb_sync_SyncSession_removeConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _io_realm_mongodb_sync_SyncSession_removeConnectionChangeListener_ConnectionListener_: - -.. _removeConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _removeConnectionChangeListener_ConnectionListener_: - -.. _SyncSession_removeConnectionChangeListener_io_realm_mongodb_sync_ConnectionListener_: - -.. _SyncSession_removeConnectionChangeListener_ConnectionListener_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`removeConnectionChangeListener ` ( - | :ref:`ConnectionListener ` listener - | ) - - - - - * - Removes a previously registered :ref:`ConnectionListener ` . - - - - - - - **Parameters** - - - ``listener`` - listener to remove - - - - - - - - - - **Throws** - - - `IllegalArgumentException `__ - if the listener is ``null`` . - - - - - - - - - - - - - - -.. _removeProgressListener: - -.. _removeProgressListener__: - -.. _SyncSession_removeProgressListener: - -.. _SyncSession_removeProgressListener__: - -.. _io_realm_mongodb_sync_SyncSession_removeProgressListener: - -.. _io_realm_mongodb_sync_SyncSession_removeProgressListener__: - - - -removeProgressListener ----------------------- - -.. _io_realm_mongodb_sync_SyncSession_removeProgressListener_io_realm_mongodb_sync_ProgressListener_: - -.. _io_realm_mongodb_sync_SyncSession_removeProgressListener_ProgressListener_: - -.. _removeProgressListener_io_realm_mongodb_sync_ProgressListener_: - -.. _removeProgressListener_ProgressListener_: - -.. _SyncSession_removeProgressListener_io_realm_mongodb_sync_ProgressListener_: - -.. _SyncSession_removeProgressListener_ProgressListener_: - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`removeProgressListener ` ( - | :ref:`ProgressListener ` listener - | ) - - - - - * - Removes a progress listener. If the listener wasn't registered, this method will do nothing. - - - - - **Parameters** - - - ``listener`` - listener to remove. - - - - - - - - - - - - - - - - -.. _start: - -.. _start__: - -.. _SyncSession_start: - -.. _SyncSession_start__: - -.. _io_realm_mongodb_sync_SyncSession_start: - -.. _io_realm_mongodb_sync_SyncSession_start__: - - - -start ------ - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`start ` () - | - - - - - * - Attempts to start the session and enable synchronization with the Realm Object Server.This happens automatically when opening the Realm instance, so doing it manually should only be needed if the session was stopped using :ref:`stop() ` . - - - - If the session was already started, calling this method will do nothing. - - A session is considered started if :ref:`getState() ` returns :ref:`State.ACTIVE ` . If the session is :ref:`State.DYING ` , the session will be moved back to :ref:`State.ACTIVE ` . - - - - - - - - - - - - - - - - - .. seealso:: - - - - - :ref:`getState() ` - - - - - :ref:`stop() ` - - - - - - - - - - - - -.. _stop: - -.. _stop__: - -.. _SyncSession_stop: - -.. _SyncSession_stop__: - -.. _io_realm_mongodb_sync_SyncSession_stop: - -.. _io_realm_mongodb_sync_SyncSession_stop__: - - - -stop ----- - -.. list-table:: - :header-rows: 1 - - * - | public synchronized **void** :ref:`stop ` () - | - - - - - * - Stops any synchronization with the Realm Object Server until the Realm is re-opened again after fully closing it.Synchronization can be re-enabled by calling :ref:`start() ` again. - - - - If the session is already stopped, calling this method will do nothing. - - - - - - - - - - - - - - - - - -.. _uploadAllLocalChanges: - -.. _uploadAllLocalChanges__: - -.. _SyncSession_uploadAllLocalChanges: - -.. _SyncSession_uploadAllLocalChanges__: - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges: - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges__: - - - -uploadAllLocalChanges ---------------------- - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges_long_java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges_long__java_util_concurrent_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges_long_TimeUnit_: - -.. _io_realm_mongodb_sync_SyncSession_uploadAllLocalChanges_long__TimeUnit_: - -.. _uploadAllLocalChanges_long_java_util_concurrent_TimeUnit_: - -.. _uploadAllLocalChanges_long__java_util_concurrent_TimeUnit_: - -.. _uploadAllLocalChanges_long_TimeUnit_: - -.. _uploadAllLocalChanges_long__TimeUnit_: - -.. _SyncSession_uploadAllLocalChanges_long_java_util_concurrent_TimeUnit_: - -.. _SyncSession_uploadAllLocalChanges_long__java_util_concurrent_TimeUnit_: - -.. _SyncSession_uploadAllLocalChanges_long_TimeUnit_: - -.. _SyncSession_uploadAllLocalChanges_long__TimeUnit_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`uploadAllLocalChanges ` ( - | **long** timeout, - | `TimeUnit `__ unit - | ) - - - - - * - Calling this method will block until all known local changes have been uploaded to the server or the specified timeout is hit. This will involve network access, so calling this method should only be done from a non-UI thread.This method cannot be called before the Realm has been opened. - - - - - - - - - **Returns** - - ``true`` if the data was uploaded before the timeout. ``false`` if the operation timed out or otherwise failed. - - - - - - - **Throws** - - - `IllegalStateException `__ - if called on the Android main thread. - - - - - `InterruptedException `__ - if the upload took longer than the specified timeout or the thread was interrupted while uploading was in progress. The upload will continue in the background even after this exception is thrown. - - - - - `IllegalArgumentException `__ - if ``timeout`` is less than or equal to ``0`` or ``unit`` is ``null`` . - - - - - - - - - - - - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`uploadAllLocalChanges ` () - | - - - - - * - Calling this method will block until all known local changes have been uploaded to the server. This will involve network access, so calling this method should only be done from a non-UI thread.If the device is offline, this method might never return. - - This method cannot be called before the Realm has been opened. - - - - - - - - - - - **Throws** - - - `IllegalStateException `__ - if called on the Android main thread. - - - - - `InterruptedException `__ - if the thread was interrupted while downloading was in progress. - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt deleted file mode 100644 index b931c916fc..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ClientResetHandler.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SyncSession.ClientResetHandler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncSession_ClientResetHandler: - - - -io.realm.mongodb.sync -===================== - -**Implemented interfaces:** - - - -- :ref:`io.realm.mongodb.sync.ManuallyRecoverUnsyncedChangesStrategy ` -- :ref:`io.realm.mongodb.sync.SyncClientResetStrategy ` - - - - -**Enclosing class:** - -:ref:`SyncSession ` - - - -Callback for the specific error event known as a Client Reset, determined by the error code :ref:`ErrorCode.CLIENT_RESET ` . - -A synced Realm may need to be reset because the MongoDB Realm Server encountered an error and had to be restored from a backup or because it has been too long since the client connected to the server so the server has rotated the logs. - -The Client Reset thus occurs because the server does not have the full information required to bring the Client fully up to date. - -The reset process is as follows: the local copy of the Realm is copied into a recovery directory for safekeeping, and then deleted from the original location. The next time the Realm for that URL is opened, the Realm will automatically be re-downloaded from MongoDB Realm, and can be used as normal. - -Data written to the Realm after the local copy of the Realm diverged from the backup remote copy will be present in the local recovery copy of the Realm file. The re-downloaded Realm will initially contain only the data present at the time the Realm was backed up on the server. - -The client reset process can be initiated in one of two ways: - - - -1. Run :ref:`ClientResetRequiredError.executeClientReset() ` manually. All Realm instances must be closed before this method is called. - - - - -#. If Client Reset isn't executed manually, it will automatically be carried out the next time all Realm instances have been closed and re-opened. This will most likely be when the app is restarted. - - - - -**WARNING:** Any writes to the Realm file between this callback and Client Reset has been executed, will not be synchronized to MongoDB Realm. Those changes will only be present in the backed up file. It is therefore recommended to close all open Realm instances as soon as possible. - - -Inherited Methods -================= - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ErrorHandler.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ErrorHandler.txt deleted file mode 100644 index 7c9327c650..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/ErrorHandler.txt +++ /dev/null @@ -1,185 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface SyncSession.ErrorHandler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler: - - - -io.realm.mongodb.sync -===================== - - - -**Enclosing class:** - -:ref:`SyncSession ` - - - -Interface used to report any session errors. - - -.. seealso:: - - - - - :ref:`SyncConfiguration.Builder.errorHandler(ErrorHandler) ` - - - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **void** - - | :ref:`onError ` ( - | :ref:`SyncSession ` session, - | :ref:`AppException ` error - | ) - - - Callback for errors on a session object. - - - - - - - -Method Detail -============= - -.. _onError: - -.. _onError__: - -.. _ErrorHandler_onError: - -.. _ErrorHandler_onError__: - -.. _SyncSession_ErrorHandler_onError: - -.. _SyncSession_ErrorHandler_onError__: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError__: - - - -onError -------- - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession__AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_SyncSession_io_realm_mongodb_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_SyncSession__io_realm_mongodb_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_SyncSession_AppException_: - -.. _io_realm_mongodb_sync_SyncSession_ErrorHandler_onError_SyncSession__AppException_: - -.. _onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_AppException_: - -.. _onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_AppException_: - -.. _onError_io_realm_mongodb_sync_SyncSession_AppException_: - -.. _onError_io_realm_mongodb_sync_SyncSession__AppException_: - -.. _onError_SyncSession_io_realm_mongodb_AppException_: - -.. _onError_SyncSession__io_realm_mongodb_AppException_: - -.. _onError_SyncSession_AppException_: - -.. _onError_SyncSession__AppException_: - -.. _SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession_io_realm_mongodb_AppException_: - -.. _SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession__io_realm_mongodb_AppException_: - -.. _SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession_AppException_: - -.. _SyncSession_ErrorHandler_onError_io_realm_mongodb_sync_SyncSession__AppException_: - -.. _SyncSession_ErrorHandler_onError_SyncSession_io_realm_mongodb_AppException_: - -.. _SyncSession_ErrorHandler_onError_SyncSession__io_realm_mongodb_AppException_: - -.. _SyncSession_ErrorHandler_onError_SyncSession_AppException_: - -.. _SyncSession_ErrorHandler_onError_SyncSession__AppException_: - -.. list-table:: - :header-rows: 1 - - * - | public **void** :ref:`onError ` ( - | :ref:`SyncSession ` session, - | :ref:`AppException ` error - | ) - - - - - * - Callback for errors on a session object. It is not allowed to throw an exception inside an error handler. If the operations in an error handler can throw, it is safer to catch any exception in the error handler. When an exception is thrown in the error handler, the occurrence will be logged and the exception will be ignored. - - - - - **Parameters** - - - ``session`` - :ref:`SyncSession ` this error happened on. - - - - - - - ``error`` - type of error. - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt b/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt deleted file mode 100644 index 1a06bd246b..0000000000 --- a/source/sdk/java/api/io/realm/mongodb/sync/SyncSession/State.txt +++ /dev/null @@ -1,320 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Enum SyncSession.State -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_mongodb_sync_SyncSession_State: - - - -io.realm.mongodb.sync -===================== - - - | `java.lang.Object `__ - | `java.lang.Enum `__ - | io.realm.mongodb.sync.SyncSession.State - - - - -**Enclosing class:** - -:ref:`SyncSession ` - - - -Enum describing the states a SyncSession can be in. The initial state is :ref:`State.INACTIVE ` . - -A Realm will automatically synchronize data with the server if the session is either :ref:`State.ACTIVE ` or :ref:`State.DYING ` and **isConnected()** returns ``true`` . - - - - - - -Enum Constant Summary -===================== - -.. list-table:: - :header-rows: 1 - - * - Enum Constant and Description - - * - :ref:`ACTIVE ` - - The Realm is open and data will be synchronized between the device and the server if the underlying connection is :ref:`ConnectionState.CONNECTED ` . - - - - - - - * - :ref:`DYING ` - - The Realm was closed, but still contains data that needs to be synchronized to the server. - - - - - * - :ref:`INACTIVE ` - - This is the initial state. - - - - - * - :ref:`WAITING_FOR_ACCESS_TOKEN ` - - The user is attempting to synchronize data but needs a valid access token to do so. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public static :ref:`SyncSession.State ` - - | :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - - - - * - public static :ref:`SyncSession.State ` - - | :ref:`values ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` -- Methods inherited from class `java.lang.Enum `__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` - - - - -Enum Constant Detail -==================== - - -.. _io_realm_mongodb_sync_SyncSession_State_ACTIVE: - -.. _SyncSession_State_ACTIVE: - - - -``ACTIVE`` ------------ - -public static final :ref:`SyncSession.State ` - -The Realm is open and data will be synchronized between the device and the server if the underlying connection is :ref:`ConnectionState.CONNECTED ` . - -The session will remain in this state until the Realm is closed. In which case it will become :ref:`DYING ` . - - - - - - - -.. _io_realm_mongodb_sync_SyncSession_State_DYING: - -.. _SyncSession_State_DYING: - - - -``DYING`` ----------- - -public static final :ref:`SyncSession.State ` - -The Realm was closed, but still contains data that needs to be synchronized to the server. The session will attempt to upload all local data before going :ref:`INACTIVE ` . - - - - - -.. _io_realm_mongodb_sync_SyncSession_State_INACTIVE: - -.. _SyncSession_State_INACTIVE: - - - -``INACTIVE`` -------------- - -public static final :ref:`SyncSession.State ` - -This is the initial state. The session is closed. No data is being synchronized. The session will automatically transition to :ref:`ACTIVE ` when a Realm is opened. - - - - - -.. _io_realm_mongodb_sync_SyncSession_State_WAITING_FOR_ACCESS_TOKEN: - -.. _SyncSession_State_WAITING_FOR_ACCESS_TOKEN: - - - -``WAITING_FOR_ACCESS_TOKEN`` ------------------------------ - -public static final :ref:`SyncSession.State ` - -The user is attempting to synchronize data but needs a valid access token to do so. Realm will either use a cached token or automatically try to acquire one based on the current users login. This requires a network connection.Data cannot be synchronized in this state. - -Once a valid token is acquired, the session will transition to :ref:`ACTIVE ` . - - - - - - - - -Method Detail -============= - -.. _valueOf: - -.. _valueOf__: - -.. _State_valueOf: - -.. _State_valueOf__: - -.. _SyncSession_State_valueOf: - -.. _SyncSession_State_valueOf__: - -.. _io_realm_mongodb_sync_SyncSession_State_valueOf: - -.. _io_realm_mongodb_sync_SyncSession_State_valueOf__: - - - -valueOf -------- - -.. _io_realm_mongodb_sync_SyncSession_State_valueOf_java_lang_String_: - -.. _io_realm_mongodb_sync_SyncSession_State_valueOf_String_: - -.. _valueOf_java_lang_String_: - -.. _valueOf_String_: - -.. _SyncSession_State_valueOf_java_lang_String_: - -.. _SyncSession_State_valueOf_String_: - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncSession.State ` :ref:`valueOf ` ( - | `String `__ name - | ) - - - - - * - - - - - - - - - - - - - - - - -.. _values: - -.. _values__: - -.. _State_values: - -.. _State_values__: - -.. _SyncSession_State_values: - -.. _SyncSession_State_values__: - -.. _io_realm_mongodb_sync_SyncSession_State_values: - -.. _io_realm_mongodb_sync_SyncSession_State_values__: - - - -values ------- - -.. list-table:: - :header-rows: 1 - - * - | public static :ref:`SyncSession.State ` :ref:`values ` () - | - - - - - * - - - - - - - - - - - - - - - - - diff --git a/source/sdk/java/api/io/realm/rx.txt b/source/sdk/java/api/io/realm/rx.txt deleted file mode 100644 index 7e690598f3..0000000000 --- a/source/sdk/java/api/io/realm/rx.txt +++ /dev/null @@ -1,36 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -io.realm.rx -^^^^^^^^^^^ - -.. toctree:: - :titlesonly: - :hidden: - - - CollectionChange - ObjectChange - RealmObservableFactory - RxObservableFactory - - - -| - -- :ref:`io.realm.rx.CollectionChange ` -- :ref:`io.realm.rx.ObjectChange ` -- :ref:`io.realm.rx.RealmObservableFactory ` -- :ref:`io.realm.rx.RxObservableFactory ` - - - diff --git a/source/sdk/java/api/io/realm/rx/CollectionChange.txt b/source/sdk/java/api/io/realm/rx/CollectionChange.txt deleted file mode 100644 index e6dc26e2d1..0000000000 --- a/source/sdk/java/api/io/realm/rx/CollectionChange.txt +++ /dev/null @@ -1,394 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class CollectionChange -^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_rx_CollectionChange: - - - -io.realm.rx -=========== - - - | `java.lang.Object `__ - | io.realm.rx.CollectionChange - - -Container wrapping the result of a :ref:`io.realm.OrderedRealmCollectionChangeListener ` being triggered. - -This is used by :ref:`RealmResults.asChangesetObservable() ` } and :ref:`RealmList.asChangesetObservable() ` as RxJava is only capable of emitting one item, not multiple. - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`CollectionChange ` ( - | **E** collection, - | :ref:`OrderedCollectionChangeSet ` changeset - | ) - - - Constructor for a CollectionChange. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public :ref:`OrderedCollectionChangeSet ` - - | :ref:`getChangeset ` () - | - - - Returns the changeset describing the update. - - - - - * - public **E** - - | :ref:`getCollection ` () - | - - - Returns the collection that was updated. - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _CollectionChange: - -.. _CollectionChange__: - -.. _io_realm_rx_CollectionChange: - -.. _io_realm_rx_CollectionChange__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`CollectionChange ` ( - | **E** collection, - | :ref:`OrderedCollectionChangeSet ` changeset - | ) - - - - - * - Constructor for a CollectionChange. - - - - - **Parameters** - - - ``collection`` - the collection that changed. - - - - - ``changeset`` - the changeset describing the change. - - - - - - - - - - - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _CollectionChange_equals: - -.. _CollectionChange_equals__: - -.. _io_realm_rx_CollectionChange_equals: - -.. _io_realm_rx_CollectionChange_equals__: - - - -equals ------- - -.. _io_realm_rx_CollectionChange_equals_java_lang_Object_: - -.. _io_realm_rx_CollectionChange_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _CollectionChange_equals_java_lang_Object_: - -.. _CollectionChange_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getChangeset: - -.. _getChangeset__: - -.. _CollectionChange_getChangeset: - -.. _CollectionChange_getChangeset__: - -.. _io_realm_rx_CollectionChange_getChangeset: - -.. _io_realm_rx_CollectionChange_getChangeset__: - - - -getChangeset ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`OrderedCollectionChangeSet ` :ref:`getChangeset ` () - | - - - - - * - Returns the changeset describing the update.This will be ``null`` the first time the stream emits the collection as well as when a asynchronous query is loaded for the first time. - - - - - - .. code-block:: java - - - // Example - realm.where(Person.class).findAllAsync().asChangesetObservable() - .subscribe(new Consumer() { - @Override - public void accept(CollectionChange item) throws Exception { - item.getChangeset(); // Will return null the first two times - } - }); - - - - - - - - - - - - - **Returns** - - the changeset describing how the collection was updated. - - - - - - - - - - - -.. _getCollection: - -.. _getCollection__: - -.. _CollectionChange_getCollection: - -.. _CollectionChange_getCollection__: - -.. _io_realm_rx_CollectionChange_getCollection: - -.. _io_realm_rx_CollectionChange_getCollection__: - - - -getCollection -------------- - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`getCollection ` () - | - - - - - * - Returns the collection that was updated. - - - - - - - **Returns** - - collection that was updated. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _CollectionChange_hashCode: - -.. _CollectionChange_hashCode__: - -.. _io_realm_rx_CollectionChange_hashCode: - -.. _io_realm_rx_CollectionChange_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/rx/ObjectChange.txt b/source/sdk/java/api/io/realm/rx/ObjectChange.txt deleted file mode 100644 index cb0349eb87..0000000000 --- a/source/sdk/java/api/io/realm/rx/ObjectChange.txt +++ /dev/null @@ -1,445 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class ObjectChange -^^^^^^^^^^^^^^^^^^ - -.. _io_realm_rx_ObjectChange: - - - -io.realm.rx -=========== - - - | `java.lang.Object `__ - | io.realm.rx.ObjectChange - - -Container wrapping the result of a :ref:`io.realm.RealmObjectChangeListener ` being triggered. - -This is used by :ref:`RealmObject.asChangesetObservable() ` and :ref:`RealmObject.asChangesetObservable(RealmModel) ` as RxJava is only capable of emitting one item, not multiple. - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`ObjectChange ` ( - | **E** object, - | :ref:`ObjectChangeSet ` changeset - | ) - - - Constructor for a ObjectChange. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public :ref:`ObjectChangeSet ` - - | :ref:`getChangeset ` () - | - - - Returns the changeset describing the update. - - - - - * - public **E** - - | :ref:`getObject ` () - | - - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - * - public `String `__ - - | :ref:`toString ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _ObjectChange: - -.. _ObjectChange__: - -.. _io_realm_rx_ObjectChange: - -.. _io_realm_rx_ObjectChange__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ObjectChange ` ( - | **E** object, - | :ref:`ObjectChangeSet ` changeset - | ) - - - - - * - Constructor for a ObjectChange. - - - - - **Parameters** - - - ``object`` - the object that was updated. - - - - - ``changeset`` - the changeset describing the update. - - - - - - - - - - - - - - -Method Detail -============= - -.. _equals: - -.. _equals__: - -.. _ObjectChange_equals: - -.. _ObjectChange_equals__: - -.. _io_realm_rx_ObjectChange_equals: - -.. _io_realm_rx_ObjectChange_equals__: - - - -equals ------- - -.. _io_realm_rx_ObjectChange_equals_java_lang_Object_: - -.. _io_realm_rx_ObjectChange_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _ObjectChange_equals_java_lang_Object_: - -.. _ObjectChange_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _getChangeset: - -.. _getChangeset__: - -.. _ObjectChange_getChangeset: - -.. _ObjectChange_getChangeset__: - -.. _io_realm_rx_ObjectChange_getChangeset: - -.. _io_realm_rx_ObjectChange_getChangeset__: - - - -getChangeset ------------- - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`ObjectChangeSet ` :ref:`getChangeset ` () - | - - - - - * - Returns the changeset describing the update.This will be ``null`` the first time the stream emits the object as well as when a asynchronous query is loaded for the first time. - - - - - - .. code-block:: java - - - // Example - realm.where(Person.class).findFirstAsync().asChangesetObservable() - .subscribe(new Consumer() { - @Override - public void accept(ObjectChange item) throws Exception { - item.getChangeset(); // Will return null the first two times - } - }); - - - - - - - - - - - - - **Returns** - - the changeset describing how the object was updated. - - - - - - - - - - - -.. _getObject: - -.. _getObject__: - -.. _ObjectChange_getObject: - -.. _ObjectChange_getObject__: - -.. _io_realm_rx_ObjectChange_getObject: - -.. _io_realm_rx_ObjectChange_getObject__: - - - -getObject ---------- - -.. list-table:: - :header-rows: 1 - - * - | public **E** :ref:`getObject ` () - | - - - - - * - - - - - - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _ObjectChange_hashCode: - -.. _ObjectChange_hashCode__: - -.. _io_realm_rx_ObjectChange_hashCode: - -.. _io_realm_rx_ObjectChange_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - -.. _toString: - -.. _toString__: - -.. _ObjectChange_toString: - -.. _ObjectChange_toString__: - -.. _io_realm_rx_ObjectChange_toString: - -.. _io_realm_rx_ObjectChange_toString__: - - - -toString --------- - -.. list-table:: - :header-rows: 1 - - * - | public `String `__ :ref:`toString ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``toString`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt b/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt deleted file mode 100644 index f9475e91aa..0000000000 --- a/source/sdk/java/api/io/realm/rx/RealmObservableFactory.txt +++ /dev/null @@ -1,1771 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Class RealmObservableFactory -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_rx_RealmObservableFactory: - - - -io.realm.rx -=========== - - - | `java.lang.Object `__ - | io.realm.rx.RealmObservableFactory - - -**Implemented interfaces:** - - - -- :ref:`io.realm.rx.RxObservableFactory ` - - -Factory class for creating Observables for RxJava (<=2.0.\*). - - -.. seealso:: - - - - - :ref:`Realm.asFlowable() () ` - - - - - :ref:`RealmObject.asFlowable() ` - - - - - :ref:`RealmResults.asFlowable() ` - - - - - :ref:`DynamicRealm.asFlowable() ` - - - - - **DynamicRealmObject.asFlowable()** - - - - - - - - - -Constructors -============ - -.. list-table:: - :header-rows: 1 - - * - Constructor and Description - - * - | :ref:`RealmObservableFactory ` ( - | **boolean** emitFrozenObjects - | ) - - - Constructs the factory for creating Realm observables for RxJava. - - - - - - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **** - - | :ref:`changesetsFrom ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - Creates an Observable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - Creates an Observable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates an Observable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates an Observable for a :ref:`RealmResults ` . - - - - - - - * - public **boolean** - - | :ref:`equals ` ( - | `Object `__ o - | ) - - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - Creates a Single from a :ref:`RealmQuery ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - Creates a Single from a :ref:`RealmQuery ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - Creates a Flowable for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - Creates a Flowable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a Flowable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a Flowable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a Flowable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` realm - | ) - - - Creates a Flowable for a :ref:`DynamicRealm ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - Creates a Flowable for a :ref:`Realm ` . - - - - - - - * - public **int** - - | :ref:`hashCode ` () - | - - - - - - - - - - -Inherited Methods -================= - - - -- Methods inherited from class `java.lang.Object `__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` - - - - -Constructor Detail -================== - -.. _RealmObservableFactory: - -.. _RealmObservableFactory__: - -.. _io_realm_rx_RealmObservableFactory: - -.. _io_realm_rx_RealmObservableFactory__: - -.. list-table:: - :header-rows: 1 - - * - | public :ref:`RealmObservableFactory ` ( - | **boolean** emitFrozenObjects - | ) - - - - - * - Constructs the factory for creating Realm observables for RxJava. - - - - - **Parameters** - - - ``emitFrozenObjects`` - ``true`` if all objects should be frozen before being returned to the user. ``false`` if they should be live objects. - - - - - - - - - - - - - - - - -Method Detail -============= - -.. _changesetsFrom: - -.. _changesetsFrom__: - -.. _RealmObservableFactory_changesetsFrom: - -.. _RealmObservableFactory_changesetsFrom__: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom__: - - - -changesetsFrom --------------- - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - - - * - Creates an Observable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_E_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__E_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_E_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__E_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__RealmModel_: - -.. _changesetsFrom_io_realm_Realm_E_: - -.. _changesetsFrom_io_realm_Realm__E_: - -.. _changesetsFrom_io_realm_Realm_RealmModel_: - -.. _changesetsFrom_io_realm_Realm__RealmModel_: - -.. _changesetsFrom_Realm_E_: - -.. _changesetsFrom_Realm__E_: - -.. _changesetsFrom_Realm_RealmModel_: - -.. _changesetsFrom_Realm__RealmModel_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_E_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__E_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmModel_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmModel_: - -.. _RealmObservableFactory_changesetsFrom_Realm_E_: - -.. _RealmObservableFactory_changesetsFrom_Realm__E_: - -.. _RealmObservableFactory_changesetsFrom_Realm_RealmModel_: - -.. _RealmObservableFactory_changesetsFrom_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - - - * - Creates an Observable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _changesetsFrom_DynamicRealm_RealmList_: - -.. _changesetsFrom_DynamicRealm__RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmList it should emit the RealmList + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__RealmList_: - -.. _changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm__RealmList_: - -.. _changesetsFrom_Realm_io_realm_RealmList_: - -.. _changesetsFrom_Realm__io_realm_RealmList_: - -.. _changesetsFrom_Realm_RealmList_: - -.. _changesetsFrom_Realm__RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmList_: - -.. _RealmObservableFactory_changesetsFrom_Realm_io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_Realm__io_realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_Realm_RealmList_: - -.. _RealmObservableFactory_changesetsFrom_Realm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmIst it should emit the RealmList + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _changesetsFrom_DynamicRealm_RealmResults_: - -.. _changesetsFrom_DynamicRealm__RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_DynamicRealm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates an Observable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__RealmResults_: - -.. _changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm__RealmResults_: - -.. _changesetsFrom_Realm_io_realm_RealmResults_: - -.. _changesetsFrom_Realm__io_realm_RealmResults_: - -.. _changesetsFrom_Realm_RealmResults_: - -.. _changesetsFrom_Realm__RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_io_realm_Realm__RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_Realm_io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_Realm__io_realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_Realm_RealmResults_: - -.. _RealmObservableFactory_changesetsFrom_Realm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_changesetsFrom_Realm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates an Observable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - - - -.. _equals: - -.. _equals__: - -.. _RealmObservableFactory_equals: - -.. _RealmObservableFactory_equals__: - -.. _io_realm_rx_RealmObservableFactory_equals: - -.. _io_realm_rx_RealmObservableFactory_equals__: - - - -equals ------- - -.. _io_realm_rx_RealmObservableFactory_equals_java_lang_Object_: - -.. _io_realm_rx_RealmObservableFactory_equals_Object_: - -.. _equals_java_lang_Object_: - -.. _equals_Object_: - -.. _RealmObservableFactory_equals_java_lang_Object_: - -.. _RealmObservableFactory_equals_Object_: - -.. list-table:: - :header-rows: 1 - - * - | public **boolean** :ref:`equals ` ( - | `Object `__ o - | ) - - - - - * - - - - - - - - - - - - **Overrides** - - ``equals`` in class `Object `__ - - - - - - -.. _from: - -.. _from__: - -.. _RealmObservableFactory_from: - -.. _RealmObservableFactory_from__: - -.. _io_realm_rx_RealmObservableFactory_from: - -.. _io_realm_rx_RealmObservableFactory_from__: - - - -from ----- - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmQuery_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _from_io_realm_DynamicRealm_RealmQuery_: - -.. _from_io_realm_DynamicRealm__RealmQuery_: - -.. _from_DynamicRealm_io_realm_RealmQuery_: - -.. _from_DynamicRealm__io_realm_RealmQuery_: - -.. _from_DynamicRealm_RealmQuery_: - -.. _from_DynamicRealm__RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__RealmQuery_: - -.. _RealmObservableFactory_from_DynamicRealm_io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_DynamicRealm__io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_DynamicRealm_RealmQuery_: - -.. _RealmObservableFactory_from_DynamicRealm__RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmQuery_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - - - * - Creates a Single from a :ref:`RealmQuery ` . It should emit the query and then complete. - - A RealmQuery observable is cold. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__io_realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmQuery_: - -.. _from_io_realm_Realm_io_realm_RealmQuery_: - -.. _from_io_realm_Realm__io_realm_RealmQuery_: - -.. _from_io_realm_Realm_RealmQuery_: - -.. _from_io_realm_Realm__RealmQuery_: - -.. _from_Realm_io_realm_RealmQuery_: - -.. _from_Realm__io_realm_RealmQuery_: - -.. _from_Realm_RealmQuery_: - -.. _from_Realm__RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_Realm_io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_Realm__io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_Realm_RealmQuery_: - -.. _RealmObservableFactory_from_io_realm_Realm__RealmQuery_: - -.. _RealmObservableFactory_from_Realm_io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_Realm__io_realm_RealmQuery_: - -.. _RealmObservableFactory_from_Realm_RealmQuery_: - -.. _RealmObservableFactory_from_Realm__RealmQuery_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmQuery_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - - - * - Creates a Single from a :ref:`RealmQuery ` . It should emit the query and then complete. - - A RealmQuery observable is cold. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm_DynamicRealmObject_: - -.. _from_DynamicRealm__DynamicRealmObject_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RealmObservableFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _RealmObservableFactory_from_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - - - * - Creates a Flowable for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - DynamicRealmObject observables are hot as DynamicRealmObjects automatically are kept up to date. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_E_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__E_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_E_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__E_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_RealmModel_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmModel_: - -.. _from_io_realm_Realm_E_: - -.. _from_io_realm_Realm__E_: - -.. _from_io_realm_Realm_RealmModel_: - -.. _from_io_realm_Realm__RealmModel_: - -.. _from_Realm_E_: - -.. _from_Realm__E_: - -.. _from_Realm_RealmModel_: - -.. _from_Realm__RealmModel_: - -.. _RealmObservableFactory_from_io_realm_Realm_E_: - -.. _RealmObservableFactory_from_io_realm_Realm__E_: - -.. _RealmObservableFactory_from_io_realm_Realm_RealmModel_: - -.. _RealmObservableFactory_from_io_realm_Realm__RealmModel_: - -.. _RealmObservableFactory_from_Realm_E_: - -.. _RealmObservableFactory_from_Realm__E_: - -.. _RealmObservableFactory_from_Realm_RealmModel_: - -.. _RealmObservableFactory_from_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - - - * - Creates a Flowable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - RealmObject observables are hot as RealmObjects are automatically kept up to date. - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmList_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm_RealmList_: - -.. _from_io_realm_DynamicRealm__RealmList_: - -.. _from_DynamicRealm_io_realm_RealmList_: - -.. _from_DynamicRealm__io_realm_RealmList_: - -.. _from_DynamicRealm_RealmList_: - -.. _from_DynamicRealm__RealmList_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _RealmObservableFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _RealmObservableFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _RealmObservableFactory_from_DynamicRealm_RealmList_: - -.. _RealmObservableFactory_from_DynamicRealm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a Flowable for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the RealmList. - - RealmList observables are hot as RealmLists are automatically kept up to date. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmList_: - -.. _from_io_realm_Realm_io_realm_RealmList_: - -.. _from_io_realm_Realm__io_realm_RealmList_: - -.. _from_io_realm_Realm_RealmList_: - -.. _from_io_realm_Realm__RealmList_: - -.. _from_Realm_io_realm_RealmList_: - -.. _from_Realm__io_realm_RealmList_: - -.. _from_Realm_RealmList_: - -.. _from_Realm__RealmList_: - -.. _RealmObservableFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_Realm_RealmList_: - -.. _RealmObservableFactory_from_io_realm_Realm__RealmList_: - -.. _RealmObservableFactory_from_Realm_io_realm_RealmList_: - -.. _RealmObservableFactory_from_Realm__io_realm_RealmList_: - -.. _RealmObservableFactory_from_Realm_RealmList_: - -.. _RealmObservableFactory_from_Realm__RealmList_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the RealmList. - - RealmList observables are hot as RealmLists are automatically kept up to date. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - - - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmResults_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm_RealmResults_: - -.. _from_io_realm_DynamicRealm__RealmResults_: - -.. _from_DynamicRealm_io_realm_RealmResults_: - -.. _from_DynamicRealm__io_realm_RealmResults_: - -.. _from_DynamicRealm_RealmResults_: - -.. _from_DynamicRealm__RealmResults_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _RealmObservableFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _RealmObservableFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _RealmObservableFactory_from_DynamicRealm_RealmResults_: - -.. _RealmObservableFactory_from_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a Flowable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - Realm observables are hot as RealmResults are automatically kept up to date. - - - - - - - - - **Returns** - - Rx observable that emit all updates to the RealmResults. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmResults_: - -.. _from_io_realm_Realm_io_realm_RealmResults_: - -.. _from_io_realm_Realm__io_realm_RealmResults_: - -.. _from_io_realm_Realm_RealmResults_: - -.. _from_io_realm_Realm__RealmResults_: - -.. _from_Realm_io_realm_RealmResults_: - -.. _from_Realm__io_realm_RealmResults_: - -.. _from_Realm_RealmResults_: - -.. _from_Realm__RealmResults_: - -.. _RealmObservableFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_Realm_RealmResults_: - -.. _RealmObservableFactory_from_io_realm_Realm__RealmResults_: - -.. _RealmObservableFactory_from_Realm_io_realm_RealmResults_: - -.. _RealmObservableFactory_from_Realm__io_realm_RealmResults_: - -.. _RealmObservableFactory_from_Realm_RealmResults_: - -.. _RealmObservableFactory_from_Realm__RealmResults_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a Flowable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - RealmResults observables are hot as RealmResults are automatically kept up to date. - - - - - - - - - **Returns** - - Rx observable that emit all updates to the RealmObject. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_DynamicRealm_: - -.. _io_realm_rx_RealmObservableFactory_from_DynamicRealm_: - -.. _from_io_realm_DynamicRealm_: - -.. _from_DynamicRealm_: - -.. _RealmObservableFactory_from_io_realm_DynamicRealm_: - -.. _RealmObservableFactory_from_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - * - Creates a Flowable for a :ref:`DynamicRealm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - DynamicRealm observables are hot as DynamicRealms are automatically kept up to date. - - - - - - - - - **Returns** - - Rx observable that emit all updates to the DynamicRealm. - - - - - - - - - -.. _io_realm_rx_RealmObservableFactory_from_io_realm_Realm_: - -.. _io_realm_rx_RealmObservableFactory_from_Realm_: - -.. _from_io_realm_Realm_: - -.. _from_Realm_: - -.. _RealmObservableFactory_from_io_realm_Realm_: - -.. _RealmObservableFactory_from_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - - - * - Creates a Flowable for a :ref:`Realm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - Realm flowables are hot as Realms are automatically kept up to date. - - - - - - - - - **Returns** - - Rx observable that emit all updates to the Realm. - - - - - - - - - - - -.. _hashCode: - -.. _hashCode__: - -.. _RealmObservableFactory_hashCode: - -.. _RealmObservableFactory_hashCode__: - -.. _io_realm_rx_RealmObservableFactory_hashCode: - -.. _io_realm_rx_RealmObservableFactory_hashCode__: - - - -hashCode --------- - -.. list-table:: - :header-rows: 1 - - * - | public **int** :ref:`hashCode ` () - | - - - - - * - - - - - - - - - - - - **Overrides** - - ``hashCode`` in class `Object `__ - - - - - - - diff --git a/source/sdk/java/api/io/realm/rx/RxObservableFactory.txt b/source/sdk/java/api/io/realm/rx/RxObservableFactory.txt deleted file mode 100644 index f943db91ae..0000000000 --- a/source/sdk/java/api/io/realm/rx/RxObservableFactory.txt +++ /dev/null @@ -1,1811 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - - -Interface RxObservableFactory -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. _io_realm_rx_RxObservableFactory: - - - -io.realm.rx -=========== - -Factory interface for creating Rx Observables for Realm classes. - - -Method Summary -============== - -.. list-table:: - :header-rows: 1 - - * - Modifier and Type - - Method and Description - - * - public **** - - | :ref:`changesetsFrom ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - Creates an Observable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - Creates an Observable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates an Observable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates an Observable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - Creates a Single from a :ref:`RealmQuery ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - Creates a Single from a :ref:`RealmQuery ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - Creates a Flowable for a :ref:`DynamicRealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - Creates a Flowable for a :ref:`RealmObject ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates a Flowable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - Creates an Observable for a :ref:`RealmList ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a Flowable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - Creates a Flowable for a :ref:`RealmResults ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`DynamicRealm ` realm - | ) - - - Creates a Flowable for a :ref:`DynamicRealm ` . - - - - - - - * - public **** - - | :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - Creates a Flowable for a :ref:`Realm ` . - - - - - - - - - -Method Detail -============= - -.. _changesetsFrom: - -.. _changesetsFrom__: - -.. _RxObservableFactory_changesetsFrom: - -.. _RxObservableFactory_changesetsFrom__: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom__: - - - -changesetsFrom --------------- - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_DynamicRealmObject_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - - - * - Creates an Observable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - - - **Parameters** - - - ``object`` - RealmObject to listen to changes for. - - - - - ``realm`` - :ref:`Realm ` instance object is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_E_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__E_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_RealmModel_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__RealmModel_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_E_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__E_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_RealmModel_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__RealmModel_: - -.. _changesetsFrom_io_realm_Realm_E_: - -.. _changesetsFrom_io_realm_Realm__E_: - -.. _changesetsFrom_io_realm_Realm_RealmModel_: - -.. _changesetsFrom_io_realm_Realm__RealmModel_: - -.. _changesetsFrom_Realm_E_: - -.. _changesetsFrom_Realm__E_: - -.. _changesetsFrom_Realm_RealmModel_: - -.. _changesetsFrom_Realm__RealmModel_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_E_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__E_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_RealmModel_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__RealmModel_: - -.. _RxObservableFactory_changesetsFrom_Realm_E_: - -.. _RxObservableFactory_changesetsFrom_Realm__E_: - -.. _RxObservableFactory_changesetsFrom_Realm_RealmModel_: - -.. _RxObservableFactory_changesetsFrom_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - - - * - Creates an Observable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object it should emit the object + the :ref:`io.realm.ObjectChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefore be left to the user. - - - - - **Type Parameters** - - - ``E`` - type of RealmObject - - - - - - - - **Parameters** - - - ``object`` - RealmObject to listen to changes for. - - - - - ``realm`` - :ref:`Realm ` instance object is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _changesetsFrom_DynamicRealm_RealmList_: - -.. _changesetsFrom_DynamicRealm__RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmList_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmList it should emit the RealmList + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - **Parameters** - - - ``list`` - :ref:`RealmList ` to listen to changes for. - - - - - - - ``realm`` - :ref:`Realm ` instance list is coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__RealmList_: - -.. _changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm_RealmList_: - -.. _changesetsFrom_io_realm_Realm__RealmList_: - -.. _changesetsFrom_Realm_io_realm_RealmList_: - -.. _changesetsFrom_Realm__io_realm_RealmList_: - -.. _changesetsFrom_Realm_RealmList_: - -.. _changesetsFrom_Realm__RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__RealmList_: - -.. _RxObservableFactory_changesetsFrom_Realm_io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_Realm__io_realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_Realm_RealmList_: - -.. _RxObservableFactory_changesetsFrom_Realm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial RealmList when subscribed to and on each subsequent update of the RealmIst it should emit the RealmList + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - **Type Parameters** - - - ``E`` - type of RealmObject - - - - - - - - **Parameters** - - - ``list`` - :ref:`RealmList ` to listen to changes for. - - - - - - - ``realm`` - :ref:`Realm ` instance list is coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _changesetsFrom_DynamicRealm_RealmResults_: - -.. _changesetsFrom_DynamicRealm__RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_DynamicRealm__RealmResults_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_DynamicRealm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates an Observable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` to listen to changes for. - - - - - - - ``realm`` - :ref:`Realm ` instance results are coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_io_realm_Realm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__RealmResults_: - -.. _changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm_RealmResults_: - -.. _changesetsFrom_io_realm_Realm__RealmResults_: - -.. _changesetsFrom_Realm_io_realm_RealmResults_: - -.. _changesetsFrom_Realm__io_realm_RealmResults_: - -.. _changesetsFrom_Realm_RealmResults_: - -.. _changesetsFrom_Realm__RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_io_realm_Realm__RealmResults_: - -.. _RxObservableFactory_changesetsFrom_Realm_io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_Realm__io_realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_Realm_RealmResults_: - -.. _RxObservableFactory_changesetsFrom_Realm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_changesetsFrom_Realm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`changesetsFrom ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates an Observable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults it should emit the RealmResults + the :ref:`OrderedCollectionChangeSet ` that describes the update. - - Changeset observables do not support backpressure as a changeset depends on the state of the previous changeset. Handling backpressure should therefor be left to users. - - - - - **Type Parameters** - - - ``E`` - type of RealmObject - - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` to listen to changes for. - - - - - - - ``realm`` - :ref:`Realm ` instance results are coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates + their changeset. - - - - - - - - - - - -.. _from: - -.. _from__: - -.. _RxObservableFactory_from: - -.. _RxObservableFactory_from__: - -.. _io_realm_rx_RxObservableFactory_from: - -.. _io_realm_rx_RxObservableFactory_from__: - - - -from ----- - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmQuery_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _from_io_realm_DynamicRealm_RealmQuery_: - -.. _from_io_realm_DynamicRealm__RealmQuery_: - -.. _from_DynamicRealm_io_realm_RealmQuery_: - -.. _from_DynamicRealm__io_realm_RealmQuery_: - -.. _from_DynamicRealm_RealmQuery_: - -.. _from_DynamicRealm__RealmQuery_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__RealmQuery_: - -.. _RxObservableFactory_from_DynamicRealm_io_realm_RealmQuery_: - -.. _RxObservableFactory_from_DynamicRealm__io_realm_RealmQuery_: - -.. _RxObservableFactory_from_DynamicRealm_RealmQuery_: - -.. _RxObservableFactory_from_DynamicRealm__RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmQuery_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - - - * - Creates a Single from a :ref:`RealmQuery ` . It should emit the query and then complete. - - A RealmQuery observable is cold. - - - - - - - **Parameters** - - - ``query`` - RealmObject to listen to changes for. - - - - - ``realm`` - :ref:`DynamicRealm ` instance query is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__io_realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmQuery_: - -.. _from_io_realm_Realm_io_realm_RealmQuery_: - -.. _from_io_realm_Realm__io_realm_RealmQuery_: - -.. _from_io_realm_Realm_RealmQuery_: - -.. _from_io_realm_Realm__RealmQuery_: - -.. _from_Realm_io_realm_RealmQuery_: - -.. _from_Realm__io_realm_RealmQuery_: - -.. _from_Realm_RealmQuery_: - -.. _from_Realm__RealmQuery_: - -.. _RxObservableFactory_from_io_realm_Realm_io_realm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_Realm__io_realm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_Realm_RealmQuery_: - -.. _RxObservableFactory_from_io_realm_Realm__RealmQuery_: - -.. _RxObservableFactory_from_Realm_io_realm_RealmQuery_: - -.. _RxObservableFactory_from_Realm__io_realm_RealmQuery_: - -.. _RxObservableFactory_from_Realm_RealmQuery_: - -.. _RxObservableFactory_from_Realm__RealmQuery_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmQuery_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmQuery\ ` query - | ) - - - - - * - Creates a Single from a :ref:`RealmQuery ` . It should emit the query and then complete. - - A RealmQuery observable is cold. - - - - - **Type Parameters** - - - ``E`` - type of query target - - - - - - - - **Parameters** - - - ``query`` - RealmQuery to emit. - - - - - ``realm`` - :ref:`Realm ` instance query is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _from_DynamicRealm_DynamicRealmObject_: - -.. _from_DynamicRealm__DynamicRealmObject_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_DynamicRealmObject_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__DynamicRealmObject_: - -.. _RxObservableFactory_from_DynamicRealm_io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_from_DynamicRealm__io_realm_DynamicRealmObject_: - -.. _RxObservableFactory_from_DynamicRealm_DynamicRealmObject_: - -.. _RxObservableFactory_from_DynamicRealm__DynamicRealmObject_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` realm, - | :ref:`DynamicRealmObject ` object - | ) - - - - - * - Creates a Flowable for a :ref:`DynamicRealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - DynamicRealmObject observables are hot as DynamicRealmObjects automatically are kept up to date. - - - - - - - **Parameters** - - - ``object`` - DynamicRealmObject to listen to changes for. - - - - - ``realm`` - :ref:`DynamicRealm ` instance object is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_E_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__E_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_RealmModel_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__RealmModel_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_E_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__E_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_RealmModel_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmModel_: - -.. _from_io_realm_Realm_E_: - -.. _from_io_realm_Realm__E_: - -.. _from_io_realm_Realm_RealmModel_: - -.. _from_io_realm_Realm__RealmModel_: - -.. _from_Realm_E_: - -.. _from_Realm__E_: - -.. _from_Realm_RealmModel_: - -.. _from_Realm__RealmModel_: - -.. _RxObservableFactory_from_io_realm_Realm_E_: - -.. _RxObservableFactory_from_io_realm_Realm__E_: - -.. _RxObservableFactory_from_io_realm_Realm_RealmModel_: - -.. _RxObservableFactory_from_io_realm_Realm__RealmModel_: - -.. _RxObservableFactory_from_Realm_E_: - -.. _RxObservableFactory_from_Realm__E_: - -.. _RxObservableFactory_from_Realm_RealmModel_: - -.. _RxObservableFactory_from_Realm__RealmModel_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | **E** object - | ) - - - - - * - Creates a Flowable for a :ref:`RealmObject ` . It should emit the initial object when subscribed to and on each subsequent update of the object. - - RealmObject observables are hot as RealmObjects are automatically kept up to date. - - - - - **Type Parameters** - - - ``E`` - type of query target - - - - - - - - **Parameters** - - - ``object`` - RealmObject to listen to changes for. - - - - - ``realm`` - :ref:`Realm ` instance object is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmList_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _from_io_realm_DynamicRealm_RealmList_: - -.. _from_io_realm_DynamicRealm__RealmList_: - -.. _from_DynamicRealm_io_realm_RealmList_: - -.. _from_DynamicRealm__io_realm_RealmList_: - -.. _from_DynamicRealm_RealmList_: - -.. _from_DynamicRealm__RealmList_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmList_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmList_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_RealmList_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__RealmList_: - -.. _RxObservableFactory_from_DynamicRealm_io_realm_RealmList_: - -.. _RxObservableFactory_from_DynamicRealm__io_realm_RealmList_: - -.. _RxObservableFactory_from_DynamicRealm_RealmList_: - -.. _RxObservableFactory_from_DynamicRealm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates a Flowable for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the RealmList. - - RealmList observables are hot as RealmLists are automatically kept up to date. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - - - **Parameters** - - - ``list`` - RealmList to listen to changes for. - - - - - ``realm`` - :ref:`DynamicRealm ` instance list is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__io_realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmList_: - -.. _from_io_realm_Realm_io_realm_RealmList_: - -.. _from_io_realm_Realm__io_realm_RealmList_: - -.. _from_io_realm_Realm_RealmList_: - -.. _from_io_realm_Realm__RealmList_: - -.. _from_Realm_io_realm_RealmList_: - -.. _from_Realm__io_realm_RealmList_: - -.. _from_Realm_RealmList_: - -.. _from_Realm__RealmList_: - -.. _RxObservableFactory_from_io_realm_Realm_io_realm_RealmList_: - -.. _RxObservableFactory_from_io_realm_Realm__io_realm_RealmList_: - -.. _RxObservableFactory_from_io_realm_Realm_RealmList_: - -.. _RxObservableFactory_from_io_realm_Realm__RealmList_: - -.. _RxObservableFactory_from_Realm_io_realm_RealmList_: - -.. _RxObservableFactory_from_Realm__io_realm_RealmList_: - -.. _RxObservableFactory_from_Realm_RealmList_: - -.. _RxObservableFactory_from_Realm__RealmList_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmList_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmList\ ` list - | ) - - - - - * - Creates an Observable for a :ref:`RealmList ` . It should emit the initial list when subscribed to and on each subsequent update of the RealmList. - - RealmList observables are hot as RealmLists are automatically kept up to date. - - Note: :ref:`io.realm.RealmChangeListener ` is currently not supported on RealmLists. - - - - - - - **Type Parameters** - - - ``E`` - type of query target - - - - - - - - **Parameters** - - - ``list`` - RealmObject to listen to changes for. - - - - - ``realm`` - :ref:`Realm ` instance list is coming from. - - - - - - - - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmResults_: - -.. _from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _from_io_realm_DynamicRealm_RealmResults_: - -.. _from_io_realm_DynamicRealm__RealmResults_: - -.. _from_DynamicRealm_io_realm_RealmResults_: - -.. _from_DynamicRealm__io_realm_RealmResults_: - -.. _from_DynamicRealm_RealmResults_: - -.. _from_DynamicRealm__RealmResults_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_io_realm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__io_realm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm__RealmResults_: - -.. _RxObservableFactory_from_DynamicRealm_io_realm_RealmResults_: - -.. _RxObservableFactory_from_DynamicRealm__io_realm_RealmResults_: - -.. _RxObservableFactory_from_DynamicRealm_RealmResults_: - -.. _RxObservableFactory_from_DynamicRealm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`DynamicRealm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a Flowable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - Realm observables are hot as RealmResults are automatically kept up to date. - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` to listen to changes for. - - - - - - - ``realm`` - :ref:`DynamicRealm ` instance results are coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates to the RealmResults. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__io_realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmResults_: - -.. _from_io_realm_Realm_io_realm_RealmResults_: - -.. _from_io_realm_Realm__io_realm_RealmResults_: - -.. _from_io_realm_Realm_RealmResults_: - -.. _from_io_realm_Realm__RealmResults_: - -.. _from_Realm_io_realm_RealmResults_: - -.. _from_Realm__io_realm_RealmResults_: - -.. _from_Realm_RealmResults_: - -.. _from_Realm__RealmResults_: - -.. _RxObservableFactory_from_io_realm_Realm_io_realm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_Realm__io_realm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_Realm_RealmResults_: - -.. _RxObservableFactory_from_io_realm_Realm__RealmResults_: - -.. _RxObservableFactory_from_Realm_io_realm_RealmResults_: - -.. _RxObservableFactory_from_Realm__io_realm_RealmResults_: - -.. _RxObservableFactory_from_Realm_RealmResults_: - -.. _RxObservableFactory_from_Realm__RealmResults_: - -.. _io_realm_rx_RxObservableFactory_from_Realm__RealmResults_E__: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` <**E** >( - | :ref:`Realm ` realm, - | :ref:`io.realm.RealmResults\ ` results - | ) - - - - - * - Creates a Flowable for a :ref:`RealmResults ` . It should emit the initial RealmResult when subscribed to and on each subsequent update of the RealmResults. - - RealmResults observables are hot as RealmResults are automatically kept up to date. - - - - - **Type Parameters** - - - ``E`` - type of RealmObject - - - - - - - - **Parameters** - - - ``results`` - :ref:`RealmResults ` to listen to changes for. - - - - - - - ``realm`` - :ref:`Realm ` instance results are coming from. - - - - - - - - - - **Returns** - - Rx observable that emit all updates to the RealmObject. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_DynamicRealm_: - -.. _io_realm_rx_RxObservableFactory_from_DynamicRealm_: - -.. _from_io_realm_DynamicRealm_: - -.. _from_DynamicRealm_: - -.. _RxObservableFactory_from_io_realm_DynamicRealm_: - -.. _RxObservableFactory_from_DynamicRealm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`DynamicRealm ` realm - | ) - - - - - * - Creates a Flowable for a :ref:`DynamicRealm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - DynamicRealm observables are hot as DynamicRealms are automatically kept up to date. - - - - - - - **Parameters** - - - ``realm`` - :ref:`DynamicRealm ` to listen to changes for. - - - - - - - - - - **Returns** - - Rx observable that emit all updates to the DynamicRealm. - - - - - - - - - -.. _io_realm_rx_RxObservableFactory_from_io_realm_Realm_: - -.. _io_realm_rx_RxObservableFactory_from_Realm_: - -.. _from_io_realm_Realm_: - -.. _from_Realm_: - -.. _RxObservableFactory_from_io_realm_Realm_: - -.. _RxObservableFactory_from_Realm_: - -.. list-table:: - :header-rows: 1 - - * - | public **** :ref:`from ` ( - | :ref:`Realm ` realm - | ) - - - - - * - Creates a Flowable for a :ref:`Realm ` . It should emit the initial state of the Realm when subscribed to and on each subsequent update of the Realm. - - Realm flowables are hot as Realms are automatically kept up to date. - - - - - - - **Parameters** - - - ``realm`` - :ref:`Realm ` to listen to changes for. - - - - - - - - - - **Returns** - - Rx observable that emit all updates to the Realm. - - - - - - - - - - - - diff --git a/source/sdk/java/app-services.txt b/source/sdk/java/app-services.txt deleted file mode 100644 index eae9dda259..0000000000 --- a/source/sdk/java/app-services.txt +++ /dev/null @@ -1,97 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -=============================== -Application Services - Java SDK -=============================== - -.. toctree:: - :titlesonly: - - Connect to an App Services App - Call a Function - Query MongoDB - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java-mongodb-realm-cloud: -.. _java-application-services: - -Realm provides SDKs that help you connect your client apps to the Atlas App Services -backend. The SDK provides the functionality needed to -authenticate users with any of the built-in :ref:`Authentication providers `, -call :ref:`Atlas Functions `, and directly access a -:ref:`MongoDB database `. - -The App Client --------------- - -When using the SDK to access the App Services backend, you start with an -App object. This object provides all other functionality related to -App Services. The ``App`` object is -:ref:`initialized ` with the App ID, which you can -:ref:`find in the App Services UI `. - -.. tip:: - - To learn how to initialize the App client, see - :ref:`java-connect-to-mongodb-realm-backend-app`. - -Authentication & User Management --------------------------------- - -One of the most challenging aspects of client development is implementing a -robust and secure authentication system. With the Realm SDKs, however, you -can use any of the App Services authentication providers with very minimal backend -setup or client-side code required. With the authentication APIs, you can -implement the following functionality: - -- Creation of new user accounts -- User log-in and log-out -- Multiple users logged on at the same time on the same device -- Linking user accounts from different providers -- Providing custom user data - -.. tip:: - - To learn how to set up authentication with different providers, see - :ref:`java-authenticate-users`. - - To learn how to manage multiple users, see :ref:`java-multi-user-applications`. - - To learn how to link user accounts, see :ref:`java-link-user-identities`. - - To learn how to provide custom user data, see :ref:`java-custom-user-data`. - -Calling Functions ------------------ -:ref:`Functions ` enable you to define and execute server-side -logic for your application. You can call these functions from your client applications -via the Realm SDKs. These server-side functions can run under the context -of the authenticated user, and thus honor the rules, roles, and permissions that -you have assigned to your collections. - -By using Functions, you provide a secure way for a variety of client -applications to share complex functionality without having to reproduce that -logic client-side. - -.. tip:: - - To learn how to call functions, see :ref:`Call a Function `. - -Accessing MongoDB ------------------ - -The Realm SDKs include APIs for accessing a MongoDB Atlas instance directly. -With these APIs, you can perform all of the standard CRUD operations from your -client. For security, you configure server-side :ref:`data access rules ` -to dynamically determine read & write permissions for every object that -is accessed. - -.. tip:: - - To learn how to use the MongoDB APIs, see :ref:`Query MongoDB `. diff --git a/source/sdk/java/app-services/call-a-function.txt b/source/sdk/java/app-services/call-a-function.txt deleted file mode 100644 index d2b0fb1081..0000000000 --- a/source/sdk/java/app-services/call-a-function.txt +++ /dev/null @@ -1,56 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-call-a-function: - -========================== -Call a Function - Java SDK -========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -The examples in this section demonstrate calling a simple function named -``sum`` that takes two arguments, adds them, and returns the result: - -.. code-block:: javascript - :copyable: false - - // sum: adds two numbers - exports = function(a, b) { - return a + b; - }; - -.. _java-call-a-function-by-name: - -Call a Function by Name ------------------------ - -To execute a function from the SDK, use the -:java-sdk:`getFunctions() ` -method of the your :java-sdk:`App ` -to retrieve a :java-sdk:`Functions manager <>`. Pass the name and -parameters of the function you would like to call to -:java-sdk:`callFunction() ` -or :java-sdk:`callFunctionAsync() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FunctionTest.snippet.call-a-function.java - :language: java - :emphasize-lines: 10-17 - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FunctionTest.snippet.call-a-function.kt - :language: kotlin - :emphasize-lines: 8,9,10,11,12,13,14,15,16,17 - :copyable: false diff --git a/source/sdk/java/app-services/connect-to-app-services-backend.txt b/source/sdk/java/app-services/connect-to-app-services-backend.txt deleted file mode 100644 index 58a0cdf227..0000000000 --- a/source/sdk/java/app-services/connect-to-app-services-backend.txt +++ /dev/null @@ -1,106 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-init-appclient: -.. _java-connect-to-mongodb-realm-backend-app: - -=================================================== -Connect to an Atlas App Services backend - Java SDK -=================================================== - -.. meta:: - :description: Connect your Atlas Device SDK for Java client app to the Atlas App Services backend. - :keywords: code example - -.. facet:: - :name: genre - :values: tutorial - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -The App client is the interface for the App Services -backend. It provides access to the :ref:`authentication functionality -`, :ref:`functions `, and -:ref:`sync management `. - -.. include:: /includes/java-initialize-realm.rst - -.. _java-access-the-app-client: - -Access the App Client ---------------------- - -Pass the App ID for your App, which you can :ref:`find in the Realm UI -`. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/InitializeTest.snippet.access-app-client.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/InitializeTest.snippet.access-app-client.kt - :language: kotlin - :copyable: false - -.. important:: Initialize the App before Creating an Instance - - You must initialize your App connection with - ``Realm.init()`` before creating any instance of an ``App``. - -.. _java-app-client-configuration: - -Configuration -------------- - -For most use cases, you only need your application's App ID to connect -to App Services. For more granular control of the details of your app connection, -such as custom timeouts for connections, codecs used for MongoDB Data Access, -and keys for local encryption, you can optionally use the ``AppConfiguration`` -Builder to control details of your ``App``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/InitializeTest.snippet.advanced-access-app-client.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/InitializeTest.snippet.advanced-access-app-client.kt - :language: kotlin - :copyable: false - -You can create multiple App client instances to connect to multiple -Apps. All App client instances that share the same App ID use the same -underlying connection. - -.. important:: Changing an App Config After Initializing the App - - .. versionchanged:: v10.18.0 - ``urlPrefix`` is not cached in the App configuration - - When you initialize the App client, the configuration is cached internally. - Attempting to close and then re-open an App with a changed configuration - within the same process has no effect. The client continues to use the - cached configuration. - - In Java SDK version 10.18.0 and later, the :ref:`urlPrefix ` - is *no longer* cached in the App configuration. This means that you can - change the ``urlPrefix``, and the App client will use the updated - configuration. In earlier SDK versions, changes to the ``urlPrefix`` in a - cached App configuration have no effect. diff --git a/source/sdk/java/app-services/mongodb-remote-access.txt b/source/sdk/java/app-services/mongodb-remote-access.txt deleted file mode 100644 index c8e6dd84db..0000000000 --- a/source/sdk/java/app-services/mongodb-remote-access.txt +++ /dev/null @@ -1,1027 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-mongodb-data-access: - -======================== -Query MongoDB - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -You can query data stored in MongoDB Atlas directly from your Android application code -by using the Realm Java SDK's :ref:`MongoClient ` -with the :manual:`Query API `. -Atlas App Services provides data access :ref:`rules ` on -collections to securely retrieve results based on the logged-in user or the -content of each document. - -The following actions enable access to a linked MongoDB Atlas cluster -from an Android application using the Realm SDK. - -.. include:: /includes/mongodb-data-access-query-filter-indeterminate-order-note.rst - -Use Cases ---------- - -There are a variety of reasons you might want to query a MongoDB data source. -Working with data in your client via Atlas Device Sync is not always practical or -possible. You might want to query MongoDB when: - -- The data set is large or the client device has constraints against loading - the entire data set -- You are :ref:`creating or updating custom user data - ` -- You are retrieving documents that are not modeled in Realm -- Your app needs to access collections that don't have strict schemas -- A non-Realm service generates collections that you want to access - -While not exhaustive, these are some common use cases for querying MongoDB -directly. - -Prerequisites -------------- - -Before you can query MongoDB from your Android application, you must set up -MongoDB Data Access in your App Services App. To learn how to set up your -backend App to let the Realm SDK query Atlas, -refer to :ref:`Set Up MongoDB Data Access ` -in the App Services documentation. - -.. _java-mongodb-set-up: - -Set Up Your Project -------------------- - -.. procedure:: - - .. step:: Set Up Your Project - - Follow the steps in the :ref:`Install the Realm Java SDK ` - guide. - - - .. step:: Link a MongoDB Atlas Service Cluster - - Follow the steps in the :ref:`Link a MongoDB data source ` - guide. Assign your service a meaningful name -- you'll need it to connect to - the cluster using the Realm SDK. - - - .. step:: Import Realm Dependencies - - For CRUD operations on a remote MongoDB collection, you will use one - or more of the following ``import`` statements: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. code-block:: java - :copyable: false - - // Base Realm Packages - import io.realm.mongodb.App; - import io.realm.mongodb.AppConfiguration; - // Realm Authentication Packages - import io.realm.mongodb.User; - import io.realm.mongodb.Credentials; - - // MongoDB Service Packages - import io.realm.mongodb.mongo.MongoClient; - import io.realm.mongodb.mongo.MongoDatabase; - import io.realm.mongodb.mongo.MongoCollection; - // Utility Packages - import org.bson.Document; - - .. tab:: - :tabid: kotlin - - .. code-block:: kotlin - :copyable: false - - // Base Realm Packages - import io.realm.mongodb.App - import io.realm.mongodb.AppConfiguration - // Realm Authentication Packages - import io.realm.mongodb.User - import io.realm.mongodb.Credentials - - // MongoDB Service Packages - import io.realm.mongodb.mongo.MongoClient - import io.realm.mongodb.mongo.MongoDatabase - import io.realm.mongodb.mongo.MongoCollection - // Utility Packages - import org.bson.Document - - - .. step:: Instantiate a MongoDB Collection Handle - - To connect to an instance of MongoDB, you'll need a user with access - to a MongoDB collection. :ref:`Log in to your application - ` as such a user, then use the following code - to instantiate a local MongoDB collection handle. - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.instantiate-a-mongodb-collection-handle.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.instantiate-a-mongodb-collection-handle.java - :language: java - :copyable: false - - .. note:: Using Custom Classes with MongoDB - - To use classes other than the built-in ``Document`` class with - MongoDB, you can add *codecs* to your ``MongoCollection`` instances. - In the above example, we add the ``PojoCodecProvider`` to support - Plain Old Java Objects (POJOs). Custom object support requires two - *codec providers*: - - - the default codec provider, which provides support for built-in - Java types (accessed through - ``AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY``) - - - ``PojoCodecProvider``, which automatically creates new codecs to - support POJO classes - - The SDK checks registries in order until one returns a codec for - the requested class. As a result, you should list the default codec - registry first, and the ``PojoCodecProvider`` should always be the - last CodecProvider since it can provide a codec for almost any - class. - -.. _java-mongodb-example-dataset: - -Example Data ------------- - -The following examples operate on a MongoDB collection that describes -inventory in a chain of plant stores. Consider the following collection -of documents describing various plants for sale in a store: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/Plant.snippet.plant.kt - :language: kotlin - :caption: Plant.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.example-data.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/Plant.snippet.plant.java - :language: java - :caption: Plant.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.example-data.java - :language: java - :copyable: false - -.. _java-mongodb-create-documents: - -Create Documents ----------------- - -These code snippets demonstrate how to insert one or more -documents into a MongoDB collection from a mobile application. Insert -operations take a document or documents to add to MongoDB as an argument -and return a :java-sdk:`RealmResultTask -` that resolves to an object that -contains the results of the execution of the operation. - -.. _java-mongodb-insertOne: - -Insert a Single Document -~~~~~~~~~~~~~~~~~~~~~~~~ - -You can insert a single document using -:java-sdk:`collection.insertOne() -`. - -The following snippet inserts a single document describing a "lily of the -valley" plant into a -:ref:`collection of documents that describe plants for sale in a group of stores -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.insert-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.insert-a-single-document.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully inserted a document with id: BsonObjectId{value=5f19...} - -.. _java-mongodb-insertMany: - -Insert Multiple Documents -~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can insert multiple documents at the same time using -:java-sdk:`collection.insertMany() -`. - -The following snippet inserts three documents describing plants into a -:ref:`collection of documents that describe plants for sale in a group of stores -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.insert-multiple-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.insert-multiple-documents.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully inserted 3 documents into the collection. - -.. _java-mongodb-read-documents: - -Read Documents --------------- - -These code snippets demonstrate how to read data stored in a MongoDB -collection from a mobile application. Read operations use :manual:`queries -` to specify which documents to -return from the database. Read operations return a -:android:`Task ` that resolves to -either a single matched document (in the case of ``findOne()``), a ``long`` -numeric value (in the case of ``count()``) or an iterator that allows you to -traverse the collection of matched documents (in the case of ``find()``). - -.. _java-mongodb-findOne: - -Find a Single Document -~~~~~~~~~~~~~~~~~~~~~~ - -You can find a single document using :java-sdk:`collection.findOne() -`. - -The following snippet finds a single document from the a -:ref:`collection of documents that describe plants for sale in a group of stores -` where the plant document's ``type`` -field contains the string value "perennial": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-a-single-document.java - :language: java - :copyable: false - -Running this snippet produces output similar to the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully found a document: Plant [id=5f18..., name=venus flytrap, sunlight=full, color=white, type=perennial, partition=Store 42] - -.. _java-mongodb-findMany: - -Find Multiple Documents -~~~~~~~~~~~~~~~~~~~~~~~ - -You can find multiple documents using :java-sdk:`collection.find() -`. - -The following snippet finds all documents in a -:ref:`collection of documents that describe plants for sale in a group of stores -` that contain a field named -``_partition`` with a value of "Store 42": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-multiple-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-multiple-documents.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully found all plants for Store 42: - V/EXAMPLE: Plant [id=5f18..., name=venus flytrap, sunlight=full, color=white, type=perennial, partition=Store 42] - V/EXAMPLE: Plant [id=5f18..., name=sweet basil, sunlight=partial, color=green, type=annual, partition=Store 42] - V/EXAMPLE: Plant [id=5f18..., name=thai basil, sunlight=partial, color=green, type=perennial, partition=Store 42] - V/EXAMPLE: Plant [id=5f18..., name=helianthus, sunlight=full, color=yellow, type=annual, partition=Store 42] - -.. _java-mongodb-count: - -Count Documents in the Collection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can count documents in a collection using -:java-sdk:`collection.count() -`. -You can specify an optional query to -determine which documents to count. If you don't specify a query, the -action counts all documents in the collection. - -The following snippet counts the number of documents in a -:ref:`collection of documents that describe plants for sale in a group of stores -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.count-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.count-documents.java - :language: java - :copyable: false - - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully counted, number of documents in the collection: 5 - -.. _java-mongodb-update-documents: - -Update Documents ----------------- - -These code snippets demonstrate how to update data stored in a MongoDB -collection from a mobile application. Update operations use queries -to specify which documents to update and :manual:`update operators -` to describe how to mutate documents that -match the query. Update operations return a :android:`Task -` that resolves to an object -that contains the results of the execution of the operation. - -.. _java-mongodb-updateOne: - -Update a Single Document -~~~~~~~~~~~~~~~~~~~~~~~~ - -You can update a single document using -:java-sdk:`collection.updateOne() -`. - -The following snippet updates a single document in a -:ref:`collection of documents that describe plants for sale in a group of stores -`. This operation queries for a document -where the ``name`` field contains the value "petunia" and changes the value -of the first matched document's ``sunlight`` field to "partial": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.update-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.update-a-single-document.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully updated a document. - -.. _java-mongodb-updateMany: - -Update Multiple Documents -~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can update multiple documents using -:java-sdk:`collection.updateMany() -`. - -The following snippet updates multiple documents in a -:ref:`collection of documents that describe plants for sale in a group of stores -`. This operation queries for documents -where the ``_partition`` field contains the value "Store 47" and changes -the value of the ``_partition`` field of each matching document to "Store 51": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.update-multiple-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.update-multiple-documents.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully updated 2 documents. - -.. _java-mongodb-upsert: - -Upsert Documents -~~~~~~~~~~~~~~~~ - -If an update operation does not match any document in the collection, -you can automatically insert a single new document into the collection -that matches the update query by setting the ``upsert`` option to -``true``. - -The following snippet updates a document in a -:ref:`collection of documents that describe plants for sale in a group of stores -` or inserts a -new document if no document matches the query. This operation -queries for documents where: - -- the ``sunlight`` field has a value of "full" -- the ``type`` field has a value of "perennial" -- the ``color`` field has a value of "green" -- the ``_partition`` field has a value of "Store 47" - -Because this snippet sets the ``upsert`` option to ``true``, if no -document matches the query, MongoDB creates a new document that includes -both the query and specified updates: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.upsert-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.upsert-a-single-document.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully upserted a document with id: BsonObjectId{value=5f19...} - -.. _java-mongodb-delete-documents: - -Delete Documents ----------------- - -These code snippets demonstrate how to delete documents that -are stored in a MongoDB collection from a mobile application. -Delete operations use a query to specify which documents to delete -and return a :android:`Task ` -that resolves to an object that contains the results of the execution -of the operation. - -.. _java-mongodb-deleteOne: - -Delete a Single Document -~~~~~~~~~~~~~~~~~~~~~~~~ - -You can delete a single document from a collection using -:java-sdk:`collection.deleteOne() -`. - -The following snippet deletes one document in a -:ref:`collection of documents that describe plants for sale in a group of stores -`. This operation queries for a -document where the ``color`` field has a value of "green" and deletes -the first document that matches the query: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.delete-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.delete-a-single-document.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully deleted a document. - -.. _java-mongodb-deleteMany: - -Delete Multiple Documents -~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can delete multiple items from a collection using -:java-sdk:`collection.deleteMany() -`. - -The following snippet deletes all documents in a -:ref:`collection of documents that describe plants for sale in a group of stores -` -that match the query that matches documents containing both -a ``sunlight`` field value of "full" and a ``type`` field value of -"annual". - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.delete-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.delete-documents.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: succcessfully deleted 2 documents. - -.. _java-mongodb-watch: - -Watch for Changes ------------------ - -These code snippets demonstrate how to configure and run -:manual:`watch ` operations on a -collection. - -.. include:: /includes/serverless-watch-note.rst - -Watch for Changes in a Collection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can open a stream of changes made to a collection by calling -:java-sdk:`collection.watch() -` or -:java-sdk:`collection.watchAsync() -`. You can -watch for changes to specific documents in a collection by passing the -object ids of the objects you would like to monitor as a -`variable number of arguments -`__. - -The following snippet watches for changes to any documents in the -``plants`` collection: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.watch-documents.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.watch-documents.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully inserted a document with id BsonObjectId{value=5f6bb...} - V/EXAMPLE: Event type: INSERT full document: Plant [id=5f6bb..., name=triffid, sunlight=low, color=green, type=perennial, partition=Store 47] - -.. _java-mongodb-watch-with-filter: - -Watch for Changes in a Collection with a Filter -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can open a stream of changes made to documents in a collection that -fulfill certain criteria by calling :java-sdk:`collection.watchWithFilter() -` or -:java-sdk:`collection.watchWithFilterAsync() -`. -Both methods accept a ``Document`` or ``BsonDocument`` parameter that is -used as the query of a :manual:`$match operator -` to process each -:ref:`database event ` that occurs while watching the -collection. - -The following snippet watches for changes to documents in the -``plants`` collection, but only triggers the provided callback for -events corresponding to documents belonging to the partition named -"Store 42": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.watch-documents-with-filter.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.watch-documents-with-filter.java - :language: java - :copyable: false - -Running this snippet produces output resembling the following: - -.. code-block:: text - :copyable: false - - V/EXAMPLE: successfully inserted 2 documents into the collection - V/EXAMPLE: Event type: INSERT full document: Plant [id=5f6bb..., name=venomous tentacula, sunlight=low, color=brown, type=annual, partition=Store 42] - -.. _java-mongodb-aggregation-stages: -.. _java-mongodb-aggregate: -.. _java-mongodb-aggregation-pipelines: - -Aggregate Documents in a Collection ------------------------------------ - -Aggregation operations run all documents in a collection through a -series of data aggregation stages called an :manual:`aggregation -pipeline `. Aggregation allows you to filter -and transform documents, collect summary data about groups of related -documents, and other complex data operations. - -You can execute an aggregation pipeline using -:java-sdk:`collection.aggregate() -`. - -An aggregation operation accepts a list of aggregation stages as input -and returns a -:android:`Task ` that -resolves to a collection of documents processed by the pipeline. - -.. _java-mongodb-aggregation-filter-documents: - -Filter Documents -~~~~~~~~~~~~~~~~ - -You can use the :manual:`$match -` stage to filter -documents according to a Query API :manual:`query filter -`. - -.. code-block:: javascript - :copyable: false - - { - "$match": { - "": , - ... - } - } - -.. example:: - - The following ``$match`` stage filters documents to include - only those where the ``type`` field has a value equal to "perennial": - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-filter.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-filter.java - :language: java - :copyable: false - -.. _java-mongodb-aggregation-group-documents: - -Group Documents -~~~~~~~~~~~~~~~ - -You can use the :manual:`$group -` stage to aggregate summary -data for one or more documents. MongoDB groups documents based -on the expression defined in the ``_id`` field value of the ``$group`` -stage. You can reference a specific document field by prefixing the -field name with a ``$``. - -The following snippet groups all documents in the ``plants`` -collection by their ``type`` value and aggregates a count of the -number of each type: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-group.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-group.java - :language: java - :copyable: false - -.. _java-mongodb-aggregation-project-document-fields: - -Project Document Fields -~~~~~~~~~~~~~~~~~~~~~~~ - -You can use the :manual:`$project -` stage to include or omit -specific fields from documents. Additionally, you can calculate new -fields using :manual:`aggregation operators -`. Projections work in two ways: - -- Explicitly include fields with a value of 1. This has the side-effect - of implicitly excluding all unspecified fields. - -- Implicitly exclude fields with a value of 0. This has the side-effect - of implicitly including all unspecified fields. - -These two methods of projection are mutually exclusive: if you -explicitly include fields, you cannot explicitly exclude fields, and -vice versa. - -.. note:: - - The ``_id`` field is a special case: it is always included in every - query unless explicitly specified otherwise. For this reason, you - *can* exclude the ``_id`` field with a ``0`` value while simultaneously - including other fields, like ``_partition``, with a ``1``. Only the - special case of exclusion of the ``_id`` field allows both exclusion - and inclusion in one ``$project`` stage. - -.. code-block:: javascript - :copyable: false - - { - "$project": { - "": <0 | 1 | Expression>, - ... - } - } - -.. example:: - - The following ``$project`` stage omits the ``_id`` field, includes - the ``name`` field, and creates a new field named ``storeNumber``. - The ``storeNumber`` is generated using two aggregation operators: - - 1. ``$split`` separates the ``_partition`` value into two string - segments surrounding the space character. For example, the value - "Store 42" split in this way returns an array with two elements: - "Store" and "42". - - 2. ``$arrayElemAt`` selects a specific element from an array based - on the second argument. In this case, the value ``1`` selects the - second element from the array generated by the ``$split`` operator - since arrays index from ``0``. For example, the value ["Store", "42"] - passed to this operation would return a value of "42". - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-project.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-project.java - :language: java - :copyable: false - -.. _java-mongodb-aggregation-add-fields-to-documents: - -Add Fields to Documents -~~~~~~~~~~~~~~~~~~~~~~~ - -You can use the :manual:`$addFields -` stage to add new fields -with calculated values using :manual:`aggregation operators -`. - -.. note:: - - ``$addFields`` is similar to :manual:`$project - ` but does not allow you to - include or omit fields. - -.. example:: - - The following ``$addFields`` stage creates a new field named - ``storeNumber`` where the value is the output of two aggregate operators - that transform the value of the ``_partition`` field. - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-addfields.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-addfields.java - :language: java - :copyable: false - -.. _java-mongodb-aggregation-unwind-array-values: - -Unwind Array Values -~~~~~~~~~~~~~~~~~~~ - -You can use the :manual:`$unwind -` stage to transform a single -document containing an array into multiple documents containing individual -values from that array. When you unwind an array field, -MongoDB copies each document once for each element of the array field -but replaces the array value with the array element in each copy. - -.. code-block:: javascript - :copyable: false - - { - $unwind: { - path: , - includeArrayIndex: , - preserveNullAndEmptyArrays: - } - } - -.. example:: - - The following ``$unwind`` stage creates a new document for each - element of the ``items`` array in each document. It also adds a field - called ``itemIndex`` to each new document that specifies the - element's position index in the original array: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-unwind-arrays.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.aggregate-documents-unwind-arrays.java - :language: java - :copyable: false - -Consider the following document from the a collection of purchases: - -.. code-block:: javascript - :copyable: false - - { - _id: 123, - customerId: 24601, - items: [ - { name: "Baseball", quantity: 5 }, - { name: "Baseball Mitt", quantity: 1 }, - { name: "Baseball Bat", quantity: 1 }, - ] - } - -If we apply the example ``$unwind`` stage to this document, the stage -outputs the following three documents: - -.. code-block:: javascript - :copyable: false - - { - _id: 123, - customerId: 24601, - itemIndex: 0, - items: { name: "Baseball", quantity: 5 } - }, { - _id: 123, - customerId: 24601, - itemIndex: 1, - items: { name: "Baseball Mitt", quantity: 1 } - }, { - _id: 123, - customerId: 24601, - itemIndex: 2, - items: { name: "Baseball Bat", quantity: 1 } - } diff --git a/source/sdk/java/async-api.txt b/source/sdk/java/async-api.txt deleted file mode 100644 index fe4dea185a..0000000000 --- a/source/sdk/java/async-api.txt +++ /dev/null @@ -1,234 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-async-api: - -=========================== -Asynchronous API - Java SDK -=========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -The Java SDK lets you access network and disk -resources in two ways: **synchronously** and **asynchronously**. While -synchronous, or "sync", requests block execution until the request returns -success or failure, asynchronous, or "async", requests assign a -callback and proceed execution to the next line of code. When -the request returns, the callback runs to process results. -In the callback, you can check if the request executed -successfully and either access the returned results or the returned -error. - -.. _java-async-calls: - -Asynchronous Calls ------------------- - -Asynchronous API requests in the SDK end with the suffix "Async". -There are several different ways an asynchronous request can behave, -depending on which part of the SDK you're using. - -.. _java-realm-callback: - -Realm.Callback -~~~~~~~~~~~~~~ - -Asynchronous calls to open a realm, both with and without Sync, -use a final parameter of type :java-sdk:`Realm.Callback -`. To retrieve returned values after the -request completes, implement the ``onSuccess()`` method in the callback -object passed as the final parameter to these asynchronous methods. You -should also implement the ``onError()`` method to handle request failures, -but it is not required. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-callback.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-callback.kt - :language: kotlin - :copyable: false - -.. _java-app-callback: - -App.Callback -~~~~~~~~~~~~ - -When you query Atlas App Services like :ref:`Functions -` and :ref:`user authentication -`, asynchronous calls accept a final -parameter of type :java-sdk:`App.Callback -`. -You can handle this callback with a lambda function that accepts a -single parameter of type :java-sdk:`App.Result -`. To retrieve a returned values from -``App.Callback`` requests: - -1. Use the ``isSuccess()`` method of the ``App.Result`` passed to the - callback function to determine if the query completed - successfully. - -#. If the query was successful, use the ``get()`` method to retrieve - the result of the query. If the query failed, use ``getError()`` to - retrieve the exception that caused the query to fail. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.anonymous.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.anonymous.kt - :language: kotlin - :copyable: false - -.. _java-realm-async-task: - -RealmAsyncTask -~~~~~~~~~~~~~~ - -Asynchronous calls to :ref:`execute transactions -` on a realm return -an instance of :java-sdk:`RealmAsyncTask -`. You can optionally :java-sdk:`specify an error -handler ` or a -:java-sdk:`success notification -` for ``RealmAsyncTask`` by -passing additional parameters to the asynchronous call. Additionally, -you use the :java-sdk:`cancel() ` -method to stop a transaction from completing. The lambda function passed -to a ``RealmAsyncTask`` contains the write operations to include in the -transaction. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-async-task.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-async-task.kt - :language: kotlin - :copyable: false - -.. _java-realm-results: - -RealmResults -~~~~~~~~~~~~ - -Asynchronous reads from a realm using :java-sdk:`findAllAsync() -` immediately return an empty -:java-sdk:`RealmResults ` instance. The SDK -executes the query on a background thread and populates the -``RealmResults`` instance with the results when the query completes. You -can register a listener with :java-sdk:`addChangeListener() -` -to receive a notification when the query completes. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-results.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.realm-results.kt - :language: kotlin - :copyable: false - -.. _java-realm-result-task: - -RealmResultTask -~~~~~~~~~~~~~~~ - -Asynchronous :ref:`queries to Atlas -` return an instance of -:java-sdk:`RealmResultTask `. -You can cancel ``RealmResultTask`` instances just like -``RealmAsyncTask``. To access the values returned by your query, you -can use: - -- :java-sdk:`get() ` to - block until the operation completes - -- :java-sdk:`getAsync() - ` - to handle the result via an :ref:`App.Callback ` - instance - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-a-single-document.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MongoDBDataAccessTest.snippet.find-a-single-document.java - :language: java - :copyable: false - -.. _java-coroutines: - -Coroutines ----------- - -The SDK provides a set of :kotlin-ext:`Kotlin extensions <>` to request -asynchronously using coroutines and flows instead of callbacks. You can -use these extensions to :kotlin-ext:`execute transactions -`, -:kotlin-ext:`watch for changes -`, :kotlin-ext:`read -`, -and :kotlin-ext:`write -`. - -.. literalinclude:: /examples/generated/java/local/AsyncTest.snippet.coroutines.kt - :language: kotlin - :copyable: false - -.. tip:: Kotlin Flows use Frozen Objects Across Multiple Threads - - The ``toFlow()`` extension method passes :ref:`frozen - ` Realm objects to safely - communicate between threads. - -.. seealso:: - - The SDK also includes Kotlin extensions that make specifying type - parameters for Realm :kotlin-ext:`reads - ` and - :kotlin-ext:`writes - ` easier. diff --git a/source/sdk/java/crud.txt b/source/sdk/java/crud.txt deleted file mode 100644 index 5c1958e1fe..0000000000 --- a/source/sdk/java/crud.txt +++ /dev/null @@ -1,135 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-read-and-write-data: - -=============== -CRUD - Java SDK -=============== - -.. toctree:: - :titlesonly: - - Create - Read - Update - Delete - Filter Data - Threading - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java-write-operations: -.. _java-realm-database-writes: -.. _java-write-transactions: - -Write Operations ----------------- - -You can **create** objects in a realm, -**update** objects in a realm, and eventually **delete** -objects from a realm. Because these operations modify the -state of the realm, we call them writes. - -Realm handles writes in terms of **transactions**. A -transaction is a list of read and write operations that -Realm treats as a single indivisible operation. In other -words, a transaction is *all or nothing*: either all of the -operations in the transaction succeed or none of the -operations in the transaction take effect. - -.. note:: - - All writes must happen in a transaction. - -A realm allows only one open write transaction at a time. Realm -blocks other writes on other threads until the open -transaction is complete. Consequently, there is no race -condition when reading values from the realm within a -transaction. - -When you are done with your transaction, Realm either -**commits** it or **cancels** it: - -- When Realm **commits** a transaction, Realm writes - all changes to disk. For synced realms, Realm queues the change - for synchronization with Atlas App Services. -- When Realm **cancels** a write transaction or an operation in - the transaction causes an error, all changes are discarded - (or "rolled back"). - -.. tip:: Realm Object Writes are File Writes - - Whenever you create, update, or delete a Realm object, - your changes update the representation of that object in - Realm and emit - :ref:`notifications ` to any subscribed - listeners. As a result, you should only write to Realm - objects when necessary to persist data. - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -.. _java-managed-objects: - -Managed Objects ---------------- - -**Managed objects** are live Realm objects that update -based on changes to underlying data in Realm. Managed -objects can only come from an open realm, and receive updates -as long as that realm remains open. Managed objects *cannot be passed -between threads*. - -.. _java-unmanaged-objects: - -Unmanaged objects ------------------ - -**Unmanaged objects** are instances of Realm objects that are -not live. You can get an unmanaged object by manually constructing a -Realm object yourself, or by calling -:java-sdk:`Realm.copyFromRealm() `. -Unmanaged objects *can be passed between threads*. - -.. _java-open-a-transaction: - -Run a Transaction ------------------ - -Realm represents each transaction as a callback function -that contains zero or more read and write operations. To run -a transaction, define a transaction callback and pass it to -the realm's ``write`` method. Within this callback, you are -free to create, read, update, and delete on the realm. If -the code in the callback throws an exception when Realm runs -it, Realm cancels the transaction. Otherwise, Realm commits -the transaction immediately after the callback. - -.. example:: - - The following code shows how to run a transaction with - :java-sdk:`executeTransaction() ` - or :java-sdk:`executeTransactionAsync() `. - If the code in the callback throws an exception, Realm - cancels the transaction. Otherwise, Realm commits the - transaction. - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.run-a-transaction.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.run-a-transaction.java - :language: java - :copyable: false diff --git a/source/sdk/java/crud/create.txt b/source/sdk/java/crud/create.txt deleted file mode 100644 index 97c15451fb..0000000000 --- a/source/sdk/java/crud/create.txt +++ /dev/null @@ -1,111 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-create-objects: - -======================== -CRUD - Create - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -About the Examples on this Page -------------------------------- - -The examples on this page use the data model of a project -management app that has two Realm object types: ``Project`` -and ``Task``. A ``Project`` has zero or more ``Tasks``. - -See the schema for these two classes, ``Project`` and -``Task``, below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.kt - :language: kotlin - :caption: ProjectTask.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.kt - :language: kotlin - :caption: Project.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.java - :language: java - :caption: ProjectTask.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.java - :language: java - :caption: Project.java - :copyable: false - -.. _java-create-a-new-object: - -Create a New Object -------------------- - -Use :java-sdk:`realm.createObject() ` -in a transaction to create a persistent instance of a Realm object in a -realm. You can then modify the returned object with other field values -using accessors and mutators. - -The following example demonstrates how to create an object with -:java-sdk:`createObject() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.create-an-object.kt - :language: kotlin - :emphasize-lines: 3 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.create-an-object.java - :language: java - :emphasize-lines: 3 - :copyable: false - -You can also insert objects into a realm from JSON. Realm -supports creating objects from ``String``, -:android:`JSONObject `, and -:android:`InputStream ` types. -Realm ignores any properties present in the JSON that are -not defined in the Realm object schema. - -The following example demonstrates how to create a single object from JSON with -:java-sdk:`createObjectFromJson() ` -or multiple objects from JSON with -:java-sdk:`createAllFromJson() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.create-an-object-json.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.create-an-object-json.java - :language: java - :copyable: false diff --git a/source/sdk/java/crud/delete.txt b/source/sdk/java/crud/delete.txt deleted file mode 100644 index e001241e5b..0000000000 --- a/source/sdk/java/crud/delete.txt +++ /dev/null @@ -1,230 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -======================== -CRUD - Delete - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -About the Examples on this Page -------------------------------- - -The examples on this page use the data model of a project -management app that has two Realm object types: ``Project`` -and ``Task``. A ``Project`` has zero or more ``Tasks``. - -See the schema for these two classes, ``Project`` and -``Task``, below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.kt - :language: kotlin - :caption: ProjectTask.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.kt - :language: kotlin - :caption: Project.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.java - :language: java - :caption: ProjectTask.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.java - :language: java - :caption: Project.java - :copyable: false - -.. _java-delete-an-object: - -Delete an Object ----------------- - -To delete an object from a realm, use either the dynamic or static -versions of the ``deleteFromRealm()`` method of a :java-sdk:`RealmObject -` subclass. - -The following example shows how to delete one object from -its realm with :java-sdk:`deleteFromRealm() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-an-object.kt - :language: kotlin - :emphasize-lines: 6 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-an-object.java - :language: java - :emphasize-lines: 4 - :copyable: false - -.. tip:: Do not use objects after delete - - The SDK throws an error if you try to use an object after - it has been deleted. - -.. _java-delete-multiple-objects: - -Delete Multiple Objects ------------------------ - -To delete an object from a realm, use the ``deleteAllFromRealm()`` -method of the :java-sdk:`RealmResults ` -instance that contains the objects you would like to delete. You can -filter the ``RealmResults`` down to a subset of objects using the -:java-sdk:`where() ` method. - -The following example demonstrates how to delete a -collection from a realm with :java-sdk:`deleteAllFromRealm() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-a-collection.kt - :language: kotlin - :emphasize-lines: 6 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-a-collection.java - :language: java - :emphasize-lines: 4 - :copyable: false - -.. _java-delete-object-and-dependent-objects: - -Delete an Object and its Dependent Objects ------------------------------------------- - -Sometimes, you have :ref:`dependent objects -` that you want to delete when -you delete the parent object. We call this a **chaining -delete**. Realm does not delete the dependent -objects for you. If you do not delete the objects yourself, -they will remain orphaned in your realm. Whether or not -this is a problem depends on your application's needs. - -Currently, the best way to delete dependent objects is to -iterate through the dependencies and delete them before -deleting the parent object. - -The following example demonstrates how to perform a -chaining delete by first deleting all of Ali's turtles, -then deleting Ali: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.cascading-deletes.kt - :language: kotlin - :emphasize-lines: 6 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.cascading-deletes.java - :language: java - :emphasize-lines: 5 - :copyable: false - -.. _java-delete-all-object-of-a-specific-type: - -Delete All Objects of a Specific Type -------------------------------------- - -Realm supports deleting all instances of a :ref:`Realm type -` from a realm. - -The following example demonstrates how to delete all -Turtle instances from a realm with :java-sdk:`delete() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-all-instances-of-a-type.kt - :language: kotlin - :emphasize-lines: 2 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-all-instances-of-a-type.java - :language: java - :emphasize-lines: 2 - :copyable: false - -.. _java-delete-all-objects-in-a-realm: - -Delete All Objects in a Realm ------------------------------ - -It is possible to delete all objects from the realm. This -does not affect the schema of the realm. This is useful for -quickly clearing out your realm while prototyping. - -The following example demonstrates how to delete everything -from a realm with :java-sdk:`deleteAll() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-all.kt - :language: kotlin - :emphasize-lines: 2 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.delete-all.java - :language: java - :emphasize-lines: 2 - :copyable: false - -Delete an Object Using an Iterator ----------------------------------- - -Because realm collections always reflect the latest state, they -can appear, disappear, or change while you iterate over a collection. -To get a stable collection you can iterate over, you can create a -**snapshot** of a collection's data. A snapshot guarantees the order of -elements will not change, even if an element is deleted. - -For an example, refer to :ref:`java-iteration`. diff --git a/source/sdk/java/crud/filter-data.txt b/source/sdk/java/crud/filter-data.txt deleted file mode 100644 index dfd78f9670..0000000000 --- a/source/sdk/java/crud/filter-data.txt +++ /dev/null @@ -1,650 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-filter-data: - -====================== -Filter Data - Java SDK -====================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java-client-query-engine: - -Query Engine ------------- - -To filter data in your realm, use the Realm query engine. - -There are two ways to access the query engine with the Java SDK: - -- :ref:`Fluent interface ` -- :ref:`Realm Query Language ` - -.. _java-query-fluent-interface: - -Fluent Interface ----------------- - -The Java SDK uses a :wikipedia:`Fluent interface ` -to construct multi-clause queries that are passed to the query engine. - -See `RealmQuery API -`__ -for a complete list of available methods. - -There are several types of operators available to filter a -:ref:`Realm collection `. -Filters work by **evaluating** an operator expression for -every object in the collection being -filtered. If the expression resolves to ``true``, Realm -Database includes the object in the results collection. - -An **expression** consists of one of the following: - -- The name of a property of the object currently being evaluated. -- An operator and up to two argument expression(s). -- A literal string, number, or date. - -About the Examples In This Section -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The examples in this section use a simple data set for a -task list app. The two Realm object types are ``Project`` -and ``Task``. A ``Task`` has a name, assignee's name, and -completed flag. There is also an arbitrary number for -priority (higher is more important) and a count of -minutes spent working on it. A ``Project`` has zero or more -``Tasks``. - -See the schema for these two classes, ``Project`` and -``Task``, below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.kt - :language: kotlin - :caption: ProjectTask.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.kt - :language: kotlin - :caption: Project.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.java - :language: java - :caption: ProjectTask.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.java - :language: java - :caption: Project.java - :copyable: false - -Comparison Operators -~~~~~~~~~~~~~~~~~~~~ - -The most straightforward operation in a search is to compare -values. - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - Operator - - Description - - * - ``between`` - - Evaluates to ``true`` if the left-hand numerical or date expression is between or equal to the right-hand range. For dates, this evaluates to ``true`` if the left-hand date is within the right-hand date range. - - * - | ``equalTo`` - - Evaluates to ``true`` if the left-hand expression is equal to the right-hand expression. - - * - | ``greaterThan`` - - Evaluates to ``true`` if the left-hand numerical or date expression is greater than the right-hand numerical or date expression. For dates, this evaluates to ``true`` if the left-hand date is later than the right-hand date. - - * - | ``greaterThanOrEqualTo`` - - Evaluates to ``true`` if the left-hand numerical or date expression is greater than or equal to the right-hand numerical or date expression. For dates, this evaluates to ``true`` if the left-hand date is later than or the same as the right-hand date. - - * - ``in`` - - Evaluates to ``true`` if the left-hand expression is in the right-hand list. - - * - | ``lessThan`` - - Evaluates to ``true`` if the left-hand numerical or date expression is less than the right-hand numerical or date expression. For dates, this evaluates to ``true`` if the left-hand date is earlier than the right-hand date. - - * - | ``lessThanOrEqualTo`` - - Evaluates to ``true`` if the left-hand numeric expression is less than or equal to the right-hand numeric expression. For dates, this evaluates to ``true`` if the left-hand date is earlier than or the same as the right-hand date. - - * - | ``notEqualTo`` - - Evaluates to ``true`` if the left-hand expression is not equal to the right-hand expression. - -.. example:: - - The following example uses the query engine's - comparison operators to: - - - Find high priority tasks by comparing the value of the ``priority`` property value with a threshold number, above which priority can be considered high. - - Find just-started or short-running tasks by seeing if the ``progressMinutes`` property falls within a certain range. - - Find unassigned tasks by finding tasks where the ``assignee`` property is equal to ``null``. - - Find tasks assigned to specific teammates Ali or Jamie by seeing if the ``assignee`` property is in a list of names. - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.comparison-operators.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.comparison-operators.java - :language: java - :copyable: false - -Logical Operators -~~~~~~~~~~~~~~~~~ - -You can make compound predicates using logical operators. - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - Operator - - Description - - * - | ``and`` - - Evaluates to ``true`` if both left-hand and right-hand expressions are ``true``. - - * - | ``not`` - - Negates the result of the given expression. - - * - | ``or`` - - Evaluates to ``true`` if either expression returns ``true``. - -.. example:: - - We can use the query language's logical operators to find - all of Ali's completed tasks. That is, we find all tasks - where the ``assignee`` property value is equal to 'Ali' AND - the ``isComplete`` property value is ``true``: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.logical-operators.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.logical-operators.java - :language: java - :copyable: false - -.. _java-string-operators: - -String Operators -~~~~~~~~~~~~~~~~ - -You can compare string values using these string operators. -Regex-like wildcards allow more flexibility in search. - -.. list-table:: - :header-rows: 1 - :widths: 40 60 - - * - Operator - - Description - - * - | ``beginsWith`` - - Evaluates to ``true`` if the left-hand string expression begins with the right-hand string expression. This is similar to ``contains``, but only matches if the left-hand string expression is found at the beginning of the right-hand string expression. - - * - ``contains`` - - Evaluates to ``true`` if the left-hand string expression is found anywhere in the right-hand string expression. - - * - | ``endsWith`` - - Evaluates to ``true`` if the left-hand string expression ends with the right-hand string expression. This is similar to ``contains``, but only matches if the left-hand string expression is found at the very end of the right-hand string expression. - - * - | ``like`` - - Evaluates to ``true`` if the left-hand string expression - matches the right-hand string wildcard string - expression. A wildcard string expression is a string - that uses normal characters with two special wildcard - characters: - - - The ``*`` wildcard matches zero or more of any character - - The ``?`` wildcard matches any character. - - For example, the wildcard string "d?g" matches "dog", - "dig", and "dug", but not "ding", "dg", or "a dog". - - * - | ``equalTo`` - - Evaluates to ``true`` if the left-hand string is lexicographically equal to the right-hand string. - -.. example:: - - We use the query engine's string operators to find - projects with a name starting with the letter 'e' and - projects with names that contain 'ie': - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.string-operators.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.string-operators.java - :language: java - :copyable: false - -.. note:: Case-insensitive Character Limitations - - Case-insensitive string operators only support the - ``Latin Basic``, ``Latin Supplement``, ``Latin Extended A``, and - ``Latin Extended B (UTF-8 range 0–591)`` character sets. Setting - the case insensitive flag in queries when using ``equalTo``, - ``notEqualTo``, ``contains``, ``endsWith``, ``beginsWith``, or - ``like`` only works on English locale characters. - -Aggregate Operators -~~~~~~~~~~~~~~~~~~~ - -You can apply an aggregate operator to a collection property -of a Realm object. Aggregate operators traverse a -:ref:`collection ` and reduce it -to a single value. - -.. list-table:: - :header-rows: 1 - :widths: 40 60 - - * - Operator - - Description - - * - | ``average`` - - Evaluates to the average value of a given numerical property across a collection. - - * - | ``count`` - - Evaluates to the number of objects in the given collection. - - * - | ``max`` - - Evaluates to the highest value of a given numerical property across a collection. - - * - | ``min`` - - Evaluates to the lowest value of a given numerical property across a collection. - - * - | ``sum`` - - Evaluates to the sum of a given numerical property across a collection. - -.. example:: - - We create a couple of filters to show different facets of - the data: - - - Projects with average tasks priority above 5. - - Long running projects. - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.aggregate-operators.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.aggregate-operators.java - :language: java - :copyable: false - -Filter, Sort, Limit, Unique, and Chain Queries ----------------------------------------------- - -About the Examples in This Section -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The examples in this section use two Realm object types: ``Teacher`` -and ``Student``. - -See the schema for these two classes below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/TeacherKt.snippet.complete.kt - :language: kotlin - :caption: Teacher.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/local/StudentKt.snippet.complete.kt - :language: kotlin - :caption: Student.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/Teacher.snippet.complete.java - :language: java - :caption: Teacher.java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/Student.snippet.complete.java - :language: java - :caption: Student.java - :copyable: false - -.. _java-client-filters: - -Filters -~~~~~~~ - -You can build filters using the operator methods of the -:wikipedia:`fluent interface ` exposed by the -:java-sdk:`RealmQuery ` class: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.filters.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.filters.java - :language: java - :copyable: false - -This gives you a new instance of the class :java-sdk:`RealmResults `, -containing teachers with the name "Ms. Langtree" or "Mrs. Jacobs". - -``RealmQuery`` includes several methods that can execute queries: - -- :java-sdk:`findAll() ` blocks until - it finds all objects that meet the query conditions - -- :java-sdk:`findAllAsync() ` - returns immediately and finds all objects that meet the query - conditions asynchronously on a background thread - -- :java-sdk:`findFirst() ` blocks - until it finds the first object that meets the query conditions - -- :java-sdk:`findFirstAsync() ` - returns immediately and finds the first object that meets the query - conditions asynchronously on a background thread - -Queries return a list of references to the matching Realm -objects using the :ref:`RealmResults ` type. - -.. _java-link-queries: - -Link Queries -````````````` - -When referring to an object property, you can use **dot notation** to refer -to child properties of that object. You can refer to the properties of -:ref:`embedded objects ` and :ref:`relationships -` with dot notation. - -For example, consider a query for all teachers with a student named -"Wirt" or "Greg": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.link-queries.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.link-queries.java - :language: java - :copyable: false - -You can even use dot notation to query inverse relationships: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.link-queries-inverse.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.link-queries-inverse.java - :language: java - :copyable: false - -.. _java-sort-results: - -Sort Results -~~~~~~~~~~~~ - -.. important:: - - Realm applies the ``distinct()``, ``sort()`` and - ``limit()`` methods in the order you specify. Depending on the - data set this can alter the query result. Generally, you should - apply ``limit()`` last to avoid unintended result sets. - -You can define the order of query results using the -:java-sdk:`sort() ` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.sort.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.sort.java - :language: java - :copyable: false - -Sorts organize results in ascending order by default. To organize results -in descending order, pass ``Sort.DESCENDING`` as a second argument. -You can resolve sort order ties between identical property values -by passing an array of properties instead of a single property: in the -event of a tie, Realm sorts the tied objects by subsequent -properties in order. - -.. note:: String Sorting Limitations - - Realm uses non-standard sorting for upper and lowercase - letters, sorting them together rather than sorting uppercase first. - As a result, ``'- !"#0&()*,./:;?_+<=>123aAbBcC...xXyYzZ`` is the - actual sorting order in Realm. Additionally, sorting - strings only supports the ``Latin Basic``, ``Latin Supplement``, - ``Latin Extended A``, and ``Latin Extended B (UTF-8 range 0–591)`` - character sets. - -.. _java-limit-results: - -Limit Results -~~~~~~~~~~~~~ - -You can cap the number of query results to a specific maximum number -using the :java-sdk:`limit() ` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.limit.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.limit.java - :language: java - :copyable: false - -Limited result collections automatically update like any other query -result. Consequently, objects might drop out of the collection as -underlying data changes. - -.. tip:: Pagination is Not Necessary for Realm Optimization - - Some databases encourage paginating results with limits to avoid - reading unnecessary data from disk or using too much memory. - - Since Realm queries are lazy, there is no need to - take such measures. Realm only loads objects from query - results when they are explicitly accessed. - -.. tip:: Deleted Notifications in Limited Results - - :ref:`Collection notifications ` - report objects as deleted when they drop out of the result set. - This does not necessarily mean that they have been deleted from the - underlying realm, just that they are no longer part of the - query result. - -.. _java-unique-results: - -Unique Results -~~~~~~~~~~~~~~ - -You can reduce query results to unique values for a given field or fields -using the :java-sdk:`distinct() -` method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.unique.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.unique.java - :language: java - :copyable: false - -You can only call ``distinct()`` on integer, long, short, and ``String`` -fields; other field types will throw an exception. As with sorting, -you can specify multiple fields to resolve ties. - -.. _java-chain-queries: - -Chain Queries -~~~~~~~~~~~~~ - -You can apply additional filters to a results collection by calling the -:java-sdk:`where() ` method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.chain-queries.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.chain-queries.java - :language: java - :copyable: false - -The ``where()`` method returns a ``RealmQuery`` that you can resolve into -a ``RealmResults`` using a ``find`` method. Filtered results can only -return objects of the same type as the original results set, but are -otherwise able to use any :ref:`filters `. - -.. _java-filter-with-realm-query-language: -.. _java-realm-query-language: - -Query with Realm Query Language -------------------------------- - -.. versionadded:: 10.4.0 - -You can also query realms using Realm Query Language, a string-based -query language to constrain searches when retrieving objects from a realm. - -You can use :java-sdk:`RealmQuery.rawPredicate() -`. -For more information about syntax, usage and limitations, -refer to the :ref:`Realm Query Language reference `. - -Realm Query Language can use either the class and property names defined -in your Realm Model classes or the internal names defined with ``@RealmField``. -You can combine raw predicates with other raw predicates or type-safe -predicates created with ``RealmQuery``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.realm-query-language.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FilterDataTest.snippet.realm-query-language.java - :language: java - :copyable: false - -.. include:: /includes/tip-realm-query-language-reference-examples.rst diff --git a/source/sdk/java/crud/read.txt b/source/sdk/java/crud/read.txt deleted file mode 100644 index b0030fb0d9..0000000000 --- a/source/sdk/java/crud/read.txt +++ /dev/null @@ -1,399 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -====================== -CRUD - Read - Java SDK -====================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - -.. _java-read-operations: -.. _java-realm-database-reads: - -Read Operations ---------------- - -You can read back the data that you have -:ref:`stored ` in Realm. -The standard data access pattern across Realm -SDKs is to find, filter, and sort objects, in that order. To -get the best performance from Realm as your app grows and -your queries become more complex, design your app's data -access patterns around a solid understanding of Realm -:ref:`read characteristics `. - -.. _java-realm-read-characteristics: - -Read Characteristics -~~~~~~~~~~~~~~~~~~~~ - -When you design your app's data access patterns around the -following three key characteristics of reads in Realm, -you can be confident you are reading data as -efficiently as possible. - -.. _java-results-are-not-copies: - -Results Are Not Copies -~~~~~~~~~~~~~~~~~~~~~~ - -Results to a query are not copies of your data: modifying -the results of a query will modify the data on disk -directly. This memory mapping also means that results are -**live**: that is, they always reflect the current state on -disk. - -.. _java-results-are-lazy: - -Results Are Lazy -~~~~~~~~~~~~~~~~ - -Realm defers execution of a query until you access the -results. You can chain several filter and sort operations -without requiring extra work to process the intermediate -state. - -.. _java-references-retained: - -References Are Retained -~~~~~~~~~~~~~~~~~~~~~~~ - -One benefit of Realm's object model is that -Realm automatically retains all of an object's -:ref:`relationships ` as -direct references, so you can traverse your graph of -relationships directly through the results of a query. - -A **direct reference**, or pointer, allows you to access a -related object's properties directly through the reference. - -Other databases typically copy objects from database storage -into application memory when you need to work with them -directly. Because application objects contain direct -references, you are left with a choice: copy the object -referred to by each direct reference out of the database in -case it's needed, or just copy the foreign key for each -object and query for the object with that key if it's -accessed. If you choose to copy referenced objects into -application memory, you can use up a lot of resources for -objects that are never accessed, but if you choose to only -copy the foreign key, referenced object lookups can cause -your application to slow down. - -Realm bypasses all of this using zero-copy -live objects. Realm object accessors point directly into -database storage using memory mapping, so there is no distinction -between the objects in Realm and the results of your query in -application memory. Because of this, you can traverse direct references -across an entire realm from any query result. - -About the Examples on this Page -------------------------------- - -The examples on this page use the data model of a project -management app that has two Realm object types: ``Project`` -and ``Task``. A ``Project`` has zero or more ``Tasks``. - -See the schema for these two classes, ``Project`` and -``Task``, below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.kt - :language: kotlin - :caption: ProjectTask.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.kt - :language: kotlin - :caption: Project.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.java - :language: java - :caption: ProjectTask.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.java - :language: java - :caption: Project.java - :copyable: false - -.. _java-read-from-realm: - -Read from Realm ------------------------- - -A read from a realm generally consists of the following -steps: - -- Get all :ref:`objects ` of a certain type from the realm. -- Optionally, :ref:`filter ` the results using the :ref:`query engine `. -- Optionally, :ref:`sort ` the results. - -All query, filter, and sort operations return a -:ref:`results collection `. The results -collections are live, meaning they always contain the latest -results of the associated query. - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -.. _java-find-a-specific-object-by-primary-key: - -Find a Specific Object by Primary Key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To find an object with a specific primary key value, open a realm -and query the primary key field for the desired primary key value -using the :java-sdk:`RealmQuery.equalTo() ` method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.find-an-object-by-primary-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.find-an-object-by-primary-key.java - :language: java - :copyable: false - -.. _java-query-all-objects-of-a-given-type: - -Query All Objects of a Given Type -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The first step of any read is to **get all objects** of a -certain type in a realm. With this results collection, you -can operate on all instances on a type or filter and sort to -refine the results. - -In order to access all instances of ``ProjectTask`` and ``Project``, use -the :java-sdk:`where() ` method -to specify a class: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.get-all-objects.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.get-all-objects.kt - :language: kotlin - :copyable: false - -.. _java-filter-queries-based-on-object-properties: -.. _java-filter-results: - -Filter Queries Based on Object Properties -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A **filter** selects a subset of results based on the -value(s) of one or more object properties. Realm provides a -full-featured :ref:`query engine ` you -can use to define filters. The most common use case is to -find objects where a certain property matches a certain -value. Additionally, you can compare strings, aggregate over -collections of numbers, and use logical operators to build -up complex queries. - - -In the following example, we use the query -engine's comparison operators to: - -- Find high priority tasks by comparing the value of the ``priority`` property value with a threshold number, above which priority can be considered high. -- Find just-started or short-running tasks by seeing if the ``progressMinutes`` property falls within a certain range. -- Find unassigned tasks by finding tasks where the ``assignee`` property is equal to null. -- Find tasks assigned to specific teammates Ali or Jamie by seeing if the ``assignee`` property is in a list of names. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.filter-results.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.filter-results.kt - :language: kotlin - :copyable: false - -.. _java-sort-query-results: -.. _java-sort-results: - -Sort Query Results -~~~~~~~~~~~~~~~~~~ - -A **sort** operation allows you to configure the order in -which Realm returns queried objects. You can sort based on -one or more properties of the objects in the results -collection. - -Realm only guarantees a consistent order of results when the -results are sorted. - -The following code sorts the projects by name in reverse -alphabetical order (i.e. "descending" order). - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.sort-results.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ReadsTest.snippet.sort-results.kt - :language: kotlin - :copyable: false - -.. _java-query-a-relationship: - -Query a Relationship -~~~~~~~~~~~~~~~~~~~~ - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - Consider the following relationship between classes ``Person`` and - ``Dog``. This arrangement allows each person to own a single dog: - - .. literalinclude:: /examples/generated/java/sync/Person.snippet.complete.kt - :language: kotlin - :emphasize-lines: 10 - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Dog.snippet.complete.kt - :language: kotlin - :copyable: false - - To query this relationship, use dot notation in a - :ref:`query ` to access any property - of the linked object: - - .. literalinclude:: /examples/generated/java/sync/RealmQueryTest.snippet.query-a-relationship.kt - :language: kotlin - :emphasize-lines: 15 - :copyable: false - - .. tab:: - :tabid: java - - Consider the following relationship between classes ``Human`` and - ``Cat``. This arrangement allows each human to own a single cat: - - .. literalinclude:: /examples/generated/java/sync/Human.snippet.complete.java - :language: java - :emphasize-lines: 12 - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Cat.snippet.complete.java - :language: java - :copyable: false - - To query this relationship, use dot notation in a - :ref:`query ` to access any property - of the linked object: - - .. literalinclude:: /examples/generated/java/sync/RealmQueryTest.snippet.query-a-relationship.java - :language: java - :emphasize-lines: 16 - :copyable: false - -.. _java-query-an-inverse-relationship: - -Query an Inverse Relationship -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - Consider the following relationship between classes ``Dog`` and - ``Person``. In this example, all dogs link to their owner (or - multiple owners, if multiple person objects refer to the same dog). - Realm calculates the owners of each dog for you based on the field - name you provide to the ``@LinkingObjects`` annotation: - - .. include:: /examples/generated/java/sync/Dog.snippet.complete.kt.rst - - .. include:: /examples/generated/java/sync/Person.snippet.complete.kt.rst - - To query this relationship, use dot notation in a - :ref:`query ` to access any property - of the linked object: - - .. include:: /examples/generated/java/sync/RealmQueryTest.snippet.query-an-inverse-relationship.kt.rst - - .. tab:: - :tabid: java - - Consider the following relationship between classes ``Cat`` and - ``Human``. In this example, all cats link to their human (or - multiple humans, if multiple human objects refer to the same cat). - Realm calculates the owners of each cat for you based on the field - name you provide to the ``@LinkingObjects`` annotation: - - .. include:: /examples/generated/java/sync/Cat.snippet.complete.java.rst - - .. include:: /examples/generated/java/sync/Human.snippet.complete.java.rst - - To query this relationship, use dot notation in a - :ref:`query ` to access any property - of the linked object: - - .. include:: /examples/generated/java/sync/RealmQueryTest.snippet.query-an-inverse-relationship.java.rst - -.. _java-aggregate-data: - -Aggregate Data -~~~~~~~~~~~~~~ - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.aggregate-operators.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/QueryEngineTest.snippet.aggregate-operators.java - :language: java - :copyable: false diff --git a/source/sdk/java/crud/threading.txt b/source/sdk/java/crud/threading.txt deleted file mode 100644 index 630d95ea35..0000000000 --- a/source/sdk/java/crud/threading.txt +++ /dev/null @@ -1,317 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-threading: - -==================== -Threading - Java SDK -==================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -To make your Android apps fast and responsive, you must -balance the computing time needed to lay out the visuals and -handle user interactions with the time needed to process -your data and run your business logic. Typically, app -developers spread this work across multiple threads: the -main or UI thread for all of the user interface-related -work, and one or more background threads to compute heavier -workloads before sending it to the UI thread for -presentation. By offloading heavy work to background -threads, the UI thread can remain highly responsive -regardless of the size of the workload. - -.. _java-threading-three-rules: - -Three Rules to Keep in Mind ---------------------------- - -Realm enables simple and safe multithreaded code when you -follow these three rules: - -Avoid writes on the UI thread if you write on a background thread: - You can :ref:`write ` to a - realm from any thread, but there can be only one - writer at a time. Consequently, write transactions block - each other. A write on the UI thread may result in your - app appearing unresponsive while it waits for a write on a - background thread to complete. If you are using - :ref:`Sync `, avoid writing on - the UI thread as Sync writes on a background - thread. - -Don't pass live objects, collections, or realms to other threads: - Live objects, collections, and realm instances are - **thread-confined**: that is, they are only valid on the - thread on which they were created. Practically speaking, - this means you cannot pass live instances to other - threads. However, Realm offers several mechanisms for - :ref:`sharing objects across threads - `. - -Don't lock to read: - Realm's :ref:`Multiversion Concurrency Control (MVCC) - ` architecture eliminates the need to lock for read operations. The - values you read will never be corrupted or in a - partially-modified state. You can freely read from realms - on any thread without the need for locks or mutexes. - Unnecessarily locking would be a performance bottleneck - since each thread might need to wait its turn before - reading. - -.. _java-communication-across-threads: - -Communication Across Threads ----------------------------- - -Live objects, collections, and realms are **thread-confined**. If -you need to work with the same data across multiple threads, you should -open the same realm on multiple threads as separate realm -instances. The Java SDK :ref:`consolidates underlying connections across -threads where possible ` to make this pattern -more efficient. - -When you need to communicate across threads, you have -several options depending on your use case: - -- To modify the data on two threads, :ref:`query ` - for the object on both threads using a - :ref:`primary key `. - -- To send a fast, read-only view of an object to other threads, - :ref:`freeze ` the object. - -- To keep and share many read-only views of the object in your app, copy - the object from the realm. - -- To react to changes made on any thread, use - :ref:`notifications `. - -- To see changes from other threads in the realm on the current - thread, :ref:`refresh ` your realm - instance (event loop threads refresh automatically). - -.. _java-intents: - -Intents -~~~~~~~ - -:ref:`Managed ` ``RealmObject`` instances are -not thread-safe or ``Parcelable``, so you cannot pass them between -activities or threads via an ``Intent``. Instead, you can pass an object -identifier, like a :ref:`primary key `, -in the ``Intent`` extras bundle, and then open a new realm instance -in the separate thread to query for that identifier. Alternatively, you -can :ref:`freeze ` Realm objects. - -.. seealso:: - - You can find working examples in the `Passing Objects `__ - portion of the `Java SDK Threading Example - `__. - The example shows you how to pass IDs and retrieve a ``RealmObject`` - in common Android use cases. - -.. _java-frozen-objects: - -Frozen Objects -~~~~~~~~~~~~~~ - -Live, thread-confined objects work fine in most cases. -However, some apps -- those based on reactive, event -stream-based architectures, for example -- need to send -immutable copies across threads. In this case, -you can **freeze** objects, collections, and realms. - -Freezing creates an immutable view of a specific object, -collection, or realm that still exists on disk and does not -need to be deeply copied when passed around to other -threads. You can freely share a frozen object across threads -without concern for thread issues. - -Frozen objects are not live and do not automatically update. They are -effectively snapshots of the object state at the time of freezing. When -you freeze a realm all child objects and collections also become -frozen. You can't modify frozen objects, but you can read the primary -key from a frozen object, query a live realm for the underlying -object, and then update that live object instance. - -Frozen objects remain valid for as long as the realm that -spawned them stays open. Avoid closing realms that contain frozen -objects until all threads are done working with those frozen objects. - -.. warning:: Frozen Object Exceptions - - When working with frozen objects, an attempt to do any of - the following throws an exception: - - - Opening a write transaction on a frozen realm. - - Modifying a frozen object. - - Adding a change listener to a frozen realm, collection, or object. - -Once frozen, you cannot unfreeze an object. You -can use ``isFrozen()`` to check if an object is frozen. -This method is always thread-safe. - -To freeze an object, collection, or realm, use the -:java-sdk:`freeze() ` method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/ThreadingTest.snippet.freeze-objects.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/ThreadingTest.snippet.freeze-objects.java - :language: java - :copyable: false - -.. important:: Frozen Objects and Realm Size - - Frozen objects preserve an entire copy of the realm that contains - them at the moment they were frozen. As a result, freezing a large - number of objects can cause a realm to consume more memory and - storage than it might have without frozen objects. If you need to - separately freeze a large number of objects for long periods of time, - consider copying what you need out of the realm instead. - -.. _java-refreshing-realms: - -Refreshing Realms ------------------ - -When you open a realm, it reflects the most recent successful write -commit and remains on that version until it is **refreshed**. This means -that the realm will not see changes that happened on another thread -until the next refresh. Realms on any event loop thread -(including the UI thread) automatically refresh themselves at the -beginning of that thread's loop. However, you must manually refresh -realm instances that are tied to non-looping threads or that have -auto-refresh disabled. To refresh a realm, call -:java-sdk:`Realm.refresh() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/ThreadingTest.snippet.refresh-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/ThreadingTest.snippet.refresh-realm.java - :language: java - :copyable: false - -.. tip:: Refresh on Write - - Realms also automatically refresh after completing a write transaction. - -.. _java-mvcc: - -Realm's Threading Model in Depth --------------------------------- - -Realm provides safe, fast, lock-free, and concurrent access -across threads with its :wikipedia:`Multiversion Concurrency -Control (MVCC) ` -architecture. - -Compared and Contrasted with Git -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you are familiar with a distributed version control -system like `Git `__, you may already -have an intuitive understanding of MVCC. Two fundamental -elements of Git are: - -- Commits, which are atomic writes. -- Branches, which are different versions of the commit history. - -Similarly, Realm has atomically-committed writes in the form -of :ref:`transactions `. Realm also has many -different versions of the history at any given time, like -branches. - -Unlike Git, which actively supports distribution and -divergence through forking, a realm only has one true latest -version at any given time and always writes to the head of -that latest version. Realm cannot write to a previous -version. This makes sense: your data should converge on one -latest version of the truth. - -Internal Structure -~~~~~~~~~~~~~~~~~~ - -A realm is implemented using a :wikipedia:`B+ tree -` data structure. The top-level node represents a -version of the realm; child nodes are objects in that -version of the realm. The realm has a pointer to its latest -version, much like how Git has a pointer to its HEAD commit. - -Realm uses a copy-on-write technique to ensure -:wikipedia:`isolation ` and -:wikipedia:`durability `. -When you make changes, Realm copies the relevant part of the -tree for writing, then commits the changes in two phases: - -- Write changes to disk and verify success. -- Set the latest version pointer to point to the newly-written version. - -This two-step commit process guarantees that even if the -write failed partway, the original version is not corrupted -in any way because the changes were made to a copy of the -relevant part of the tree. Likewise, the realm's root -pointer will point to the original version until the new -version is guaranteed to be valid. - -.. include:: /includes/commit-process-diagram.rst - -Realm uses zero-copy techniques -like memory mapping to handle data. When you read a value -from the realm, you are virtually looking at the value on -the actual disk, not a copy of it. This is the basis for -:ref:`live objects `. This is also why a realm -head pointer can be set to point to the new version after -the write to disk has been validated. - -Summary -------- - -- Realm enables simple and safe multithreaded code when you follow - three rules: - - - Avoid writes on the UI thread if you write on background threads or - use :ref:`Sync `. - - - Don't pass live objects to other threads. - - - Don't lock to read. - -- In order to see changes made on other threads in your realm - instance, you must manually **refresh** realm instances that do - not exist on "loop" threads or that have auto-refresh disabled. - -- For apps based on reactive, event-stream-based architectures, you can - **freeze** objects, collections, and realms in order to pass - copies around efficiently to different threads for processing. - -- Realm's multiversion concurrency control (MVCC) - architecture is similar to Git's. Unlike Git, Realm has - only one true latest version for each realm. - -- Realm commits in two stages to guarantee isolation and - durability. diff --git a/source/sdk/java/crud/update.txt b/source/sdk/java/crud/update.txt deleted file mode 100644 index 84615b6080..0000000000 --- a/source/sdk/java/crud/update.txt +++ /dev/null @@ -1,222 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-modify-an-object: -.. _java-update: - -======================== -CRUD - Update - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -About the Examples on this Page -------------------------------- - -The examples on this page use the data model of a project -management app that has two Realm object types: ``Project`` -and ``Task``. A ``Project`` has zero or more ``Tasks``. - -See the schema for these two classes, ``Project`` and -``Task``, below: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.kt - :language: kotlin - :caption: ProjectTask.kt - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.kt - :language: kotlin - :caption: Project.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ProjectTask.snippet.projecttask.java - :language: java - :caption: ProjectTask.java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/Project.snippet.project.java - :language: java - :caption: Project.java - :copyable: false - -Modify an Object ----------------- - -Within a transaction, you can update a Realm object the same -way you would update any other object in your language of -choice. Just assign a new value to the property or update -the property. - -The following example changes the turtle's name to "Archibald" and -sets Archibald's age to 101 by assigning new values to properties: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.update-an-object.kt - :language: kotlin - :emphasize-lines: 6,7 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.update-an-object.java - :language: java - :emphasize-lines: 6,7 - :copyable: false - -.. _java-upsert: - -Upsert an Object ----------------- - -An **upsert** is a write operation that either inserts a new object -with a given primary key or updates an existing object that already has -that primary key. We call this an upsert because it is an "**update** or -**insert**" operation. This is useful when an object may or may not -already exist, such as when bulk importing a dataset into an existing -realm. Upserting is an elegant way to update existing entries while -adding any new entries. - -The following example demonstrates how to upsert an object with -realm. We create a new turtle enthusiast named "Drew" and then -update their name to "Andy" using :java-sdk:`insertOrUpdate() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.upsert-an-object.kt - :language: kotlin - :emphasize-lines: 14-16 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.upsert-an-object.java - :language: java - :emphasize-lines: 14-16 - :copyable: false - -You can also use :java-sdk:`copyToRealmOrUpdate() -` to -either create a new object based on a supplied object or update an -existing object with the same primary key value. Use the -``CHECK_SAME_VALUES_BEFORE_SET`` -:java-sdk:`ImportFlag ` to only update fields -that are different in the supplied object: - -The following example demonstrates how to insert an object or, if an object already -exists with the same primary key, update only those fields that differ: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.copy-or-update-same-values-flag.kt - :language: kotlin - :emphasize-lines: 15-16 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.copy-or-update-same-values-flag.java - :language: java - :emphasize-lines: 16 - :copyable: false - -.. _java-batch-update: - -Update a Collection -------------------- - -Realm supports collection-wide updates. A collection update -applies the same update to specific properties of several -objects in a collection at once. - -The following example demonstrates how to update a -collection. Thanks to the :ref:`implicit inverse -relationship ` between the Turtle's -``owner`` property and the TurtleEnthusiast's ``turtles`` property, -Realm automatically updates Josephine's list of turtles -when you use :java-sdk:`setObject() -` -to update the "owner" property for all turtles in the collection. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.update-a-collection.kt - :language: kotlin - :emphasize-lines: 11,12 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/WritesTest.snippet.update-a-collection.java - :language: java - :emphasize-lines: 9,10 - :copyable: false - -.. _java-iteration: - -Iteration ---------- - -Because realm collections always reflect the latest state, they -can appear, disappear, or change while you iterate over a collection. -To get a stable collection you can iterate over, you can create a -**snapshot** of a collection's data. A snapshot guarantees the order of -elements will not change, even if an element is deleted or modified. - -``Iterator`` objects created from ``RealmResults`` use snapshots -automatically. ``Iterator`` objects created from ``RealmList`` -instances do *not* use snapshots. Use -:java-sdk:`RealmList.createSnapshot() ` -or -:java-sdk:`RealmResults.createSnapshot() ` -to manually generate a snapshot you can iterate over manually: - -The following example demonstrates how to iterate over a collection -safely using either an implicit snapshot created from a ``RealmResults`` -``Iterator`` or a manual snapshot created from a ``RealmList``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.iterate.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.iterate.java - :language: java - :copyable: false diff --git a/source/sdk/java/facets.toml b/source/sdk/java/facets.toml deleted file mode 100644 index 3e2912ea74..0000000000 --- a/source/sdk/java/facets.toml +++ /dev/null @@ -1,13 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -[[facets]] -category = "programming_language" -value = "java" - -[[facets]] -category = "programming_language" -value = "kotlin" -[[facets.sub_facets]] -category = "sub_product" -value = "java" diff --git a/source/sdk/java/install.txt b/source/sdk/java/install.txt deleted file mode 100644 index 0358f02b84..0000000000 --- a/source/sdk/java/install.txt +++ /dev/null @@ -1,248 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-install: - -======================== -Install Realm - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. include:: /includes/note-java-maintenance-mode.rst - -.. include:: /includes/note-java-and-realmany.rst - -Overview --------- - -This page details how to install Realm using the Java SDK in your project -and get started. - -You can use multiple SDKs in your project. Because the Java SDK is no longer -receiving new development, this is useful if you want to -use new features in your app. For example, you can add Atlas -Device Sync's :ref:`Data Ingest ` feature to your -app using the Kotlin SDK while continuing to use Java for everything else. - -Prerequisites -------------- - -- :android:`Android Studio ` version 1.5.1 or higher. -- Java Development Kit (JDK) 11 or higher. -- An emulated or hardware Android device for testing. -- Android API Level 16 or higher (Android 4.1 and above). - -Installation ------------- - -Realm only supports the Gradle build system. Follow these steps -to add the Realm Java SDK to your project. - -.. note:: ProGuard - - Because Realm provides a ProGuard configuration as part - of the Realm library, you do not need to add any - Realm-specific rules to your ProGuard configuration. - -Project Gradle Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To add local-only Realm to your application, make -the following changes to your project-level Gradle build -file, typically found at :file:`/build.gradle`: - -.. tabs:: - - .. tab:: Gradle Plugin Syntax - :tabid: gradle-plugin - - .. tip:: - - The Java SDK does not yet support the Gradle Plugin syntax. Fortunately, - you can still add the SDK to projects that use this syntax. - - - Add a ``buildscript`` block that contains a ``repositories`` block and a ``dependencies`` block. - - Add the ``mavenCentral()`` repository to the ``buildscript.repositories`` block. - - Add the ``io.realm:realm-gradle-plugin`` dependency to the ``buildscript.dependencies`` block. - - .. code-block:: groovy - :emphasize-lines: 1-8 - - buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath "io.realm:realm-gradle-plugin:{+java-sdk-version+}" - } - } - - plugins { - id 'com.android.application' version '7.1.2' apply false - id 'com.android.library' version '7.1.2' apply false - id 'org.jetbrains.kotlin.android' version '1.6.10' apply false - id "org.jetbrains.kotlin.kapt" version "1.6.20" apply false - } - - task clean(type: Delete) { - delete rootProject.buildDir - } - - - .. tab:: Gradle Legacy Syntax - :tabid: gradle-legacy - - - Add the ``io.realm:realm-gradle-plugin`` dependency to the ``buildscript.dependencies`` block. - - Add the ``mavenCentral()`` repository to the ``allprojects.repositories`` block. - - .. code-block:: groovy - :emphasize-lines: 7, 13 - - buildscript { - repositories { - google() - } - dependencies { - classpath "com.android.tools.build:gradle:3.5.1" - classpath "io.realm:realm-gradle-plugin:{+java-sdk-version+}" - } - } - - allprojects { - repositories { - google() - mavenCentral() - } - dependencies { - } - } - - task clean(type: Delete) { - delete rootProject.buildDir - } - -Application Module Gradle Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Then, make the following changes to your application-level -Gradle build file, typically found at :file:`/app/build.gradle`: - -.. tabs:: - - .. tab:: Gradle Plugin Syntax - :tabid: gradle-plugin - - - Apply the ``kotlin-kapt`` plugin if your application uses Kotlin - - Beneath the ``plugins`` block, apply the ``realm-android`` plugin. - - .. code-block:: groovy - :emphasize-lines: 4, 7 - - plugins { - id 'com.android.application' - id 'org.jetbrains.kotlin.android' - id 'org.jetbrains.kotlin.kapt' - } - - apply plugin: "realm-android" - - android { - compileSdk 31 - defaultConfig { - applicationId "com.mongodb.example-realm-application" - minSdk 28 - targetSdk 31 - versionCode 1 - versionName "1.0" - testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" - } - buildTypes { - release { - minifyEnabled false - proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' - } - } - compileOptions { - sourceCompatibility JavaVersion.VERSION_11 - targetCompatibility JavaVersion.VERSION_11 - } - kotlinOptions { - jvmTarget = '11' - } - } - - dependencies { - implementation 'io.realm:realm-gradle-plugin:10.10.1' - implementation 'androidx.core:core-ktx:1.7.0' - implementation 'androidx.appcompat:appcompat:1.4.1' - implementation 'com.google.android.material:material:1.5.0' - implementation 'androidx.constraintlayout:constraintlayout:2.1.3' - testImplementation 'junit:junit:4.13.2' - androidTestImplementation 'androidx.test.ext:junit:1.1.3' - androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0' - } - - - .. tab:: Gradle Legacy Syntax - :tabid: gradle-legacy - - - Apply the ``kotlin-kapt`` plugin if your application uses Kotlin - - Apply the ``realm-android`` plugin - - .. code-block:: groovy - :emphasize-lines: 3-4 - - apply plugin: 'com.android.application' - apply plugin: 'kotlin-android' - apply plugin: 'kotlin-kapt' - apply plugin: 'realm-android' - - android { - compileSdkVersion 31 - buildToolsVersion "29.0.2" - defaultConfig { - applicationId "com.mongodb.example-realm-application" - minSdkVersion 28 - targetSdkVersion 31 - } - compileOptions { - sourceCompatibility 1.11 - targetCompatibility 1.11 - } - kotlinOptions { - jvmTarget = '11' - } - } - - dependencies { - implementation fileTree(dir: 'libs', include: ['*.jar']) - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" - implementation "androidx.appcompat:appcompat:1.1.0" - implementation "androidx.core:core-ktx:1.2.0" - } - -After updating the ``build.gradle`` files, resolve the dependencies by -clicking :guilabel:`File > Sync Project with Gradle Files`. - -Enable Atlas Device Sync ------------------------- - -To use Atlas Device Sync in your application, create a ``realm`` block in your -application module ``build.gradle``. Within this block, set ``syncEnabled`` -to ``true``. - -.. code-block:: groovy - - realm { - syncEnabled = true - } - -Supported Platforms -------------------- - -.. include:: /includes/java-sdk-supported-platforms.rst diff --git a/source/sdk/java/manage-users.txt b/source/sdk/java/manage-users.txt deleted file mode 100644 index 7bf8245689..0000000000 --- a/source/sdk/java/manage-users.txt +++ /dev/null @@ -1,99 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -======================= -Manage Users - Java SDK -======================= - -.. toctree:: - :titlesonly: - - Create and Delete Users - Authenticate Users - Custom User Data - Manage Email/Password Users - Multi-User Applications - Link User Identities - Create & Manage User API Keys - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -When you use Atlas App Services to back your client app, you get access to a -:ref:`user object `. Use Java SDK methods with this user -object to conveniently: - -- Create and delete users -- Log users in and out -- Create and update custom user data - -.. _java-creating-and-deleting-users: - -Create and Delete Users ------------------------ - -For all authentication providers other than email/password authentication, -App Services automatically :ref:`creates a user object ` -the first time a user authenticates. If a user authenticates via more than -one method, you can :ref:`link these user identities ` -to a single user object. - -You can :ref:`delete user objects `. Deleting a user object -deletes metadata attached to the user object, but does not delete user-entered -data from the backend. - -.. _java-access-the-app-client: - -Log Users In and Out --------------------- - -Use one or more :ref:`authentication providers ` to :ref:`log -users in and out ` of your client app. You can: - -- Log users in with an existing social account, such as Apple, Facebook, - or Google. -- Create new user accounts with App Services email/password management, - or your own custom function or custom JWT user management. -- Enable anonymous users to let users access your App Services App without persisting - user data. - -When you have a logged-in user, SDK methods enable you to: - -- :ref:`Open a synced realm ` with the user's - configuration object -- :ref:`Run a backend function ` as the logged-in user -- :ref:`Log the user out ` -- :ref:`Change the active user ` in a multi-user - application -- :ref:`Remove a user ` from the device - -On successful login, the Java SDK caches credentials on the device. You -can bypass the login flow and access the cached user. Use this to open a -realm or call a function upon subsequent app opens. - -User Sessions -~~~~~~~~~~~~~ - -App Services manages sessions with access tokens and refresh tokens. -Client SDKs supply the logic to manage tokens, and provide them with requests. - -.. seealso:: - - :ref:`` - -.. _java-app-work-with-custom-user-data: - -Read and Update Custom User Data --------------------------------- - -You can :ref:`associate custom data ` with a user object, -such as a preferred language or local timezone, and read it from your client -application. A user object has a ``customData`` property that you can use -to :ref:`access custom user data `. - -To create and update custom user data, you must access -your MongoDB data source directly. App Services does not offer a SDK -method to create or update this custom user data; it's a read-only property. diff --git a/source/sdk/java/migrate/index.txt b/source/sdk/java/migrate/index.txt deleted file mode 100644 index 7961270947..0000000000 --- a/source/sdk/java/migrate/index.txt +++ /dev/null @@ -1,73 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -:noprevnext: -:orphan: - -.. meta:: - :robots: noindex, nosnippet - -.. _java-migrate-from-stitch-to-realm: - -======================================= -Upgrade from Stitch to Realm - Java SDK -======================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -If you have an existing app built with the Stitch SDK, you should migrate your -app to use the new Realm SDK. While much of the logic and flow of information -hasn't changed, there are a few important changes in the way your app connects to -the realm backend. - -New Features ------------- - -- The Realm Java SDK supports Android applications written in Kotlin. - -- The Realm Java SDK now includes Realm Database, which includes - local object storage and :ref:`Sync `. - -Changes -------- - -.. list-table:: - :header-rows: 1 - :widths: 50 50 - - * - What's Changed? - - Solution - - * - The backend app connections previously accessed via `StitchAppClient `__ are now accessed through :java-sdk:`App `. - - Migrate all occurrences of ``StitchAppClient`` to ``App``. - - * - Application users previously accessed via `StitchUser `__ are now accessed through :java-sdk:`User `. - - Migrate all occurrences of ``StitchUser`` to ``User``. - - * - In the Stitch SDK, network requests like `callFunction() `__ were asynchronous by default. In the Realm Java SDK, you can choose synchronous or asynchronous requests with the "Async" suffix, e.g. :java-sdk:`callFunction() ` and :java-sdk:`callFunctionAsync() `. - - Migrate all asynchronous Stitch SDK requests to their :ref:`asynchronous Realm SDK equivalents `. - - * - Async SDK requests no longer use the built-in Android `Task `__ class to return success status and values via ``onComplete()``; instead, Async requests now use a :java-sdk:`App.Callback ` to return success status and values via ``onResult()``. - - Rewrite all asynchronous Stitch SDK requests to use ``App.Callback`` and ``onResult()``. - - * - The login API has changed from `stitchAppClient.getAuth().loginWithCredential() `__ to :java-sdk:`app.loginAsync() ` or the synchronous equivalent :java-sdk:`app.login() `. - - Rewrite all authentication logic to use the :ref:`new login API `. - - * - The Stitch SDK used `stitchAppClient.getAuth().logout() `__ to handle user logout. To logout a user in the Realm SDK, call the :java-sdk:`logOut() ` method of that user's ``User`` object. - - Rewrite all logout logic to use the user's ``User`` object instead of the ``StitchAppClient``. - - * - Instead of calling functions using the app client directly, like `stitchAppClient.callFunction() `__, you can only call functions through a :java-sdk:`Functions Manager `, which you can access through your backend realm app connection: :java-sdk:`app.getFunctions(user).callFunctionAsync() `. - - Call functions :ref:`using a Functions Manager ` instead of an app client. - - * - The MongoDB Data Access API, which contains objects like :java-sdk:`MongoClient `, :java-sdk:`MongoDatabase `, and :java-sdk:`MongoCollection ` has changed packages from ``com.mongodb.client`` to ``io.realm.mongodb.mongo``. - - Refactor all imports of the :ref:`MongoDB Data Access API ` to use ``io.realm.mongodb.mongo``. - - * - The BSON package, which contains BSON data types and the ``Document`` data type for reading/writing to MongoDB Atlas, has moved from ``com.mongodb.stitch.core.internal.common`` to ``org.bson``. - - Refactor all imports of the BSON package to use ``io.realm.mongodb.mongo``. - - * - The Realm SDK does not provide an interface for calling services such as :ref:`Twilio ` and :ref:`AWS `. - - Convert SDK service API usage in your application to Realm functions using the corresponding npm packages. For more information, see :ref:`Add External Dependencies `. diff --git a/source/sdk/java/model-data.txt b/source/sdk/java/model-data.txt deleted file mode 100644 index 164f38ecee..0000000000 --- a/source/sdk/java/model-data.txt +++ /dev/null @@ -1,231 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -===================== -Model Data - Java SDK -===================== - -.. toctree:: - :titlesonly: - - Define an Object Model - Relationships - Change an Object Model - Data Types - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. include:: /includes/note-java-and-realmany.rst - -.. _java-object-models-and-schemas: -.. _java-schema-versions-and-migrations: - -An **object schema** is a configuration object that defines the fields and -relationships of a Realm object type. Android -Realm applications define object schemas with Java or Kotlin -classes using Realm Schemas. - -Object schemas specify constraints on object fields such as the data -:ref:`type ` of each field, whether a -field is required, and default field values. Schemas can also define -:ref:`relationships ` between object types in -a realm. - -Modifying your application's Realm Schema requires you to -:ref:`migrate ` data from older -versions of your Realm Schema to the new version. - -Realm Apps ----------- - -Every App has a :ref:`Realm Schema ` -composed of a list of object schemas for each type of object that the -realms in that application may contain. - -Realm guarantees that all objects in a realm conform to the -schema for their object type and validates objects whenever they're -created, modified, or deleted. - -Apps that use Atlas Device Sync can define schemas in two ways: - -- object schemas :ref:`using Kotlin and Java class declarations - ` with :ref:`Development Mode `. - -- JSON :ref:`object schemas ` in your App backend. - -.. _java-relationships-fundamentals: - -Relationships -------------- - -You can model **one-to-one** relationships in realm with -:java-sdk:`RealmObject ` fields. -You can model **one-to-many** and **many-to-one** relationships -:java-sdk:`RealmList ` fields. -Inverse relationships are the opposite end of a **one-to-many** or -**many-to-one** relationship. -You can make **inverse** relationships traversable with the -:java-sdk:`@LinkingObjects ` -annotation on a :java-sdk:`RealmResults ` -field. In an instance of a ``RealmObject``, inverse relationship fields -contain the set of Realm objects that point to that object -instance through the described relationship. You can find the same set -of Realm objects with a manual query, but the inverse -relationship field reduces boilerplate query code and capacity for error. - -.. _java-realm-objects: - -Realm Objects -------------- - -Unlike normal Java objects, which contain their own data, a -Realm object doesn't contain data. Instead, -Realm objects read and write properties directly to -Realm. - -Instances of Realm objects can be either **managed** or **unmanaged**. - -- **Managed** objects are: - - - persisted in Realm - - - always up to date - - - thread-confined - - - generally more lightweight than the unmanaged version, as they take - up less space on the Java heap. - -- **Unmanaged** objects are just like ordinary Java objects, since - they are not persisted and never update automatically. - You can move unmanaged objects freely across threads. - -You can convert between the two states using -:java-sdk:`realm.copyToRealm() -` -and :java-sdk:`realm.copyFromRealm() -`. - -.. _java-realm-proxy: - -RealmProxy -~~~~~~~~~~ - -The ``RealmProxy`` classes are the Realm SDK's way of -ensuring that Realm objects don't contain any data -themselves. Instead, each class's ``RealmProxy`` accesses data directly -in the database. - -For every model class in your project, the Realm annotation -processor generates a corresponding ``RealmProxy`` class. This class -extends your model class and is returned when you call -``Realm.createObject()``. In your code, this object works just like your -model class. - -.. _java-realm-object-limitations: - -Realm Object Limitations -~~~~~~~~~~~~~~~~~~~~~~~~ - -Realm objects: - -- cannot contain fields that use the ``final`` or ``volatile`` modifiers - (except for :ref:`inverse relationship ` - fields). - -- cannot extend any object other than ``RealmObject``. - -- must contain an empty constructor (if your class does not include any - constructor, the automatically generated empty constructor will suffice) - -Naming limitations: - -- Class names cannot exceed 57 characters. - -- Class names must be unique within :ref:`realm modules ` - -- Field names cannot exceed 63 characters. - -Size limitations: - -- ``String`` or ``byte[]`` fields cannot exceed 16 MB. - -Usage limitations: - -- Because Realm objects are live and can change at any time, - their ``hashCode()`` value can change over time. As a result, you - should not use ``RealmObject`` instances as a key in any map or set. - -Incremental Builds ------------------- - -The bytecode transformer used by Realm supports incremental -builds, but your application requires a full rebuild when adding or -removing the following from a Realm object field: - -- an ``@Ignore`` annotation - -- the ``static`` keyword - -- the ``transient`` keyword - -You can perform a full rebuild with :guilabel:`Build > Clean Project` -and :guilabel:`Build > Rebuild Project` in these cases. - -.. _java-schema-version: - -Schema Version --------------- - -A **schema version** identifies the state of a :ref:`Realm Schema -` at some point in time. Realm tracks the schema -version of each realm and uses it to map the objects in each realm -to the correct schema. - -Schema versions are integers that you may include -in the realm configuration when you open a realm. If a client -application does not specify a version number when it opens a realm then -the realm defaults to version ``0``. - -.. important:: Increment Versions Monotonically - - :ref:`Migrations ` must update a realm to a - higher schema version. Realm throws an error if a client - application opens a realm with a schema version that is lower than - the realm's current version or if the specified schema version is the - same as the realm's current version but includes different - :ref:`object schemas `. - -.. _java-migrations: - -Migrations ----------- - -A **local migration** is a migration for a realm that does -not automatically :ref:`Sync ` with -another realm. Local migrations have access to the existing -Realm Schema, version, and objects and define logic that -incrementally updates the realm to its new schema version. -To perform a local migration you must specify a new schema -version that is higher than the current version and provide -a migration function when you open the out-of-date realm. - -With the SDK, you can update underlying data to reflect schema changes -using manual migrations. During such a manual migration, you can -define new and deleted properties when they are added or removed from -your schema. The editable schema exposed via a -:java-sdk:`DynamicRealm ` provides -convenience functions for renaming fields. This gives you full control -over the behavior of your data during complex schema migrations. - -.. tip:: Migrations During Application Development - - During development of an application, ``RealmObject`` classes can - change frequently. You can use :java-sdk:`Realm.deleteRealm() - ` to - delete the database file and eliminate the need to write a full - migration for testing data. diff --git a/source/sdk/java/model-data/data-types.txt b/source/sdk/java/model-data/data-types.txt deleted file mode 100644 index 7b81694ab9..0000000000 --- a/source/sdk/java/model-data/data-types.txt +++ /dev/null @@ -1,30 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-data-types: - -=========================== -Realm Data Types - Java SDK -=========================== - -.. toctree:: - :titlesonly: - :hidden: - - Field Types - Collections - Counters - Dictionaries - Sets - Mixed - Enums - Embedded Objects - -- :doc:`Field Types ` -- :doc:`Collections ` -- :doc:`Counters ` -- :doc:`Dictionaries ` -- :doc:`Sets ` -- :doc:`Mixed ` -- :doc:`Enums ` -- :doc:`Embedded Objects ` diff --git a/source/sdk/java/model-data/data-types/collections.txt b/source/sdk/java/model-data/data-types/collections.txt deleted file mode 100644 index d6d8ffe193..0000000000 --- a/source/sdk/java/model-data/data-types/collections.txt +++ /dev/null @@ -1,227 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-client-collections: - -====================== -Collections - Java SDK -====================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -A Realm collection is an -object that contains zero or more instances of one -:ref:`type `. Realm collections -are homogenous, i.e. all objects in a collection are of the -same type. - -You can filter and sort any collection using Realm's -:ref:`query engine `. Collections are -:ref:`live `, so they always reflect the -current state of the realm instance on the current -thread. You can also listen for changes in the collection by subscribing -to :ref:`collection notifications `. - -Realm has two kinds of collections: **lists** and **results**. - -.. _java-field-relationships-lists: - -Lists ------ - -Realm objects can contain lists of non-Realm-object data -types. You can model these collections with the type ``RealmList``, -where ``T`` can be the following types: - -- ``String`` -- ``Integer`` -- ``UUID`` -- ``ObjectId`` -- ``Boolean`` -- ``Float`` -- ``Double`` -- ``Short`` -- ``Long`` -- ``Byte`` -- ``byte[]`` -- ``Date`` - -.. seealso:: - - :ref:`java-field-relationships-lists-example` - -.. _java-list-collections: - -List Collections -~~~~~~~~~~~~~~~~ - -A **list collection** represents a :ref:`to-many -relationship ` between two Realm -types. Lists are mutable: within a write transaction, you -can add and remove elements on a list. Lists are not -associated with a query. - -.. _java-results-collections: - -Results Collections -~~~~~~~~~~~~~~~~~~~ - -A **results collection** represents the lazily-evaluated -results of a query operation. Results are immutable: you -cannot add or remove elements on the results collection. -Results have an associated query that determines their -contents. - -The :java-sdk:`RealmResults ` class inherits from -:android:`AbstractList ` and behaves -in similar ways. For example, ``RealmResults`` are ordered, and you can -access the individual objects through an index. If a query has no -matches, the returned ``RealmResults`` object will be a list of length -0, not a ``null`` object reference. - -You can only modify or delete objects in a ``RealmResults`` set -in a write transaction. - -Iteration ---------- - -Because Realm collections are live, objects may move as you -iterate over a collection. You can use -:ref:`snapshots ` to iterate over collections safely. - -.. _java-lists-adapters: - -Adapters --------- - -Realm offers adapters to help bind data -to standard UI widgets. These classes work with any class that -implements the ``OrderedRealmCollection`` interface, which includes -the built-in ``RealmResults`` and ``RealmList`` classes. For more -information on adapters, see the documentation on -:ref:`Displaying Collections `. - -.. important:: Adapters Require Managed Objects - - The Realm adapters only accept *managed* - Realm object instances tied to an instance of a realm. - To display non-managed objects, use the general-use Android - ``RecyclerView.Adapter`` for recycler views or ``ArrayAdapter`` for - list views. - -.. _java-live-collections: - -Collections are Live --------------------- - -Like :ref:`live objects `, Realm collections -are usually **live**: - -- Live results collections always reflect the current results of the associated query. -- Live lists always reflect the current state of the relationship on the realm instance. - -There are three cases when a collection is **not** live: - -- The collection is unmanaged, e.g. a List property of a Realm object that has not been added to a realm yet or that has been copied from a realm. -- The collection is :ref:`frozen `. -- The collection is part of a snapshot. - -Combined with :ref:`collection notifications -`, live collections enable clean, -reactive code. For example, suppose your view displays the -results of a query. You can keep a reference to the results -collection in your view class, then read the results -collection as needed without having to refresh it or -validate that it is up-to-date. - -.. warning:: Indexes may change - - Results update themselves automatically. If you - store the positional index of an object in a collection - or the count of objects in a collection, the stored index - or count value could be outdated by the time you use it. - -.. _java-lazy-evaluated-results: - -Results are Lazily Evaluated ----------------------------- - -Realm only runs a query when you actually request the -results of that query, e.g. by accessing elements of the -results collection. This lazy evaluation enables you to -write elegant, highly performant code for handling large -data sets and complex queries. - -.. _java-limiting-results: - -Limiting Query Results -~~~~~~~~~~~~~~~~~~~~~~ - -As a result of lazy evaluation, you do not need any special -mechanism to limit query results with Realm. For example, if -your query matches thousands of objects, but you only want -to load the first ten, simply access only the first ten -elements of the results collection. - -.. _java-pagination: - -Pagination -~~~~~~~~~~ - -Thanks to lazy evaluation, the common task of pagination -becomes quite simple. For example, suppose you have a -results collection associated with a query that matches -thousands of objects in your realm. You display one hundred -objects per page. To advance to any page, simply access the -elements of the results collection starting at the index -that corresponds to the target page. - -.. _java-list-vs-results: - -List vs. Results ----------------- - -When you need a collection, you can use the following rule -of thumb to determine whether a list or a results collection -is appropriate: - -- When you define the properties of your Realm objects, use lists to define :ref:`to-many relationships ` except :ref:`implicit inverse relationships `. -- Use results everywhere else. - -To understand these different use cases, consider whether -you should be able to add or remove objects directly. Lists -allow you to add and remove objects directly, because you -control the relationships. Results collections do not allow -you to add or remove objects directly, because their contents -are determined by a query. - -.. example:: - - Consider a Realm type called Person with a field called - ``emails`` that is a collection of strings representing - email addresses. You control this data. Your application - needs to add and remove email addresses from your Person - instances. Therefore, use a **list** to define the field - type of ``emails``. - - On the other hand, when you query the realm for all - Persons over the age of 25, it would not make sense for - you to add or remove Persons directly to the resulting - collection. The contents of that collection only change - when the query matches a different set of Persons. - Therefore, Realm gives you a **results** collection. - -.. _java-collection-type-for-implicit-inverse-relationships: - -.. note:: Inverse one-to-many relationships - - Since Realm automatically determines the contents of - :ref:`implicit inverse relationship - ` collections, you may not add - or remove objects from such a collection. - Therefore, the type of such a one-to-many relationship - property is actually a results collection, not a list. diff --git a/source/sdk/java/model-data/data-types/counters.txt b/source/sdk/java/model-data/data-types/counters.txt deleted file mode 100644 index 85c4e052e5..0000000000 --- a/source/sdk/java/model-data/data-types/counters.txt +++ /dev/null @@ -1,126 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-counters: - -=================== -Counters - Java SDK -=================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Realm offers :java-sdk:`MutableRealmInteger -`, a wrapper around numeric values, -to help better synchronize numeric changes across multiple clients. - -Typically, incrementing or decrementing a -``byte``, ``short``, ``int``, or ``long`` field of a Realm -object looks something like this: - -1. Read the current value of the field. -#. Update that value in memory to a new value based on the increment or - decrement. -#. Write a new value back to the field. - -When multiple distributed clients attempt this at the same time, -updates reaching clients in different orders can -result in different values on different clients. ``MutableRealmInteger`` -improves on this by translating numeric updates into sync operations -that can be executed in any order to converge to the same value. - -``MutableRealmInteger`` fields are backed by traditional numeric types, -so no migration is required when changing a field from ``byte``, ``short``, -``int`` or ``long`` to ``MutableRealmInteger``. - -The following example demonstrates a ``MutableRealmInteger`` field that -counts the number of ghosts found in a haunted house: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/HauntedHouseKt.snippet.complete.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/HauntedHouse.snippet.complete.java - :language: java - :copyable: false - -.. important:: Counter Fields Must be Final - - ``MutableRealmInteger`` is a live object like ``RealmObject``, - ``RealmResults`` and ``RealmList``. This means the value contained - inside the ``MutableRealmInteger`` can change when a realm is - written to. For this reason ``MutableRealmInteger`` fields must be - marked final in Java and ``val`` in Kotlin. - -Usage ------ - -The :java-sdk:`counter.increment() ` -and :java-sdk:`counter.decrement() ` -operators ensure that increments and decrements from multiple distributed -clients are aggregated correctly. - -To change a :java-sdk:`MutableRealmInteger -` value, call ``increment()`` or -``decrement()`` within a write transaction: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.counter-increment-decrement.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.counter-increment-decrement.java - :language: java - :copyable: false - -You can assign a ``MutableRealmInteger`` a new value with a call to -:java-sdk:`counter.set() ` -within a write transaction. - -.. warning:: Counter Resets - - Use the ``set()`` operator with extreme care. ``set()`` ignores - the effects of any prior calls to ``increment()`` or ``decrement()``. - Although the value of a ``MutableRealmInteger`` always converges - across devices, the specific value on which it converges depends on - the actual order in which operations took place. - Mixing ``set()`` with ``increment()`` and ``decrement()`` is - not advised unless fuzzy counting is acceptable. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.counter-set.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/WritesTest.snippet.counter-set.java - :language: java - :copyable: false - -Since ``MutableRealmInteger`` instances retain a reference to their -parent object, neither object can be garbage collected while you still -retain a reference to the ``MutableRealmInteger``. diff --git a/source/sdk/java/model-data/data-types/embedded-objects.txt b/source/sdk/java/model-data/data-types/embedded-objects.txt deleted file mode 100644 index 80564fcaa7..0000000000 --- a/source/sdk/java/model-data/data-types/embedded-objects.txt +++ /dev/null @@ -1,173 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-embedded-objects: - -=========================== -Embedded Objects - Java SDK -=========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -An embedded object is a special type of :ref:`Realm object -` that models complex data about a specific object. -Embedded objects are similar to :ref:`relationships -`, but they provide additional constraints and -map more naturally to the denormalized :manual:`MongoDB document model -`. - -Realm enforces unique ownership constraints that treat each embedded -object as nested data inside of a single, specific parent object. An -embedded object inherits the lifecycle of its parent object and cannot -exist as an independent Realm object. Realm automatically deletes -embedded objects if their parent object is deleted or when overwritten -by a new embedded object instance. - -.. warning:: Realm Uses Cascading Deletes for Embedded Objects - - When you delete a Realm object, Realm automatically deletes any - embedded objects referenced by that object. Any objects that your - application must persist after the deletion of their parent object - should use :ref:`relationships ` - instead. - -Embedded Object Data Models ---------------------------- - -You can define embedded object types using either Realm object models or -a server-side document schema. Embedded object types are reusable and -composable. You can use the same embedded object type in multiple parent -object types and you can embed objects inside of other embedded objects. - -.. important:: - - Embedded objects cannot have a primary key. - -Realm Object Models -~~~~~~~~~~~~~~~~~~~ - -To define an embedded object, derive a class from :java-sdk:`RealmObject -` and set the ``embedded`` property of the -:java-sdk:`RealmClass ` annotation -to ``true``. You can reference an embedded object type from parent -object types in the same way as you would define a relationship: - - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/EmbeddedObjects/DefineEmbeddedObjects.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/EmbeddedObjects/DefineEmbeddedObjects.java - :language: java - :copyable: false - -JSON Schema -~~~~~~~~~~~ - -.. include:: /includes/embedded-object-json-schema.rst - -Read and Write Embedded Objects -------------------------------- - -Create an Embedded Object -~~~~~~~~~~~~~~~~~~~~~~~~~ - -To create an embedded object, assign an instance of the embedded object -to a parent object's property: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/EmbeddedObjects/CreateEmbeddedObject.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/EmbeddedObjects/CreateEmbeddedObject.java - :language: java - :copyable: false - -Update an Embedded Object Property -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To update a property in an embedded object, modify the property in a -write transaction: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/EmbeddedObjects/UpdateEmbeddedObject.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/EmbeddedObjects/UpdateEmbeddedObject.java - :language: java - :copyable: false - -Overwrite an Embedded Object -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To overwrite an embedded object, reassign the embedded object property -of a party to a new instance in a write transaction: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/EmbeddedObjects/ReplaceEmbeddedObject.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/EmbeddedObjects/ReplaceEmbeddedObject.java - :language: java - :copyable: false - -Query a Collection on Embedded Object Properties -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use dot notation to filter or sort a :ref:`collection -` of objects based on an embedded object -property value: - -.. include:: /includes/directly-query-embedded-objects-note.rst - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/EmbeddedObjects/QueryEmbeddedObjects.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/EmbeddedObjects/QueryEmbeddedObjects.java - :language: java - :copyable: false diff --git a/source/sdk/java/model-data/data-types/enums.txt b/source/sdk/java/model-data/data-types/enums.txt deleted file mode 100644 index fc18d413e2..0000000000 --- a/source/sdk/java/model-data/data-types/enums.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-enum: - -======================= -Enumerations - Java SDK -======================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Enumerations, also known as enums, are not supported natively in the -Java SDK. However, you can use Java and Kotlin enums in your -Realm objects if you follow these steps. - -Usage ------ - -To use an enum in a Realm object class, define a field -with a type matching the underlying data type of your enum. Create -getters and setters for the field that convert the field value between -the underlying value and the enum type. You can use the Java's built-in -`Enum.valueOf() -`__ -method to convert from the underlying type to the enum type. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FrogStateKt.snippet.complete.kt - :language: kotlin - :caption: Enum Class - :copyable: false - - .. literalinclude:: /examples/generated/java/local/FrogEnumKt.snippet.complete.kt - :language: kotlin - :caption: Realm Object - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmenum.kt - :language: kotlin - :caption: Usage - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FrogState.snippet.complete.java - :language: kotlin - :caption: Enum Class - :copyable: false - - .. literalinclude:: /examples/generated/java/local/FrogEnum.snippet.complete.java - :language: java - :caption: Realm Object - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmenum.java - :language: java - :caption: Usage - :copyable: false diff --git a/source/sdk/java/model-data/data-types/field-types.txt b/source/sdk/java/model-data/data-types/field-types.txt deleted file mode 100644 index a74908a53b..0000000000 --- a/source/sdk/java/model-data/data-types/field-types.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-field-types: -.. _java-supported-data-types: - -====================== -Field Types - Java SDK -====================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Realm supports the following field data types: - -- ``Boolean`` or ``boolean`` -- ``Integer`` or ``int`` -- ``Short`` or ``short`` -- ``Long`` or ``long`` -- ``Byte`` or ``byte[]`` -- ``Double`` or ``double`` -- ``Float`` or ``float`` -- ``String`` -- ``Date`` -- ``Decimal128`` from ``org.bson.types`` -- ``ObjectId`` from ``org.bson.types`` -- ``UUID`` from ``java.util.UUID`` -- Any ``RealmObject`` subclass -- ``RealmList`` -- ``RealmAny`` -- ``RealmSet`` -- ``RealmDictionary`` - -The ``Byte``, ``Short``, ``Integer``, and ``Long`` types and their -lowercase primitive alternatives are all stored as ``Long`` values -within Realm. Similarly, Realm stores objects -of the ``Float`` and ``float`` types as type ``Double``. - -Realm does not support fields with modifiers ``final`` and -``volatile``, though you can use fields with those modifiers if you -:ref:`ignore ` them. If you choose to provide custom -constructors, you must declare a public constructor with no arguments. - -Updating Strings and Byte Arrays --------------------------------- - -Since Realm operates on fields as a whole, it's not possible -to directly update individual elements of strings or byte arrays. Instead, -you'll need to read the whole field, make your modification to individual -elements, and then write the entire field back again in a transaction block. - -Object IDs and UUIDs --------------------- - -``ObjectId`` and ``UUID`` (Universal Unique Identifier) both provide -unique values that can be used as identifiers for objects. -``ObjectId`` is a :manual:`MongoDB-specific ` -12-byte unique value. ``UUID`` is a :rfc:`standardized ` 16-byte -unique value. Both types are :ref:`indexable ` -and can be used as :ref:`primary keys `. diff --git a/source/sdk/java/model-data/data-types/realmany.txt b/source/sdk/java/model-data/data-types/realmany.txt deleted file mode 100644 index 5d40684282..0000000000 --- a/source/sdk/java/model-data/data-types/realmany.txt +++ /dev/null @@ -1,117 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-realmany: -.. _java-mixed: - -=================== -RealmAny - Java SDK -=================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. versionadded:: 10.6.0 - -.. include:: /includes/note-java-and-realmany.rst - -You can use the :java-sdk:`RealmAny ` data type to create -Realm object fields that can contain any of several -underlying types. You can store multiple ``RealmAny`` instances in -``RealmList``, ``RealmDictionary``, or ``RealmSet`` fields. To change -the value of a ``RealmAny`` field, assign a new ``RealmAny`` instance -with a different underlying value. In Atlas App Services backend -:ref:`object schemas `, the ``RealmAny`` -data type is called **mixed**. ``RealmAny`` fields are indexable, but -cannot be used as primary keys. - -.. note:: ``RealmAny`` Type Compatiblility - - ``RealmAny`` objects can refer to any - :ref:`supported field type ` - *except*: - - - ``RealmAny`` - - ``RealmList`` - - ``RealmSet`` - - ``RealmDictionary`` - -Usage ------ - -To create a ``RealmAny`` instance, use the -:java-sdk:`RealmAny.valueOf() ` method -to assign an initial value or ``RealmAny.nullValue()`` to assign no -value. ``RealmAny`` instances are immutable just like ``String`` or -``Integer`` instances; if you want to assign a new value to a -``RealmAny`` field, you must create a new ``RealmAny`` instance. - -.. warning:: Two Possible Null ``RealmAny`` Values - - ``RealmAny`` instances are always :ref:`nullable - `. Additionally, instances can contain a value - of type ``RealmAny.Type.NULL``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FrogAnyKt.snippet.complete.kt - :language: kotlin - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmany.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FrogAny.snippet.complete.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmany.java - :language: java - :copyable: false - -Queries -------- - -You can query a ``RealmAny`` field just like any other data type. -Operators that only work with certain types, such as :ref:`string -operators ` and arithmetic operators, ignore -values that do not contain that type. Negating such operators matches -values that do not contain the type. Type queries match the underlying -type, rather than ``RealmAny``. Arithmetic operators convert numeric -values implicitly to compare across types. - -Notifications -------------- - -To subscribe to changes to a ``RealmAny`` field, use the -:java-sdk:`RealmObject.addChangeListener -` -method of the enclosing object. You can use the -:java-sdk:`ObjectChangeSet ` -parameter to determine if the ``RealmAny`` field changed. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmany-notifications.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmany-notifications.java - :language: java - :copyable: false diff --git a/source/sdk/java/model-data/data-types/realmdictionary.txt b/source/sdk/java/model-data/data-types/realmdictionary.txt deleted file mode 100644 index 981ead9d15..0000000000 --- a/source/sdk/java/model-data/data-types/realmdictionary.txt +++ /dev/null @@ -1,109 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-realmdictionary: - -========================== -RealmDictionary - Java SDK -========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. versionadded:: 10.6.0 - -You can use the :java-sdk:`RealmDictionary -` data type to manage a collection of -unique ``String`` keys paired with values. ``RealmDictionary`` -implements Java's ``Map`` interface, so it works just like the built-in -``HashMap`` class, except managed ``RealmDictionary`` instances persist -their contents to a realm. ``RealmDictionary`` instances that -contain Realm objects store references to those objects. -When you delete a Realm object from a realm, any -references to that object in a ``RealmDictionary`` become ``null`` -values. - -Usage ------ - -To create a field of type ``RealmDictionary``, define an object property -of type ``RealmDictionary``, where ``T`` defines the values you would -like to store in your ``RealmDictionary``. Currently, ``RealmDictionary`` -instances can only use keys of type ``String``. - -The following table shows which methods you can use to complete common -collection tasks with ``RealmDictionary``: - -.. list-table:: - :header-rows: 1 - :widths: 70 30 - - * - Task - - Method - - * - Add an object to a ``RealmDictionary`` - - :java-sdk:`put() ` (or the ``[]`` operator in Kotlin) - - * - Add multiple objects to a ``RealmDictionary`` - - :java-sdk:`putAll() ` - - * - Check if the dictionary contains an specific key - - :java-sdk:`containsKey() ` - - * - Check if the dictionary contains a specific value - - :java-sdk:`containsValue() ` - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FrogDictionaryKt.snippet.complete.kt - :language: kotlin - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmDictionary.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FrogDictionary.snippet.complete.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmDictionary.java - :language: java - :copyable: false - -Notifications -------------- - -To subscribe to changes to a ``RealmDictionary``, pass a -:java-sdk:`MapChangeListener ` -implementation to the :java-sdk:`RealmSet.addChangeListener ` method. -Your ``MapChangeListener`` implementation must define an -``onChange()`` method, which accepts a reference to the changed ``RealmDictionary`` -and a set of changes as parameters. You can access the keys -added to the dictionary as well as the keys removed from the dictionary -through the ``MapChangeSet`` parameter. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmdictionary-notifications.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmdictionary-notifications.java - :language: java - :copyable: false diff --git a/source/sdk/java/model-data/data-types/realmset.txt b/source/sdk/java/model-data/data-types/realmset.txt deleted file mode 100644 index 8f5ba5cf16..0000000000 --- a/source/sdk/java/model-data/data-types/realmset.txt +++ /dev/null @@ -1,122 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-realmset: - -=================== -RealmSet - Java SDK -=================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. versionadded:: 10.6.0 - -You can use the :java-sdk:`RealmSet ` data type -to manage a collection of unique keys. ``RealmSet`` implements Java's -``Set`` interface, so it works just like the built-in ``HashSet`` class, -except managed ``RealmSet`` instances persist their contents to a -realm. ``RealmSet`` instances that contain Realm objects -actually only store references to those objects, so deleting a -Realm object from a realm also deletes that object from -any ``RealmSet`` instances that contain the object. - -Because ``RealmSet`` implements ``RealmCollection``, it has some useful -mathematical methods, such as ``sum``, ``min``, and ``max``. For a complete -list of available ``RealmSet`` methods, see: :java-sdk:`the RealmSet API -reference `. - -Method Limitations ------------------- - -You cannot use the following ``Realm`` methods on objects that contain -a field of type ``RealmSet``: - -- ``Realm.insert()`` -- ``Realm.insertOrUpdate()`` -- ``Realm.createAllFromJson()`` -- ``Realm.createObjectFromJson()`` -- ``Realm.createOrUpdateAllFromJson()`` -- ``Realm.createOrUpdateObjectFromJson()`` - -Usage ------ - -To create a field of type ``RealmSet``, define an object property of -type ``RealmSet``, where ``E`` defines the keys you would like to -store in your ``RealmSet``. - -- Add an object to a ``RealmSet`` with - :java-sdk:`RealmSet.add() ` - -- Add multiple objects with - :java-sdk:`RealmSet.addAll() ` - -- Check if the set contains a specific object with - :java-sdk:`RealmSet.contains() ` - -- Check if the set contains all of multiple objects with - :java-sdk:`RealmSet.containsAll() ` - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/FrogSetKt.snippet.complete.kt - :language: kotlin - :copyable: false - - .. literalinclude:: /examples/generated/java/local/SnackKt.snippet.complete.kt - :language: kotlin - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmSet.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/FrogSet.snippet.complete.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/Snack.snippet.complete.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmSet.java - :language: java - :copyable: false - -Notifications -------------- - -To subscribe to changes to a ``RealmSet``, pass a -:java-sdk:`SetChangeListener ` -implementation to the :java-sdk:`RealmSet.addChangeListener ` method. -Your ``SetChangeListener`` implementation must define an -``onChange()`` method, which accepts a reference to the changed ``RealmSet`` -and a set of changes as parameters. You can access the number of items -added to the set as well as the number of items removed from the set -through the ``SetChangeSet`` parameter. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmset-notifications.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/DataTypesTest.snippet.realmset-notifications.java - :language: java - :copyable: false \ No newline at end of file diff --git a/source/sdk/java/model-data/define-a-realm-object-model.txt b/source/sdk/java/model-data/define-a-realm-object-model.txt deleted file mode 100644 index a1e0a23bd8..0000000000 --- a/source/sdk/java/model-data/define-a-realm-object-model.txt +++ /dev/null @@ -1,609 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-define-a-realm-object-schema: -.. _java-object-schema: - -====================================== -Define a Realm Object Model - Java SDK -====================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Define a Realm Object ---------------------- - -To define a Realm object in your application, -create a subclass of :java-sdk:`RealmObject ` -or implement :java-sdk:`RealmModel `. - -.. important:: - - - All Realm objects must provide an empty constructor. - - All Realm objects must use the ``public`` visibility modifier in Java - or the ``open`` visibility modifier in Kotlin. - -.. include:: /includes/note-class-char-limit.rst - -Extend ``RealmObject`` -~~~~~~~~~~~~~~~~~~~~~~ - -The following code block shows a Realm object that -describes a Frog. This Frog class can be stored in -Realm because it ``extends`` the ``RealmObject`` class. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogObjectExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogObjectExample.snippet.complete.java.rst - -Implement ``RealmModel`` -~~~~~~~~~~~~~~~~~~~~~~~~ - -The following code block shows a Realm object that -describes a Frog. This Frog class can -be stored in Realm because it ``implements`` the -``RealmModel`` class and uses the ``@RealmClass`` annotation: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogRealmModelExampleKt.snippet.complete.kt.rst - - .. important:: - - All Realm objects must use the ``open`` - visibility modifier. - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogRealmModelExample.snippet.complete.java.rst - - .. important:: - - All Realm objects must use the ``public`` - visibility modifier. - -.. tip:: Using ``RealmObject`` Methods - - When you create a Realm object by extending the ``RealmObject`` - class, you can access ``RealmObject`` class methods dynamically on - instances of your Realm object. Realm objects - created by implementing ``RealmModel`` can access those same methods - statically through the ``RealmObject`` class: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/RealmObjectVsRealmModelTest.snippet.realm-object-vs-realm-model.kt - :language: kotlin - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/RealmObjectVsRealmModelTest.snippet.realm-object-vs-realm-model.java - :language: java - -.. _java-field-relationships-lists-example: - -Lists ------ - -Realm objects can contain lists of non-Realm-object data -types: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogListExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - Unlike lists of Realm objects, these lists can contain - null values. If null values shouldn't be allowed, use the - :ref:`@Required ` annotation. - - .. include:: /examples/generated/java/local/FrogListExample.snippet.complete.java.rst - -.. seealso:: - - :ref:`Data Types: Lists ` - -.. _java-define-an-embedded-object-property: -.. _java-field-relationships-embedded: - -Define an Embedded Object Field -------------------------------- - -Realm provides the ability to nest objects within other -objects. This has several advantages: - -- If using Sync, objects translate into MongoDB documents that - follow a :manual:`denormalized data model `. - -- When you delete an object that contains another object, the delete - operation removes both objects from the realm, so unused objects - don't accumulate in your realm file, taking up valuable space on - user's mobile devices. - -To embed an object, set the ``embedded`` property of the -:java-sdk:`@RealmClass ` -annotation to ``true`` on the class that you'd like to nest within -another class: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FlyEmbeddedExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FlyEmbeddedExample.snippet.complete.java.rst - -Then, any time you reference that class from another class, -Realm will embed the referenced class within the enclosing -class, as in the following example: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogEmbeddedExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogEmbeddedExample.snippet.complete.java.rst - -.. seealso:: - - :ref:`Data Types: Embedded Objects ` - -.. _java-property-annotations: - -Annotations ------------ - -Use annotations to customize your Realm object models. - -.. _java-primary-key: - -Primary Key -~~~~~~~~~~~ - -.. _java-primary-key-fundamentals: - -.. versionadded:: 10.6.0 - - Realm automatically :ref:`indexes ` - primary key fields. Previously, Realm only indexed ``String`` primary - keys automatically. - -Realm treats fields marked with the -:java-sdk:`@PrimaryKey ` annotation -as primary keys for their corresponding object schema. Primary keys are -subject to the following limitations: - -- You can define only one primary key per object schema. - -- Primary key values must be unique across all instances of an object - in a realm. Attempting to insert a duplicate primary key value - results in a :java-sdk:`RealmPrimaryKeyConstraintException - `. - -- Primary key values are immutable. To change the primary key value of - an object, you must delete the original object and insert a new object - with a different primary key value. - -- :ref:`Embedded objects ` cannot define a - primary key. - -You can create a primary key with any of the following types: - -- ``String`` -- ``UUID`` -- ``ObjectId`` -- ``Integer`` or ``int`` -- ``Long`` or ``long`` -- ``Short`` or ``short`` -- ``Byte`` or ``byte[]`` - -Non-primitive types can contain a value of ``null`` as a primary key -value, but only for one object of a particular type, since each primary -key value must be unique. Attempting to insert an object with an existing -primary key into a realm will result in a -:java-sdk:`RealmPrimaryKeyConstraintException `. - -Realm automatically :ref:`indexes ` -primary key fields, which allows you to efficiently read and modify -objects based on their primary key. - -You cannot change the primary key field for an object type after adding -any object of that type to a realm. If you are using Sync, -you cannot change the primary key field for an object after defining the -primary key in your backend :ref:`schema `. - -Embedded objects cannot contain primary keys. - -You may optionally define a primary key for an object type as part of -the :ref:`object schema ` with the -:java-sdk:`@PrimaryKey ` annotation: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogPrimaryKeyExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogPrimaryKeyExample.snippet.complete.java.rst - -.. _java-required-field: - -Required Fields -~~~~~~~~~~~~~~~ - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogRequiredExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogRequiredExample.snippet.complete.java.rst - -.. _java-optional-field: -.. _java-optionality: - -Optional Fields -~~~~~~~~~~~~~~~ - -Fields marked with Java object types and Kotlin nullable types -(ending with ``?``) are nullable by default. All other types -(primitives, non-nullable Kotlin object types) are required by default. -You can mark a nullable field with the :java-sdk:`@Required ` -annotation to prevent that field from holding a null value. -:java-sdk:`RealmLists ` are never nullable, but -you can use the ``@Required`` annotation to prevent objects in a list -from holding a null value, even if the base type would otherwise allow it. -You cannot mark a ``RealmList`` of ``RealmObject`` subtypes as required. - -You can make any of the following types required: - -- ``String`` -- ``UUID`` -- ``ObjectId`` -- ``Integer`` -- ``Long`` -- ``Short`` -- ``Byte`` or ``byte[]`` -- ``Boolean`` -- ``Float`` -- ``Double`` -- ``Date`` -- ``RealmList`` - -Primitive types such as ``int`` and the ``RealmList`` type are -implicitly required. Fields with the ``RealmObject`` type are always -nullable, and cannot be made required. - -.. important:: Kotlin Types and Nullability - - In Kotlin, types are non-nullable by default unless you explicitly - add a ``?`` suffix to the type. You can only annotate - :ref:`nullable types `. Using the - ``@Required`` annotation on non-nullable types will fail compilation. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - In Kotlin, fields are considered nullable only if a field is - marked nullable with the Kotlin `? operator - `__ except - for the following types: - - - ``String`` - - ``Date`` - - ``UUID`` - - ``ObjectId`` - - ``Decimal128`` - - ``RealmAny`` - - You can require any type that ends with the Kotlin ``?`` - operator, such as ``Int?``. - - The ``RealmList`` type is non-nullable by default and cannot be - made nullable. - - .. tab:: - :tabid: java - - Nullable fields are optional by default in Realm, unless - otherwise specified with the :ref:`@Required ` - annotation. The following types are nullable: - - - ``String`` - - ``Date`` - - ``UUID`` - - ``ObjectId`` - - ``Integer`` - - ``Long`` - - ``Short`` - - ``Byte`` or ``byte[]`` - - ``Boolean`` - - ``Float`` - - ``Double`` - - Primitive types like ``int`` and ``long`` are non-nullable by - default and cannot be made nullable, as they cannot be set to a - null value. - -.. _java-default-field-values: - -Default Field Values -~~~~~~~~~~~~~~~~~~~~ - -To assign a default value to a field, use the built-in language features -to assign default values. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - Assign default values in the field declaration: - - .. include:: /examples/generated/java/local/FrogDefaultValueExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - Use the class constructor(s) to assign default values: - - .. include:: /examples/generated/java/local/FrogDefaultValueExample.snippet.complete.java.rst - -.. note:: Default Values and Nullability - - While default values ensure that a newly created object cannot contain - a value of ``null`` (unless you specify a default value of ``null``), - they do not impact the nullability of a field. To make a field - non-nullable, see :ref:`Required Fields `. - -.. _java-index-a-property: -.. _java-index-field: -.. _java-indexes-fundamentals: - -Index a Field -~~~~~~~~~~~~~ - -**Indexes** support the efficient execution of queries in -Realm. Without indexes, Realm must perform a -*collection scan*, i.e. scan every document in a collection, to select -those documents that match a query. If an appropriate index exists for a -query, Realm can use the index to limit the number of -documents that it must inspect. - -Indexes are special data structures that store a small portion of a -realm's data in an easy to traverse form. The index stores the value -of a specific field ordered by the value of the field. The ordering of -the index entries supports efficient equality matches and range-based -query operations. - -Adding an index can speed up some queries at the cost of slightly slower write -times and additional storage and memory overhead. Indexes require space in your -realm file, so adding an index to a property will increase disk space consumed -by your realm file. Each index entry is a minimum of 12 bytes. - -You can index fields with the following types: - -- ``String`` -- ``UUID`` -- ``ObjectId`` -- ``Integer`` or ``int`` -- ``Long`` or ``long`` -- ``Short`` or ``short`` -- ``Byte`` or ``byte[]`` -- ``Boolean`` or ``bool`` -- ``Date`` -- ``RealmAny`` - -Realm creates indexes for fields annotated with -:java-sdk:`@Index `. - -To index a field, use the :java-sdk:`@Index ` -annotation: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogIndexExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogIndexExample.snippet.complete.java.rst - -.. _java-ignore-a-property: -.. _java-ignore-a-field: -.. _java-ignore-field: - -Ignore a Field -~~~~~~~~~~~~~~ - -If you don't want to save a field in your model to a realm, you can -ignore a field. - -Ignore a field from a Realm object model with the -:java-sdk:`@Ignore ` annotation: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogIgnoreExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogIgnoreExample.snippet.complete.java.rst - -.. note:: The SDK ignores ``static`` and ``transient`` Fields - - Fields marked ``static`` or ``transient`` are always ignored, and do - not need the ``@Ignore`` annotation. - -.. _java-rename-field: - -Rename a Field -~~~~~~~~~~~~~~ - -By default, Realm uses the name defined in the model class -to represent fields internally. In some cases you might want to change -this behavior: - -- To make it easier to work across platforms, since naming conventions differ. -- To change a field name in Kotlin without forcing a migration. - -Choosing an internal name that differs from the name used in model classes -has the following implications: - -- Migrations must use the internal name when creating classes and fields. -- Schema errors reported will use the internal name. - -Use the :java-sdk:`@RealmField ` -annotation to rename a field: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogRenameAFieldExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogRenameAFieldExample.snippet.complete.java.rst - -Alternatively, you can also assign a naming policy at the module or -class levels to change the way that Realm interprets field -names. - -You can define a -:java-sdk:`naming policy ` -at the :ref:`module level `, -which will affect all classes included in the module: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/RenameModuleExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/RenameModuleExample.snippet.complete.java.rst - -You can also define a -:java-sdk:`naming policy ` -at the class level, which overrides module level settings: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogClassRenamePolicyExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogClassRenamePolicyExample.snippet.complete.java.rst - -.. _java-rename-object: - -Rename a Class -~~~~~~~~~~~~~~ - -By default, Realm uses the name defined in the model class -to represent classes internally. In some cases you might want to change -this behavior: - -- To support multiple model classes with the same simple name in different packages. -- To make it easier to work across platforms, since naming conventions differ. -- To use a class name that is longer than the 57 character limit enforced by Realm. -- To change a class name in Kotlin without forcing a migration. - -Use the :java-sdk:`@RealmClass ` -annotation to rename a class: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogRenameClassExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogRenameClassExample.snippet.complete.java.rst - -.. _java-omit-classes-from-schema: - -Omit Classes from your Realm Schema ------------------------------------ - -By default, your application's Realm Schema includes all -classes that extend ``RealmObject``. If you only want to include a -subset of classes that extend ``RealmObject`` in your Realm -Schema, you can include that subset of classes in a module and open -your realm using that module: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/OmitModuleExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/OmitModuleExample.snippet.complete.java.rst diff --git a/source/sdk/java/model-data/modify-an-object-schema.txt b/source/sdk/java/model-data/modify-an-object-schema.txt deleted file mode 100644 index d9c0c98090..0000000000 --- a/source/sdk/java/model-data/modify-an-object-schema.txt +++ /dev/null @@ -1,201 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-modify-an-object-schema: -.. _java-local-migrations: -.. _java-local-migration: -.. _java-client-migrations: - -================================= -Change an Object Model - Java SDK -================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. tabs:: - - .. tab:: Local Realms - :tabid: local - - .. _java-og-schema: - - The following examples demonstrate how to add, delete, and modify - properties in a schema. First, make the required schema change. - Then, increment the schema version. Finally, if the change is - breaking (destructive) create a corresponding :ref:`migration function - ` to move data from the original schema - to the updated schema. - - .. note:: Versions Update on Realm Open - - Assume that each schema change shown in the following example - occurs after the application has used the existing schema. The - new schema version numbers apply only after you open the - realm and explicitly specify the new version number. - In other words, you can't specify version 3 without previously - specifying and using versions 0, 1, and 2. - - A realm using schema version ``0`` has a ``Person`` object type: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Migrations/PersonClassV1/PersonClassV1.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Migrations/PersonClassV1/PersonClassV1.java - :language: java - :copyable: false - - .. _java-add-a-property: - - A. Add a Property - ----------------- - - The following example adds a ``lastName`` property to the - :ref:`original Person schema `: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Migrations/PersonClassV2/PersonClassV2.kt - :language: kotlin - :emphasize-lines: 3 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Migrations/PersonClassV2/PersonClassV2.java - :language: java - :emphasize-lines: 5 - :copyable: false - - .. _java-delete-a-property: - - B. Delete a Property - -------------------- - - The following example uses a combined - ``fullName`` property instead of the separate ``firstName`` and - ``lastName`` property in the :ref:`original Person schema `: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Migrations/PersonClassV3/PersonClassV3.kt - :language: kotlin - :emphasize-lines: 2 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Migrations/PersonClassV3/PersonClassV3.java - :language: java - :emphasize-lines: 3 - :copyable: false - - .. _java-modify-a-property-type: - .. _java-rename-a-property: - - C. Modify a Property Type or Rename a Property - ---------------------------------------------- - - The following example modifies the ``age`` property in the - :ref:`original Person schema ` by - renaming it to ``birthday`` and changing the type to ``Date``: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Migrations/PersonClassV4/PersonClassV4.kt - :language: kotlin - :emphasize-lines: 3 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Migrations/PersonClassV4/PersonClassV4.java - :language: java - :emphasize-lines: 5 - :copyable: false - - .. _java-migration-function: - - D. Migration Functions - ---------------------- - - To migrate the realm to conform to the updated - ``Person`` schema, set the realm's - :ref:`schema version ` to ``3`` - and define a migration function to set the value of - ``fullName`` based on the existing ``firstName`` and - ``lastName`` properties and the value of ``birthday`` based on - ``age``: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Migrations/LocalMigration/LocalMigration.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Migrations/LocalMigration/LocalMigration.java - :language: java - :copyable: false - - .. tab:: Synchronized Realms - :tabid: sync - - You can make changes to the schema of a synchronized realm by - modifying the :ref:`JSON Schema ` - defined in your application's backend. Synchronized realms do - not require migration functions, since breaking changes to - synchronized schemas cause synchronization errors. Sync - handles non-breaking changes to synchronized realm schemas - automatically. As a result, both old versions of your schema and - new versions can synchronize as users upgrade their applications. - - To learn more about schema changes to synchronized realms, - see :ref:`synced schema changes `. - - .. note:: Development Mode: Only for Defining Your Initial Schema - - You can define the first version of your application's synced - schema using :ref:`Development Mode `, - which automatically translates client models into - JSON Schema on the backend. However, you should make subsequent - changes to your schema through edits to the JSON Schema in your - App. - -.. tip:: - - You can use the - :java-sdk:`RealmConfiguration.shouldDeleteRealmIfMigrationNeeded() - ` - builder method when constructing a realm to delete the realm - instead of performing a migration when a migration is required. This - can come in handy during development when schemas often change. diff --git a/source/sdk/java/model-data/relationships.txt b/source/sdk/java/model-data/relationships.txt deleted file mode 100644 index 9229ec67a0..0000000000 --- a/source/sdk/java/model-data/relationships.txt +++ /dev/null @@ -1,213 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-client-relationships: - -======================== -Relationships - Java SDK -======================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Relationships -------------- - -Realm allows you to define explicit relationships between the types of -objects in an App. A relationship is an object property that references -another Realm object rather than one of the primitive data types. You -define relationships by setting the type of an object property to -another object type in the :ref:`property schema `. - -Relationships are direct references to other objects in a realm, which -means that you don't need bridge tables or explicit joins to define a -relationship like you would in a relational database. Instead you can -access related objects by reading and writing to the property that -defines the relationship. Realm executes read operations -lazily as they come in, so querying a relationship is just as performant -as reading a regular property. - -There are three primary types of relationships between objects: - -- :ref:`One-to-One Relationship ` -- :ref:`One-to-Many Relationship ` -- :ref:`Inverse Relationship ` - -You can define relationships, collections, and embedded objects in your -object schema using the following types: - -- ``RealmObject`` -- ``RealmList `` - -Use annotations to indicate whether a given field represents a foreign -key relationship or an embedded object relationship. For more -information, see :ref:`Relationship Annotations `. - -.. _java-to-one-relationship: - -To-One Relationship -~~~~~~~~~~~~~~~~~~~ - -A **to-one** relationship means that an object is related in a specific -way to no more than one other object. You define a to-one relationship -for an object type in its :ref:`object schema ` by -specifying a property where the type is the related Realm object type. - -Setting a relationship field to null removes the connection between -objects, but Realm does not delete the referenced object -unless that object is :ref:`embedded `. - -.. _java-to-many-relationship: - -To-Many Relationship -~~~~~~~~~~~~~~~~~~~~ - -A **to-many** relationship means that an object is related in a specific -way to multiple objects. You can create a relationship between one object -and any number of objects using a field of type ``RealmList`` -where ``T`` is a Realm object in your application: - -.. _java-inverse-relationship: - -Inverse Relationship -~~~~~~~~~~~~~~~~~~~~ - -An **inverse relationship** links an object back to any other objects that refer -to it in a defined to-one or to-many relationship. Relationship definitions are -unidirectional, so you must explicitly define a property in the object's model -as an inverse relationship. - -For example, the to-many relationship "User has many Tasks" does not -automatically create the inverse relationship "Task belongs to User". If you -don't specify the inverse relationship in the object model, you would need to -run a separate query to look up the user that is assigned to a given task. - -To define an inverse relationship, define a ``LinkingObjects`` property in your -object model. The ``LinkingObjects`` definition specifies the object type and -property name of the relationship that it inverts. - -Realm automatically updates implicit relationships whenever an -object is added or removed in the specified relationship. You cannot manually -set the value of an inverse relationship property. - -Fields annotated with ``@LinkingObjects`` must be: - -- marked ``final`` -- of type ``RealmResults`` where ``T`` is the type at the opposite - end of the relationship - -Since relationships are many-to-one or many-to-many, following inverse -relationships can result in zero, one, or many objects. - -Like any other ``RealmResults`` set, you can -:ref:`query ` an inverse relationship. - -.. _java-relationships: -.. _java-define-a-relationship-property: -.. _java-field-relationships: - -Define a Relationship Field ---------------------------- - -.. include:: /includes/see-also-define-relationship-in-app-services-ui.rst - -.. warning:: Always Define Accessors and Mutators for Modifiable Fields - - Realm objects use getters and setters to persist updated - field values to your realms. Always use getters and setters for - updates. - -.. _java-field-relationships-many-to-one: - -Many-to-One -~~~~~~~~~~~ - -To set up a many-to-one or one-to-one relationship, create a field -whose type is a Realm object in your application: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogManyToOneExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogManyToOneExample.snippet.complete.java.rst - -.. include:: /includes/note-to-one-relationships-must-be-optional.rst - -Each ``Frog`` references either zero ``Frog`` instances or one other ``Frog`` instance. Nothing -prevents multiple ``Frog`` instances from referencing the same ``Frog`` -as a best friend; the distinction between a many-to-one and a one-to-one -relationship is up to your application. - -.. _java-field-relationships-many-to-many: - -Many-to-Many -~~~~~~~~~~~~ - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogManyToManyExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogManyToManyExample.snippet.complete.java.rst - -``RealmList`` s are containers of ``RealmObject`` s, but otherwise behave -like a regular collection. You can use the same object in multiple -``RealmList`` s. - -.. _java-field-relationships-inverse: -.. _java-inverse-relationships: - -Inverse Relationships -~~~~~~~~~~~~~~~~~~~~~ - -By default, Realm relationships are unidirectional. You -can follow a link from one class to a referenced class, but not in the -opposite direction. Consider the following class defining a ``Toad`` with -a list of ``frogFriends``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/ToadInverseRelationshipExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/ToadInverseRelationshipExample.snippet.complete.java.rst - -You can provide a link in the opposite direction, from ``Frog`` to ``Toad``, -with the :java-sdk:`@LinkingObjects ` -annotation on a ``final`` (in Java) or ``val`` (in Kotlin) field of type -``RealmResults``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/FrogInverseRelationshipExampleKt.snippet.complete.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/FrogInverseRelationshipExample.snippet.complete.java.rst - -.. important:: - - Inverse relationship fields must be marked ``final``. diff --git a/source/sdk/java/quick-starts.txt b/source/sdk/java/quick-starts.txt deleted file mode 100644 index c37c558e3f..0000000000 --- a/source/sdk/java/quick-starts.txt +++ /dev/null @@ -1,19 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-quick-starts: - -======================= -Quick Starts - Java SDK -======================= - -.. toctree:: - :titlesonly: - - Quick Start - Quick Start with Sync - Quick Start with Live Data - -- :doc:`Quick Start ` -- :doc:`Quick Start with Sync ` -- :doc:`Quick Start with Live Data ` diff --git a/source/sdk/java/quick-starts/livedata.txt b/source/sdk/java/quick-starts/livedata.txt deleted file mode 100644 index 309054a01a..0000000000 --- a/source/sdk/java/quick-starts/livedata.txt +++ /dev/null @@ -1,251 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-livedata-quick-start: - -==================================== -Quick Start with LiveData - Java SDK -==================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -This page contains instructions to quickly get Realm integrated -into an example Android application that uses :android:`LiveData -`. This example application -allows a user to increment a counter using a button. - -Prerequisites -------------- - -This quick start guide uses :ref:`Sync ` to synchronize data -changes between clients. Before you begin, ensure you have: - -- :ref:`Installed the Java SDK `. -- :ref:`Created an App `. -- :ref:`Enabled anonymous authentication `. -- :ref:`Enabled Sync `. - -.. note:: Using LiveData without Sync - - To use this quick start without Sync, disable the sync features - in the SDK. You can do this by removing the following lines from your - app-level :file:`build.gradle` file: - - .. code-block:: gradle - - realm { - syncEnabled = true - } - - After removing the lines, re-synchronize the Gradle configuration to - reload the Java SDK in an offline-only state. Remove the lines - related to importing and using Sync Configuration, user login, and - partition values from the ``CounterModel`` file to use the Java SDK - without Sync. - -Clone the LiveData Quick Start Repository ------------------------------------------ - -To get started, copy the `example repo -`__ -into your local environment. - -We've already put together an Android application that has -most of the code you'll need. You can clone the client application -repository directly from GitHub: - -.. code-block:: console - - git clone https://github.com/mongodb-university/realm-android-livedata.git - -The repository contains two branches: -``final`` and ``start``. The ``final`` branch is a finished version -of the app as it should look *after* you complete this tutorial. -To walk through this tutorial, please check out the ``start`` -branch: - -.. code-block:: console - - git checkout start - -Import Dependencies -------------------- - -Now that you've cloned the repo, you need to add the dependencies you'll -need to run the Java SDK and Android LiveData. Begin by adding -the Java SDK dependency to the ``buildscript.dependencies`` -block of your project level :file:`build.gradle` file: - -.. literalinclude:: /examples/generated/java/sync/build.snippet.realm-dependency.gradle - :language: gradle - :emphasize-lines: 10 - :copyable: false - -You'll also have to add the Android LiveData Dependency to the -``dependencies`` block of your app level :file:`build.gradle` file: - -.. literalinclude:: /examples/generated/java/sync/build.snippet.livedata-dependency.gradle - :language: gradle - :emphasize-lines: 10 - :copyable: false - -Next, enable Sync in the SDK by creating the -following top-level block in your app level :file:`build.gradle` file: - -.. literalinclude:: /examples/generated/java/sync/build.snippet.sync-enable.gradle - :language: gradle - :copyable: false - -Then, enable DataBinding by creating the following block in the -``android`` block of your app level :file:`build.gradle` file: - -.. literalinclude:: /examples/generated/java/sync/build.snippet.databinding-enable.gradle - :language: gradle - :emphasize-lines: 15-17 - :copyable: false - -Finally, click the "Sync" button or select :guilabel:`Build > Rebuild Project` -in the application menu to reconfigure your Gradle configuration with -these changes and fetch the dependencies. - -LiveRealmObject ---------------- - -With all of the dependencies in place, it's time to create a -LiveData-compatible interface for our Realm objects. To do so, we'll -have to handle a few events: - -- The ``onActive()`` method enables an observer to subscribe to changes - to the underlying Realm object by adding a change listener. - - .. literalinclude:: /examples/generated/java/sync/LiveRealmObject.snippet.onactive.kt - :language: kotlin - :copyable: false - -- The ``onInactive()`` method enables an observer to unsubscribe to - changes to the underlying Realm object by removing the change listener. - - .. literalinclude:: /examples/generated/java/sync/LiveRealmObject.snippet.oninactive.kt - :language: kotlin - :copyable: false - -- When a change occurs, the ``listener`` member uses the ``setValue()`` - method of the ``LiveData`` parent class to pass the Realm object's - value to the UI unless the object was deleted, in which case the - change listener passes a value of ``null`` instead of passing along - a reference to an invalid, deleted object. - - .. literalinclude:: /examples/generated/java/sync/LiveRealmObject.snippet.listener.kt - :language: kotlin - :copyable: false - -.. seealso:: Using LiveData with ``RealmResults`` - - This example only uses LiveData to display ``RealmObjects`` in the UI. - For a sample implementation displaying ``RealmResults``, - see `LiveRealmResults `__. - -Instantiating LiveData in the ViewModel ---------------------------------------- - -This application stores all of its logic and core data within a ViewModel -called ``CounterModel``. When the application runs, it creates an instance -of ``CounterModel`` that is used until the application closes. That -instance contains the LiveData that displays on the UI of the application. -To create an instance of LiveData, we need to access a ``Counter`` object -stored in a realm and pass it to the ``LiveRealmObject`` constructor. -To accomplish this: - -1. Connect to your App *with your* **App ID**. - -2. Authenticate a user. - -3. Connect to a specific realm using Sync. - -4. Query the realm for a ``Counter``, inserting a new ``Counter`` if - one hasn't already been created in this realm. - -5. Instantiate a ``LiveRealmObject`` using the ``Counter`` instance and - store it in the ``counter`` member of ``CounterModel``. - -The following code snippet implements this behavior: - -.. literalinclude:: /examples/generated/java/sync/CounterModel.snippet.constructor.kt - :language: kotlin - -.. important:: Don't Read or Write on the UI Thread - - Database reads and writes are computationally expensive, so - the SDK disables reads and writes by default on the UI thread. - For simplicity, this example enables UI thread reads and writes with - the ``allowWritesOnUiThread()`` and ``allowQueriesOnUiThread()`` - config builder methods. In production applications, you should almost - always defer reads and writes to a background thread using - asynchronous methods. - -Connecting the ViewModel to the UI ----------------------------------- - -To display the data stored in the ``CounterModel`` on the application UI, -we'll need to access the ``CounterModel`` singleton using the -:android:`viewModels() ` -method when the application creates ``CounterFragment``. Once we've -instantiated the model, we can use the :android:`Android Data Binding -` library to display the model's -data in UI elements. - -To access the ``CounterModel`` singleton when the application creates -``CounterFragment``, place the following code in the ``onCreateView()`` -method of ``CounterFragment``: - -.. literalinclude:: /examples/generated/java/sync/CounterFragment.snippet.getcountermodel.kt - :language: kotlin - :copyable: false - -Next, set up the Data Binding hooks in the UI for the counter fragment: - -.. literalinclude:: /examples/generated/java/sync/counter_fragment.xml - :language: kotlin - :copyable: false - -Finally, connect the model to the binding so that the UI can display the -counter and iterate the counter on button press with the following code -in the ``onCreateView()`` method of ``CounterFragment``: - -.. literalinclude:: /examples/generated/java/sync/CounterFragment.snippet.binding.kt - :language: kotlin - :copyable: false - -Run the Application -------------------- - -Now you should be able to run the sample application. You should see an -interface that looks something like this: - -.. image:: /images/android-livedata-quickstart-app.png - :alt: The LiveData QuickStart Counter app. - -Clicking the "ADD" button should add one to the value of your counter. -With Sync, you can view your App logs to see individual increment -events. Android LiveData is lifecycle-aware, so rotating the screen or -freeing the application's state by clearing your device's RAM should -have no effect on the application state, which should seamlessly resume -and automatically resubscribe to events on resume using the state stored -in the model singleton and the encapsulated LiveData instance. - -Summary -------- - -- Use the the ``LiveRealmObject`` and ``LiveRealmResults`` classes as a template for encapsulating live Realm data in Android LiveData. -- Use a ViewModel to separate underlying data from the UI elements that display that data. -- DataBinding lets you declare relationships between model data and UI elements without explicitly setting values in an Activity or Fragment. - -Feedback --------- - -Did you find this quick start guide helpful? Please let us know with the -feedback form on the right side of the page! diff --git a/source/sdk/java/quick-starts/quick-start-local.txt b/source/sdk/java/quick-starts/quick-start-local.txt deleted file mode 100644 index 04ba8a3150..0000000000 --- a/source/sdk/java/quick-starts/quick-start-local.txt +++ /dev/null @@ -1,265 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-client-quick-start: -.. _java-client-quick-start-local: - -====================== -Quick Start - Java SDK -====================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. tip:: This Guide Does Not Use Device Sync - - This guide can help you get started with device-local Realm. - If your application needs to communicate with a backend - App over the network using features like :ref:`Atlas Device Sync `, Realm - Functions, or user management, you should follow the - :ref:`Quick Start with Sync ` guide. - - -This page contains information to quickly get Realm -integrated into your app. Before you begin, ensure you have: - -- :ref:`Installed the Java SDK ` - -.. include:: /includes/java-initialize-realm.rst - -Define Your Object Model ------------------------- - -Your application's **data model** defines the structure of data -stored within Realm. -You can define your application's data model via Kotlin or -Java classes in your application code with -:ref:`Realm Object Models `. - -To define your application's data model, add the following class -definitions to your application code: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/DefinitelyNotJavaTask.snippet.define-object-model-local.java - :language: java - :caption: Task.java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/TaskStatus.snippet.define-object-model-local.java - :language: java - :caption: TaskStatus.java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.define-object-model-local.kt - :language: kotlin - :caption: Task.kt - :copyable: false - -Open a Realm ------------- - -Use ``RealmConfiguration`` to control the specifics of the realm you -would like to open, including the name or location of the realm, -whether to allow synchronous reads or writes to a realm on the UI -thread, and more. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.open-a-realm-local.java - :language: java - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.open-a-realm-local.kt - :language: kotlin - -Create, Read, Update, and Delete Objects ----------------------------------------- - -Once you have opened a realm, you can modify the -:ref:`objects ` within that realm in a -:ref:`write transaction ` block. - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -To create a new ``Task``, instantiate an instance of the -``Task`` class and add it to the realm in a write block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.create-object-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.create-object-local.kt - :language: kotlin - :copyable: false - -You can retrieve a live :ref:`collection ` -of all items in the realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.read-object-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.read-object-local.kt - :language: kotlin - :copyable: false - -You can also filter that collection using a :ref:`filter -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.filter-collection-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.filter-collection-local.kt - :language: kotlin - :copyable: false - -To modify a task, update its properties in a write transaction block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.update-object-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.update-object-local.kt - :language: kotlin - :copyable: false - -Finally, you can delete a task by calling the ``deleteFromRealm()`` -method in a write transaction block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.delete-object-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.delete-object-local.kt - :language: kotlin - :copyable: false - -Watch for Changes ------------------ - -You can :ref:`watch a realm, collection, or object for changes -` by attaching a custom -``OrderedRealmCollectionChangeListener`` with the ``addChangeListener()`` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.watch-for-changes-local.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.watch-for-changes-local.kt - :language: kotlin - :copyable: false - -Complete Example ----------------- - -If you're running this project in a fresh Android Studio project, you can -copy and paste this file into your application's ``MainActivity`` -- just -remember to: - -- use a package declaration at the top of the file for your own project - -- update the ``import`` statements for ``Task`` and ``TaskStatus`` if - you're using java - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/DefinitelyNotJavaTask.snippet.define-object-model-local.java - :caption: Task.java - :language: java - - .. literalinclude:: /examples/generated/java/local/TaskStatus.snippet.define-object-model-local.java - :caption: TaskStatus.java - :language: java - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.complete.java - :caption: MainActivity.java - :language: java - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/MainActivity.snippet.complete.kt - :caption: MainActivity.kt - :language: kotlin - -Output ------- -Running the above code should produce output resembling the following: - -.. code-block:: shell - - Successfully authenticated anonymously. - - Updated range: 0 to 1 - - Deleted range: 0 to 1 - - Successfully logged out. diff --git a/source/sdk/java/quick-starts/quick-start-sync.txt b/source/sdk/java/quick-starts/quick-start-sync.txt deleted file mode 100644 index b58d24f7cc..0000000000 --- a/source/sdk/java/quick-starts/quick-start-sync.txt +++ /dev/null @@ -1,362 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-client-quick-start-sync: - -================================ -Quick Start with Sync - Java SDK -================================ - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. tip:: This Guide uses Device Sync - - This guide helps you get started with an Android application that - communicates with an App backend. The App provides features - like :ref:`Sync `, Realm Functions, and user management. If - your application requires only local database functionality, - check out the :ref:`Quick Start (Local-only) - ` guide. - -This page contains information to quickly get Atlas App Services -integrated into your app. Before you begin, ensure you have: - -- :ref:`Created an App ` -- :ref:`Enabled Sync ` -- :ref:`Installed the Java SDK ` - -.. include:: /includes/java-initialize-realm.rst - -.. _java-quick-start-init-app: - -Initialize the App ------------------- - -.. include:: /includes/access-app-id.rst - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.initialize-the-app.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.initialize-the-app.kt - :language: kotlin - :copyable: false - -.. note:: Android Studio Errors? - - If Android Studio does not recognize the ``Realm``, ``App``, or - ``AppConfiguration`` types, there could be a problem with the - your Gradle build configuration. To fix the issue: - - - Clean your project with ``Build > Clean Project`` - - - Rebuild your project based on your updated ``build.gradle`` file - with ``Build > Rebuild Project`` - - - Revisit the :ref:`Install the Java SDK ` - guide to make sure that you installed the dependencies correctly. - -Define Your Object Model ------------------------- - -Your application's **data model** defines the structure of data -stored within Realm and synchronized to and from -App Services. You can define your application's data model in two ways: - -- Via :ref:`schemas ` in App Services. - -- Via Kotlin or Java classes in your application code with - :ref:`Realm Object Models `. - -This quick start uses the latter approach, which defines your schema -using classes in your mobile application code. To define your App's -object model in this way, you need to enable :ref:`Development Mode -`. - -Once you've enabled Development Mode, add the following class -definitions to your application code: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/Task.snippet.define-object-model.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/sync/TaskStatus.snippet.complete.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.define-object-model.kt - :language: kotlin - :copyable: false - -.. _java-quick-start-authenticate: - -Authenticate a User -------------------- - -When you have enabled :ref:`anonymous authentication ` in the -App Services UI, users can immediately log into your app without providing any identifying -information: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.authenticate-a-user.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.authenticate-a-user.kt - :language: kotlin - :copyable: false - -Realm provides many additional ways to authenticate, register, and link users. - -Open a Realm ------------- - -Once you have :ref:`enabled Sync ` and authenticated a -user, you can open a synced :ref:`realm `. Use -``SyncConfiguration`` to control the specifics of how your application -synchronizes data with App Services, including timeouts, synchronous -reads and writes on the UI thread, and more. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.open-a-realm.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.open-a-realm.kt - :language: kotlin - :copyable: false - -Create, Read, Update, and Delete Objects ----------------------------------------- - -Once you have opened a realm, you can modify the -:ref:`objects ` within that realm in a -:ref:`write transaction ` block. - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -To create a new ``Task``, instantiate an instance of the -``Task`` class and add it to the realm in a write block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.create-object.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.create-object.kt - :language: kotlin - :copyable: false - -You can retrieve a live :ref:`collection ` -of all items in the realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.read-object.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.read-object.kt - :language: kotlin - :copyable: false - -You can also filter that collection using a :ref:`filter -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.filter-collection.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.filter-collection.kt - :language: kotlin - :copyable: false - -To modify a task, update its properties in a write transaction block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.update-object.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.update-object.kt - :language: kotlin - :copyable: false - -Finally, you can delete a task by calling the ``deleteFromRealm()`` -method in a write transaction block: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.delete-object.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.delete-object.kt - :language: kotlin - :copyable: false - -Watch for Changes ------------------ - -You can :ref:`watch a realm, collection, or object for changes -` by attaching a custom -``OrderedRealmCollectionChangeListener`` with the ``addChangeListener()`` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.watch-for-changes.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.watch-for-changes.kt - :language: kotlin - :copyable: false - -Log Out -------- - -Once logged in, you can log out: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.log-out.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.log-out.kt - :language: kotlin - :copyable: false - -Complete Example ----------------- - -Run the complete example by replacing the appId with your realm app ID. -If you're running this project in a fresh Android Studio project, you can -copy and paste this file into your application's ``MainActivity`` -- just -remember to: - -- change the package declaration so it matches your project - -- replace the App ID placeholder with your App's App ID - -- update the ``import`` statements for ``Task`` and ``TaskStatus`` if - you're using Java - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/Task.snippet.define-object-model.java - :caption: Task.java - :language: java - - .. literalinclude:: /examples/generated/java/sync/TaskStatus.snippet.complete.java - :caption: TaskStatus.java - :language: java - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.complete.java - :caption: MainActivity.java - :language: java - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MainActivity.snippet.complete.kt - :caption: MainActivity.kt - :language: kotlin - -Output ------- -Running the above code should produce output resembling the following: - -.. code-block:: shell - - Successfully authenticated anonymously. - - Updated range: 0 to 1 - - Deleted range: 0 to 1 - - Successfully logged out. diff --git a/source/sdk/java/react-to-changes.txt b/source/sdk/java/react-to-changes.txt deleted file mode 100644 index cd464bba16..0000000000 --- a/source/sdk/java/react-to-changes.txt +++ /dev/null @@ -1,315 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-react-to-changes: -.. _java-client-notifications: -.. _java-live-queries: -.. _java-live-object: - -=========================== -React to Changes - Java SDK -=========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java-subscribe-to-changes: - -Objects in Realm clients are **live objects** that -update automatically to reflect data changes, including -:ref:`synced ` remote changes, and emit -notification events that you -can subscribe to whenever their underlying data changes. - -Any modern app should be able to react when data changes, -regardless of where that change originated. When a user adds -a new item to a list, you may want to update the UI, show a -notification, or log a message. When someone updates that -item, you may want to change its visual state or fire off a -network request. Finally, when someone deletes the item, you -probably want to remove it from the UI. Realm's notification -system allows you to watch for and react to changes in your -data, independent of the writes that caused the changes. - -Realm emits three kinds of notifications: - -- :ref:`Realm notifications ` whenever a specific realm commits a write transaction. -- :ref:`Collection notifications ` whenever any Realm object in a collection changes, including inserts, updates, and deletes. -- :ref:`Object notifications ` whenever a specific Realm object changes, including updates and deletes. - -.. _java-auto-refresh: - -Auto-Refresh ------------- - -Realm objects accessed on a thread associated with a -:android:`Looper ` automatically -update periodically to reflect changes to underlying data. - -The Android UI thread always contains a ``Looper`` instance. If you need -to keep Realm objects around for long periods of time on -any other thread, you should configure a ``Looper`` for that thread. - -.. warning:: Always Close Realm Instances on Non-Looper Threads to Avoid Resource Leaks - - Realms on a thread without a :android:`Looper ` - do not automatically advance their version. This can increase the size of the - realm in memory and on disk. Avoid using realm instances on - non-Looper threads when possible. If you *do* open a realm on a non-Looper - thread, close the realm when you're done using it. - -.. _java-register-a-realm-change-listener: -.. _java-realm-notifications: - -Register a Realm Change Listener --------------------------------- - -You can register a notification handler on an entire realm. -Realm calls the notification handler whenever any write -transaction involving that realm is committed. The -handler receives no information about the change. - -This is useful when you want to know that there has been a -change but do not care to know specifically what changed. -For example, proof of concept apps often use this -notification type and simply refresh the entire UI when -anything changes. As the app becomes more sophisticated and -performance-sensitive, the app developers shift to more -granular notifications. - -.. example:: - - Suppose you are writing a real-time collaborative app. To - give the sense that your app is buzzing with collaborative - activity, you want to have an indicator that lights up when - any change is made. In that case, a realm notification - handler would be a great way to drive the code that controls - the indicator. The following code shows how to observe a realm - for changes with with :java-sdk:`addChangeListener() `: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/Notifications/RealmNotification.java - :language: java - :emphasize-lines: 16 - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/Notifications/RealmNotification.kt - :language: kotlin - :emphasize-lines: 12 - :copyable: false - -.. important:: Automatic Refresh - - All threads that contain a ``Looper`` automatically refresh - ``RealmObject`` and ``RealmResult`` instances when new changes are - written to the realm. As a result, it isn't necessary to fetch - those objects again when reacting to a ``RealmChangeListener``, since - those objects are already updated and ready to be redrawn to the - screen. - -.. _java-register-a-collection-change-listener: -.. _java-collection-notifications: - -Register a Collection Change Listener -------------------------------------- - -You can register a notification handler on a specific -collection within a realm. The handler receives a -description of changes since the last notification. -Specifically, this description consists of three lists of -indices: - -- The indices of the objects that were deleted. -- The indices of the objects that were inserted. -- The indices of the objects that were modified. - -Stop notification delivery by calling the ``removeChangeListener()`` or -``removeAllChangeListeners()`` methods. Notifications also stop if: - -- the object on which the listener is registered gets garbage collected. -- the realm instance closes. - -Keep a strong reference to the object you're listening to -for as long as you need the notifications. - -.. important:: Order Matters - - In collection notification handlers, always apply changes - in the following order: deletions, insertions, then - modifications. Handling insertions before deletions may - result in unexpected behavior. - -Realm emits an initial notification after retrieving the -collection. After that, Realm delivers collection -notifications asynchronously whenever a write transaction -adds, changes, or removes objects in the collection. - -Unlike realm notifications, collection notifications contain -detailed information about the change. This enables -sophisticated and selective reactions to changes. Collection -notifications provide all the information needed to manage a -list or other view that represents the collection in the UI. - -The following code shows how to observe a collection for -changes with :java-sdk:`addChangeListener() -`: - - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/NotificationsTest.snippet.collection-notifications.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/NotificationsTest.snippet.collection-notifications.java - :language: java - :copyable: false - -.. _java-register-an-object-change-listener: -.. _java-object-notifications: - -Register an Object Change Listener ----------------------------------- - -You can register a notification handler on a specific object -within a realm. Realm notifies your handler: - -- When the object is deleted. -- When any of the object's properties change. - -The handler receives information about what fields changed -and whether the object was deleted. - -Stop notification delivery by calling the ``removeChangeListener()`` or -``removeAllChangeListeners()`` methods. Notifications also stop if: - -- the object on which the listener is registered gets garbage collected. -- the realm instance closes. - -Keep a strong reference of the object you're listening to -for as long as you need the notifications. - -The following code shows how create a new instance of a class -in a realm and observe that instance for changes with -:java-sdk:`addChangeListener() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/NotificationsTest.snippet.object-notifications.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/NotificationsTest.snippet.object-notifications.java - :language: java - :copyable: false - -.. _java-unregister-a-change-listener: - -Unregister a Change Listener ----------------------------- - -You can unregister a change listener by passing your change listener to -:java-sdk:`Realm.removeChangeListener() -`. -You can unregister all change listeners currently subscribed to changes -in a realm or any of its linked objects or collections with -:java-sdk:`Realm.removeAllChangeListeners() -`. - -.. _java-realm-notifications-system-apps-custom-roms: - -Use Realm in System Apps on Custom ROMs ---------------------------------------- - -Realm uses named pipes in order to support notifications and -access to the realm file from multiple processes. While this is -allowed by default for normal user apps, it is disallowed for system -apps. - -You can define a system apps by setting -``android:sharedUserId="android.uid.system"`` in the Android manifest. -When working with a system app, you may see a security violation in -Logcat that looks something like this: - -.. code-block:: - :copyable: false - - 05-24 14:08:08.984 6921 6921 W .realmsystemapp: type=1400 audit(0.0:99): avc: denied { write } for name="realm.testapp.com.realmsystemapp-Bfqpnjj4mUvxWtfMcOXBCA==" dev="vdc" ino=14660 scontext=u:r:system_app:s0 tcontext=u:object_r:apk_data_file:s0 tclass=dir permissive=0 - 05-24 14:08:08.984 6921 6921 W .realmsystemapp: type=1400 audit(0.0:100): avc: denied { write } for name="realm.testapp.com.realmsystemapp-Bfqpnjj4mUvxWtfMcOXBCA==" dev="vdc" ino=14660 scontext=u:r:system_app:s0 tcontext=u:object_r:apk_data_file:s0 tclass=dir permissive=0 - -In order to fix this you need to adjust the SELinux security rules in -the ROM. This can be done by using the tool ``audit2allow``, which ships -as part of AOSP: - -1. Pull the current policy from the device: - - .. code-block:: - :copyable: false - - adb pull /sys/fs/selinux/policy - -#. Copy the SELinux error inside a text file called input.txt. - -#. Run the ``audit2allow`` tool: - - .. code-block:: - :copyable: false - - audit2allow -p policy -i input.txt - -#. The tool should output a rule you can add to your existing policy - to enable the use of Realm. - -An example of such a policy is provided below: - -.. code-block:: - :copyable: false - - # Allow system_app to create named pipes required by Realm - # Credit: https://github.com/mikalackis/platform_vendor_ariel/blob/master_oreo/sepolicy/system_app.te - allow system_app fuse:fifo_file create; - allow system_app system_app_data_file:fifo_file create; - allow system_app system_app_data_file:fifo_file { read write }; - allow system_app system_app_data_file:fifo_file open; - -.. seealso:: audit2allow - - ``audit2allow`` is produced when compiling AOSP/ROM and only runs on - Linux. You can read more about it `here - `__. - -.. note:: Changes in Android Oreo and Above - - Since Android Oreo, Google changed the way it configures SELinux. - The default security policies are now much more modularized. - Read more about that - `here `__. - -.. _java-change-notification-limits: - -Change Notification Limits --------------------------- - -.. include:: /includes/change-notification-limit.rst diff --git a/source/sdk/java/realm-files.txt b/source/sdk/java/realm-files.txt deleted file mode 100644 index 044ed40229..0000000000 --- a/source/sdk/java/realm-files.txt +++ /dev/null @@ -1,314 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-realms: - -================================ -Work with Realm Files - Java SDK -================================ - -.. toctree:: - :titlesonly: - - Open & Close a Realm - Bundle a Realm - Encrypt a Realm - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -A **realm** is a set of related objects that conform to a pre-defined -schema. Realms may contain more than one type of data as long as a -schema exists for each type. - -Every realm stores data in a separate realm file that -contains a binary encoding of each object in the realm. You can -automatically :ref:`synchronize realm across multiple -devices ` and set up :ref:`reactive -event handlers ` that call a -function any time an object in a realm is created, -modified, or deleted. - -.. _java-realm-lifecycle: - -The Realm Lifecycle -------------------- - -Every realm instance consumes a significant amount of resources. -Opening and closing a realm are both expensive operations, but -keeping a realm open also incurs significant resource overhead. To -maximize the performance of your application, you should minimize the -number of open realms at any given time and limit the number of -open and close operations used. - -However, opening a realm is not always consistently expensive. -If the realm is already open within the same process or thread, -opening an additional instance requires fewer resources: - -- If the realm is not open within the same process, opening the - realm is expensive. - -- If the realm is already open on a different thread within the - same process, opening the realm is less expensive, but still - nontrivial. - -- If the realm is already open on the same thread within the same - process, opening the realm requires minimal additional resources. - -When you open a realm for the first time, Realm -performs the memory-mapping and schema validation required to read and -write data to the realm. Additional instances of that -realm on the same thread use the same underlying resources. -Instances of that realm on separate threads use some of the same -underlying resources. - -When all connections to a realm are closed in -a thread, Realm frees the thread resources used to -connect to that realm. When all connections to a realm are -closed in a process, Realm frees all resources used to -connect to that realm. - -As a best practice, we recommend tying the realm instance -lifecycle to the lifecycles of the views that observe the realm. For -instance, consider a ``RecyclerView`` that displays ``RealmResults`` -data via a ``Fragment``. You could: - -- Open a single realm that contains the data for that view - in the ``Fragment.onCreateView()`` lifecycle method. -- Close that same realm in the ``Fragment.onDestroyView()`` - lifecycle method. - -.. note:: - - If your realm is especially large, fetching a realm instance - in ``Fragment.onCreateView()`` may briefly block rendering. If - opening your realm in ``onCreateView()`` causes performance - issues, consider managing the realm from ``Fragment.onStart()`` - and ``Fragment.onStop()`` instead. - -If multiple ``Fragment`` instances require access to the same dataset, -you could manage a single realm in the enclosing ``Activity``: - -- Open the realm in the ``Activity.onCreate()`` lifecycle method. -- Close the realm in the ``Activity.onDestroy()`` lifecycle method. - -Multi-process -------------- - -You cannot access :ref:`encrypted ` or -:ref:`synced ` realms -simultaneously from different processes. However, local realms -function normally across processes, so you can read, write, and -receive notifications from multiple APKs. - -.. _java-realm-schema: - -Realm Schema ------------- - -A **Realm Schema** is a list of valid :ref:`object schemas -` that each define an object type that an App -may persist. All objects in a realm must conform to the Realm Schema. - -By default, the SDK automatically adds all classes in your project -that derive from :java-sdk:`RealmObject ` to the -realm schema. - -Client applications provide a Realm Schema when they open a -realm. If a realm already contains data, then Realm -validates each existing object to ensure that an object schema was -provided for its type and that it meets all of the constraints specified -in the schema. - -.. example:: - - A realm that contains basic data about books in libraries might use a - schema like the following: - - .. code-block:: json - - [ - { - "type": "Library", - "properties": { - "address": "string", - "books": "Book[]" - } - }, - { - "type": "Book", - "primaryKey": "isbn", - "properties": { - "isbn": "string", - "title": "string", - "author": "string", - "numberOwned": { "type": "int?", "default": 0 }, - "numberLoaned": { "type": "int?", "default": 0 } - } - } - ] - -Synced Realms -------------- - -An app that uses Atlas Device Sync can open a synced realm. - -When you use :ref:`Flexible Sync `, you can customize the -data your client application syncs by :ref:`subscribing to queries -`. These queries search for -data in your App backend, and the Flexible Sync realm syncs data that -matches the queries. The client application can only sync data where the -user has the appropriate :ref:`read or read and write permissions -` to access the data. - -When you use :ref:`Partition-Based Sync `, synced -realms represent partitions of Atlas data. Each realm corresponds to -a subset of the data in your App's data source. You can customize the -:ref:`partitioning ` of data using your application's -:ref:`partition key `. Unique values of the partition -key, known as :ref:`partition values `, correspond to -individual realms. - -You can customize permissions for the data that synced realms can read -and write from your App when you configure -:ref:`Realm Rules `. - -For more information, refer to :ref:`java-open-a-synced-realm`. - -.. _java-realm-path: -.. _java-realm-file: - -Find Your Realm File --------------------- - -Realm stores a binary encoded version of every object -and type in a realm in a single ``.realm`` file. - -.. include:: /includes/find-realm-file-java.rst - -.. seealso:: Auxiliary Realm Files - - Realm creates additional files for each realm. - To learn more about these files, see :ref:`Realm Internals - `. - -.. _java-realm-file-size: - -Realm File Size ---------------- - -Realm usually takes up less space on disk than an -equivalent SQLite database. However, in order to give you a consistent -view of your data, Realm operates on multiple versions of a -realm. If many versions of a realm are opened simultaneously, -the realm file can require additional space on disk. - -These versions take up an amount of space dependent on the amount of -changes in each transaction. Many small transactions have the same -overhead as a small number of large transactions. - -Unexpected file size growth usually happens for one of three reasons: - -1) *You open a realm on a background thread and forget to close it - again.* As a result, Realm retains a reference to the - older version of data on the background thread. Because - Realm automatically updates realms to the most - recent version on threads with loopers, the UI thread and other - Looper threads do not have this problem. - -2) *You hold references to too many versions of frozen objects.* - Frozen objects preserve the version of a realm that existed when - the object was first frozen. If you need to freeze a large number of - objects, consider using :java-sdk:`Realm.copyFromRealm() - ` instead to only preserve the - data you need. - -3) *You read some data from a realm. Then, you block the thread with - a long-running operation. Meanwhile, you write many times to the - realm on other threads.* This causes Realm to - create many intermediate versions. You can avoid this by: - - - batching the writes - - - avoiding leaving the realm open while otherwise blocking the - background thread. - -.. _java-limit-max-number-of-active-versions: - -Limit the Maximum Number of Active Versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can set :java-sdk:`maxNumberOfActiveVersions() -` -when building your ``RealmConfiguration`` to throw an -``IllegalStateException`` if your application opens more versions of -a realm than the permitted number. Versions are created when -executing a write transaction. - -Realm automatically removes older versions of data once -they are no longer used by your application. However, -Realm does not free the space used by older versions of -data; instead, that space is used for new writes to the realm. - -.. _java-compact-a-realm: - -Compact a Realm -~~~~~~~~~~~~~~~ - -You can remove unused space by **compacting** the realm file: - -- Manually: call :java-sdk:`compactRealm() - ` - -- Automatically: specify the :java-sdk:`compactOnLaunch() - ` - builder option when opening the first connection to a realm in your - Android application - -.. important:: Compact All Production Applications - - Every production application should implement compacting to - periodically reduce realm file size. - -.. _java-backup-and-restore-realms: - -Backup and Restore Realms -------------------------- - -Realm persists realms to disk using files on your -Android device. To back up a realm, :ref:`find your realm file -` and copy it to a safe location. You should close -all instances of the realm before copying it. - -Alternatively, you can also use :java-sdk:`realm.writeCopyTo() -` to write a compacted -version of a realm to a destination file. - -.. seealso:: - - If you want to back up a realm to an external location like - Google Drive, see the following article series: (`Part 1 - `__, - `Part 2 `__, - `Part 3 `__). - -.. _java-modules: - -Modules -------- - -Realm Modules describe the set of Realm objects -that can be stored in a realm. By default, Realm -automatically creates a Realm Module that contains all -Realm objects defined in your application. -You can define a :java-sdk:`RealmModule ` -to restrict a realm to a subset of classes defined in an application. -If you produce a library that uses Realm, you can use a -Realm Module to explicitly include only the Realm -objects defined in your library in your realm. This allows -applications that include your library to also use Realm -without managing object name conflicts and migrations with your library's -defined Realm objects. diff --git a/source/sdk/java/realm-files/bundle-a-realm.txt b/source/sdk/java/realm-files/bundle-a-realm.txt deleted file mode 100644 index 67ef1b76bd..0000000000 --- a/source/sdk/java/realm-files/bundle-a-realm.txt +++ /dev/null @@ -1,139 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-bundle-a-realm: - -============================== -Bundle a Realm File - Java SDK -============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. note:: Bundle Synchronized Realms - - SDK version 10.9.0 introduced the ability to bundle synchronized realms. - Before version 10.9.0, you could only bundle local realms. - -Realm supports **bundling** realm files. When you bundle -a realm file, you include a database and all of its data in your -application download. - -This allows users to start applications for the first time with a set of -initial data. For synced realms, bundling can avoid a lengthy -initial download the first time a user opens your application. Instead, -users must only download the synced changes that occurred since you -generated the bundled file. - -.. include:: /includes/note-bundling-synced-realms.rst - -Overview --------- - -To create and bundle a realm file with your application: - -1. :ref:`Create a realm file ` that - contains the data you'd like to bundle. - -#. :ref:`Bundle the realm file ` in the - :file:`//src/main/assets` folder of your production - application. - -#. In your production application, - :ref:`open the realm from the bundled asset file - `. For synced - realms, you must supply the partition key. - -.. include:: /includes/note-writecopy-same-type-sync-only.rst - -.. _java-create-a-realm-for-bundling: - -Create a Realm File for Bundling --------------------------------- - -1. Build a temporary realm app that shares the data model of your - application. - -#. Open a realm and add the data you wish to bundle. If using a - synchronized realm, allow time for the realm to fully sync. - -#. Use the :java-sdk:`writeCopyTo() ` - method to copy the realm to a new file: - - .. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/sync/BundleTest.snippet.copy-a-realm-file.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/sync/BundleTest.snippet.copy-a-realm-file.java.rst - - ``writeCopyTo()`` automatically compacts your realm to the smallest - possible size before copying. - - .. tip:: Differences Between Synced Realms and Local-only Realms - - The above example uses a ``SyncConfiguration`` to configure a synchronized - realm. To create a copy of a local realm, configure your realm - with ``RealmConfiguration`` instead. - -.. _java-bundle-realm-file: - -Bundle a Realm File in Your Production Application ----------------------------------------------------- - -Now that you have a copy of the realm that contains the initial data, -bundle it with your production application. - -1. Search your application logs to find the location of the realm file - copy you just created. - -#. Using the "Device File Explorer" widget in the bottom right of your - Android Studio window, navigate to the file. - -#. Right click on the file and select "Save As". Navigate to the - :file:`//src/main/assets` folder of your production application. - Save a copy of the realm file there. - -.. tip:: Asset Folders - - If your application does not already contain an asset folder, you can - create one by right clicking on your top-level application - folder (:file:``) in Android Studio and selecting - :guilabel:`New > Folder > Assets Folder` in the menu. - -.. _java-open-a-realm-from-a-bundled-realm-file: - -Open a Realm from a Bundled Realm File --------------------------------------- - -Now that you have a copy of the realm included with your production -application, you need to add code to use it. Use the :java-sdk:`assetFile() -` -method when configuring your realm to open the realm -from the bundled file: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/sync/BundleTest.snippet.use-bundled-realm-file.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/sync/BundleTest.snippet.use-bundled-realm-file.java.rst - -.. tip:: Differences Between Synced Realms and Local-only Realms - - The above example uses a ``SyncConfiguration`` to configure a synchronized - realm. To create a copy of a local realm, configure your realm - with ``RealmConfiguration`` instead. diff --git a/source/sdk/java/realm-files/encryption.txt b/source/sdk/java/realm-files/encryption.txt deleted file mode 100644 index 6c2e241c7d..0000000000 --- a/source/sdk/java/realm-files/encryption.txt +++ /dev/null @@ -1,182 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-encrypt-a-realm: - -========================== -Encrypt a Realm - Java SDK -========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - - -Overview --------- - -You can encrypt your realms to ensure that the data stored to disk can't be -read outside of your application. You encrypt the realm file on disk with AES-256 + -SHA-2 by supplying a 64-byte encryption key when :ref:`opening a -realm `. - -Realm transparently encrypts and decrypts data with standard -:wikipedia:`AES-256 encryption ` using the -first 256 bits of the given 512-bit encryption key. Realm -uses the other 256 bits of the 512-bit encryption key to validate -integrity using a :wikipedia:`hash-based message authentication code -(HMAC) `. - -.. include:: /includes/encrypt-use-strong-cryptographic-hash.rst - -Considerations --------------- - -The following are key impacts to consider when encrypting a realm. - -Storing & Reusing Keys -~~~~~~~~~~~~~~~~~~~~~~ - -You **must** pass the same encryption key to :java-sdk:`RealmConfiguration.Builder.encryptionKey() -` each -time you open the realm. -If you don't provide a key or specify the wrong key for an encrypted -realm, the Realm SDK throws an error. - -Apps should store the encryption key in the -:android:`Android KeyStore ` so -that other apps cannot read the key. - -Performance Impact -~~~~~~~~~~~~~~~~~~ - -Reads and writes on encrypted realms can be up to 10% slower than unencrypted realms. - -Encryption and Atlas Device Sync -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can encrypt a :ref:`synced realm `. - -.. include:: /includes/encrypt-atlas-device-sync.rst - -If you need unique keys for each user of your application, you can use an OAuth provider or -use one of the :ref:`Realm authentication providers ` -and an :ref:`authentication trigger` -to create a 64-bit key and store that key in a :ref:`user object `. - -Accessing an Encrypted Realm from Multiple Processes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. versionchanged:: 10.14.0 - -Starting with Realm Java SDK version 10.14.0, Realm supports opening -the same encrypted realm in multiple processes. - -If your app uses Realm Java SDK version 10.14.0 or earlier, attempting to -open an encrypted realm from multiple processes throws this error: -``Encrypted interprocess sharing is currently unsupported.`` - -Example -------- - -The following steps describe the recommended way to use the -:android:`Android KeyStore ` for encryption with -Realm: - -1. Generate an asymmetric RSA key that Android can securely store and - retrieve using the Android KeyStore. - - .. note:: Android Version M and Above: Keystore Security - - Versions M and above require user PIN or fingerprint to unlock - the KeyStore. - -#. Generate a symmetric key (AES) you can use to encrypt the realm. - -#. Encrypt the symmetric AES key using your private RSA key. - -#. Store the encrypted AES key on filesystem (in a - ``SharedPreferences``, for example). - -When you need to use your encrypted realm: - -1. Retrieve your encrypted AES key. -#. Decrypt your encrypted AES key using the public RSA key. -#. Use the decrypted AES key in the ``RealmConfiguration`` to open the - encrypted realm. - -.. seealso:: - - For an end-to-end example of storing and reusing encryption keys, see - the `store_password `__ example project, which demonstrates the - fingerprint API. - -Generate and Store an Encryption Key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following code demonstrates how to securely generate and store an -encryption key for a realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.encrypt-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.encrypt-key.java - :language: java - :copyable: false - -Access an Existing Encryption Key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following code demonstrates how to access and decrypt a securely -stored encryption key for a realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.decrypt-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.decrypt-key.java - :language: java - :copyable: false - -Open an Encrypted Realm -~~~~~~~~~~~~~~~~~~~~~~~ - -The following code demonstrates how to open an encrypted realm with -the :java-sdk:`encryptionKey() ` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.read-and-write-encrypted-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/EncryptTest.snippet.read-and-write-encrypted-realm.java - :language: java - :copyable: false - diff --git a/source/sdk/java/realm-files/open-and-close-a-realm.txt b/source/sdk/java/realm-files/open-and-close-a-realm.txt deleted file mode 100644 index 73f7a8a6e8..0000000000 --- a/source/sdk/java/realm-files/open-and-close-a-realm.txt +++ /dev/null @@ -1,282 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-open-close-realm: -.. _java-realm-types: - -=============================== -Open & Close a Realm - Java SDK -=============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Interacting with :ref:`realms ` in an Android -application uses the following high-level series of steps: - -#. Create a configuration for the realm you want to open. -#. Open the realm using the config. -#. :ref:`Close the realm ` to free up - resources when you're finished. - -The Default Realm ------------------ - -You can save any :java-sdk:`RealmConfiguration ` -or :java-sdk:`SyncConfiguration ` -as the default for your application using the -:java-sdk:`setDefaultConfiguration() ` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/OpenARealmTest.snippet.set-default-realm.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/OpenARealmTest.snippet.set-default-realm.java.rst - -You can then use -:java-sdk:`getDefaultConfiguration() ` -to access that configuration, or -:java-sdk:`getDefaultInstance() ` -to open a realm with that configuration: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/OpenARealmTest.snippet.use-default-realm.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/OpenARealmTest.snippet.use-default-realm.java.rst - -Local Realms ------------- - -Local realms store data only on the client device. You can customize -the settings for a local realm with ``RealmConfiguration``. - -.. _java-local-realm-configuration: - -Local Realm Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~ - -To configure settings for a realm, create a -:java-sdk:`RealmConfiguration ` with a -:java-sdk:`RealmConfiguration.Builder `. -The following example configures a local realm with: - -- the file name "alternate-realm" -- synchronous reads explicitly allowed on the UI thread -- synchronous writes explicitly allowed on the UI thread -- automatic compaction when launching the realm to save file space - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.configure-a-realm-local.kt - :language: kotlin - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.configure-a-realm-local.java - :language: java - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -.. _java-open-a-local-realm: -.. _java-open-close-local-realm: - -Open a Local Realm -~~~~~~~~~~~~~~~~~~ - -To open a realm, create a -:java-sdk:`RealmConfiguration ` with -:java-sdk:`RealmConfiguration.Builder ` and -pass the resulting ``RealmConfiguration`` to -:java-sdk:`getInstance() ` -or :java-sdk:`getInstanceAsync() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.open-a-realm-local.kt - :language: kotlin - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.open-a-realm-local.java - :language: java - -.. _java-read-only-realms: -.. _java-read-only-realms-fundamentals: - -Read-Only Realms -~~~~~~~~~~~~~~~~ - -It's sometimes useful to ship a prepared realm file with your app -that contains shared data that does not frequently change. You can use -the :java-sdk:`readOnly() ` -method when configuring your realm to make it read-only. This can -prevent accidental writes to the realm and causes the realm to -throw an ``IllegalStateException`` if a write occurs. - -.. warning:: Read-Only Realm Files are Writeable - - Read-only realms are only enforced as read-only in process. - The realm file itself is still writeable. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.read-only.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.read-only.java.rst - -.. _java-in-memory-realms: -.. _java-in-memory-realms-fundamentals: - -In-Memory Realms -~~~~~~~~~~~~~~~~ - -You can create a realm that runs entirely in memory without being written -to a file. When memory runs low on an Android device, in-memory realms -may :wikipedia:`swap ` temporarily from main -memory to disk space. The SDK deletes all files created by an in-memory -realm when: - -- the realm closes -- all references to that realm fall out of scope - -To create an in-memory realm, use :java-sdk:`inMemory() ` -when configuring your realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.in-memory.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.in-memory.java.rst - -.. _java-dynamic-realms: -.. _java-dynamic-realms-fundamentals: - -Dynamic Realms -~~~~~~~~~~~~~~ - -Conventional realms define a schema using ``RealmObject`` subclasses -or the ``RealmModel`` interface. A -:java-sdk:`DynamicRealm ` uses strings to -define a schema at runtime. Opening a dynamic realm uses the same -configuration as a conventional realm, but dynamic realms ignore -all configured schema, migration, and schema versions. - -Dynamic realms offer flexibility at the expense of type safety and -performance. As a result, only use dynamic realms when that -flexibility is required, such as during migrations, manual client -resets, and when working with string-based data like CSV files or JSON. - -To open a Dynamic Realm with a mutable schema, use -:java-sdk:`DynamicRealm `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.dynamic.kt.rst - - .. tab:: - :tabid: java - - .. include:: /examples/generated/java/local/RealmTypesTest.snippet.dynamic.java.rst - -.. _java-close-a-realm: - -Close a Realm -------------- - -It is important to remember to call the :java-sdk:`close() -` method when done with a -realm instance to free resources. Neglecting to close realms can lead to an -``OutOfMemoryError``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.close-a-realm-local.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.close-a-realm-local.java - :language: java - :copyable: false - -.. _java-provide-a-subset-of-classes-to-a-realm: -.. _java-realm-modules: - -Configure Which Classes to Include in Your Realm Schema -------------------------------------------------------- - -Realm modules are collections of Realm object -models. Specify a module or modules when opening a realm to control -which classes Realm should include in your schema. If you -do not specify a module, Realm uses the default module, -which includes all Realm objects defined in your -application. - -.. note:: - - Libraries that include Realm must expose and use their - schema through a module. Doing so prevents the library from - generating the default ``RealmModule``, which would conflict with - the default ``RealmModule`` used by any app that includes the library. - Apps using the library access library classes through the module. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/RealmsTest.snippet.modules.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/RealmsTest.snippet.modules.java - :language: java - :copyable: false diff --git a/source/sdk/java/sync.txt b/source/sdk/java/sync.txt deleted file mode 100644 index 1c277b1c19..0000000000 --- a/source/sdk/java/sync.txt +++ /dev/null @@ -1,91 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-sync-changes-between-devices: -.. _java-realm-sync: - -==================================== -Sync Data Between Devices - Java SDK -==================================== - -.. toctree:: - :titlesonly: - - Configure & Open a Synced Realm - Manage Flexible Sync Subscriptions - Handle Sync Errors - Client Reset - Manual Client Reset Data Recovery - Pause or Resume a Sync Session - Check Upload & Download Progress - Check the Network Connection - Background Sync - Partition-Based Sync - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Atlas Device Sync automatically synchronizes data between client applications and -an :ref:`Atlas App Services backend `. When a client -device is online, Sync asynchronously synchronizes data in a -background thread between the device and your backend App. - -.. seealso:: - - :ref:`enable-realm-sync` - -.. _java-flexible-sync-fundamentals: - -Flexible Sync -------------- - -When you select :ref:`Flexible Sync ` for your backend App -configuration, your client implementation must include subscriptions to -queries on :ref:`queryable fields `. Flexible Sync works -by synchronizing data that matches query subscriptions you maintain in the -client application. - -A subscription set contains a set of queries. Realm Flexible Sync returns -documents matching those queries, where the user has the appropriate -:ref:`permissions ` to read and/or -read and write the documents. If documents match the query, but the client -does not have the permission to read or write them, they do not sync to -the client application. - -You can form queries using :ref:`Realm Query Language `. - -.. include:: /includes/note-unsupported-flex-sync-rql-operators.rst - -Subscription sets are based on a specific type of :ref:`Realm object `. -You might have multiple subscriptions if you have many types of Realm objects. - -To use Flexible Sync in your client application, open a synced realm -with a flexible sync configuration. Then, manage subscriptions -to determine which documents to sync. - -.. _java-sync-data: - -Sync Data ---------- - -The syntax to :ref:`read `, :ref:`write -`, and -:ref:`watch for changes ` on a -synced realm is identical to the syntax for non-synced realms. While you work with -local data, a background thread efficiently integrates, uploads, and downloads changesets. - -.. important:: When Using Sync, Avoid Writes on the Main Thread - - The fact that Realm performs sync integrations on a background thread means - that if you write to your realm on the main thread, there's a small chance your UI - could appear to hang as it waits for the background sync thread to finish a write - transaction. Therefore, it's a best practice :ref:`never to write on the main thread - when using Sync `. - -Group Updates for Improved Performance -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/sync-memory-performance.rst diff --git a/source/sdk/java/sync/background-sync.txt b/source/sdk/java/sync/background-sync.txt deleted file mode 100644 index b982cdf6f0..0000000000 --- a/source/sdk/java/sync/background-sync.txt +++ /dev/null @@ -1,120 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-sync-a-realm-background: - -========================================= -Sync a Realm in the Background - Java SDK -========================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -If you need to sync data when your app isn't running, you can sync realms -in a background process. - -Prerequisites -------------- - -To get started with background synchronization, you need to add the -following dependencies to your Android application: - -- :android:`androidx.work:work-runtime `, - to enqueue jobs -- :android:`androidx.concurrent:concurrent-futures `, - to return job results from a background worker - -Example -------- - -Background sync requires two things: - -- synchronization logic -- a scheduled job that periodically performs that logic. - -Synchronization Logic -~~~~~~~~~~~~~~~~~~~~~ - -First, write the custom logic that synchronizes your realm. Treat this -logic as a standalone connection to your backend. As a result, you'll -need to: - -- initialize the Realm SDK -- authenticate a user to open the realm - -You can use a user's cached credentials if the user recently used the app. - -Open the realm, then use :ref:`SyncSession.downloadAllServerChanges() ` -and :ref:`SyncSession.uploadAllLocalChanges() ` -to synchronize the realm fully with the backend. - -You can execute this logic as a background process using a subclass of -:android:`ListenableWorker `. -Put your synchronization logic in the ``startWork()`` method of your worker: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/RealmBackgroundWorkerKt.snippet.background-sync-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/RealmBackgroundWorker.snippet.background-sync-realm.java - :language: java - :copyable: false - -Worker -~~~~~~ - -To create a worker that periodically performs background sync: - -1. Create a set of constraints that specify the conditions required for - your worker. - -#. Specify how frequently your worker should execute. - -#. Enqueue your worker with the Android OS. Assign it a unique identifier - so that you can update the job in the future. - -You can create the background sync job inside an Application subclass in -your app to guarantee that the logic only executes once every time your -application runs. - -Since synchronizing a realm uses data, you should consider only downloading -changes in the background when the device is *not*: - -- low on battery -- using a metered data source - -Use :android:`Constraints ` -to describe the environment where your background sync runs. - -Your repeat interval depends on how frequently data updates in the -realm and how often users open your application. If the realm frequently -updates throughout the day, consider setting a repeat interval of 1-3 hours. -If the realm only updates a small number of times each day, it's best to -set a higher repeat interval and only background sync once or twice a day. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/CustomApplication.snippet.background-sync-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/CustomApplicationJava.snippet.background-sync-realm.java - :language: java - :copyable: false diff --git a/source/sdk/java/sync/configure-and-open-a-synced-realm.txt b/source/sdk/java/sync/configure-and-open-a-synced-realm.txt deleted file mode 100644 index ac2be4e2e9..0000000000 --- a/source/sdk/java/sync/configure-and-open-a-synced-realm.txt +++ /dev/null @@ -1,137 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-open-a-synced-realm: - -=================================== -Configure a Synced Realm - Java SDK -=================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. include:: /includes/note-java-and-realmany.rst - -Prerequisites -------------- - -Before you can access a synced realm from the client, you must: - -1. :ref:`Enable sync ` in the App Services UI. - -#. :ref:`Initialize the app ` - -#. Enable Sync in your application by adding the following to the - top level of your application-level :file:`build.gradle` file: - - .. code-block:: groovy - - realm { syncEnabled = true } - -#. :ref:`Authenticate a user ` in - your client project. - -.. _java-synced-realms: - -Synced Realms -------------- - -Synced realms use :ref:`Atlas Device Sync ` to store data both on the client device -and in your synced data source. Opening a synced realm works exactly -like opening a local realm, except you use ``SyncConfiguration`` -to customize the settings for synced realms. - -.. _java-synced-realm-configuration: -.. _java-flexible-sync-open-realm: - -Synced Realm Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To configure settings for a realm, create a -:java-sdk:`SyncConfiguration ` with a -:java-sdk:`SyncConfiguration.Builder `. - -To open a synced realm, call -:java-sdk:`getInstanceAsync() -`, -passing in a :java-sdk:`SyncConfiguration ` -object. - -When your application uses Flexible Sync, call -the :java-sdk:`initialSubscriptions() -` -sync configuration builder method -with an instance of -:java-sdk:`SyncConfiguration.InitialFlexibleSyncSubscriptions() -` -to open a synced realm. In the ``configure()`` method, instantiate -an ``UnmanagedSubscription`` with a name and query using -:java-sdk:`Subscription.create() -`. -Pass your new subscription -to the ``add()`` method of the :java-sdk:`MutableSubscriptionSet -` -parameter to add it to your subscriptions: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.open-a-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.open-a-realm.java - :language: java - :copyable: false - -.. seealso:: - - For more information about subscriptions, see - :ref:`Subscribe to Queryable Fields `. - -.. include:: /includes/java-synchronous-reads-writes-ui-thread-fs.rst - -.. _java-open-a-synced-realm-while-offline: - -Open a Synced Realm While Offline -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can open a synced realm when offline with the exact same syntax -that you use to :ref:`open a synced realm while online -`. Not all SDKs follow this -pattern, so cross-platform developers should consult the documentation -for each SDK to learn more. - -.. _java-close-a-synced-realm: - -Close a Realm -------------- - -It is important to remember to call the :java-sdk:`close() -` method when done with a -realm instance to free resources. Neglecting to close realms can lead to an -``OutOfMemoryError``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.close-a-realm-local.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/OpenARealmTest.snippet.close-a-realm-local.java - :language: java - :copyable: false diff --git a/source/sdk/java/sync/flexible-sync.txt b/source/sdk/java/sync/flexible-sync.txt deleted file mode 100644 index c0e7434072..0000000000 --- a/source/sdk/java/sync/flexible-sync.txt +++ /dev/null @@ -1,379 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-flexible-sync: - -============================================= -Manage Flexible Sync Subscriptions - Java SDK -============================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Overview --------- - -Flexible Sync uses subscriptions and permissions to determine which -data to sync with your App. - -To use Flexible Sync in the SDK: - -- :ref:`Configure Flexible Sync on the backend ` -- :ref:`Initialize the app ` -- :ref:`Authenticate a user ` in - your client project. -- :ref:`Open the synced Realm with a Flexible Sync configuration ` -- :ref:`Add subscriptions to the client application ` - -You can add, update, and remove query subscriptions to determine which data -syncs to the client device. - -.. seealso:: - - This page details how to manage subscriptions for Flexible Sync. - - For general information about using Atlas Device Sync with the SDK, - such as how to sync changes in the background or pause a sync session, - check out :ref:`Sync Changes Between Devices `. - - For information about setting up permissions for Flexible Sync, check out - :ref:`Flexible Sync Rules & Permissions `. - -.. _java-sync-subscribe-to-queryable-fields: - -Subscribe to Queryable Fields ------------------------------ - -When you configure Flexible Sync on the backend, you specify which fields -your client application can query. In the client application, use the -``subscriptions`` API to manage a set of subscriptions to specific queries on -queryable fields. You can construct queries with the :ref:`Java SDK's fluent interface -` or :ref:`Realm Query Language `. - -.. important:: - - Flexible Sync does not support all the operators available in Realm - Query Language. See :ref:`Flexible Sync RQL Limitations - ` for details. - -You can: - -- Add subscriptions -- React to subscription state -- Update subscriptions with new queries -- Remove individual subscriptions or all subscriptions for an object type - -Data matching the subscription, where the user has the appropriate -permissions, syncs between clients and the backend application. - -You can specify an optional string name for your subscription. - -.. tip:: Always Specify a Subscription Name - - Always specify a subscription name if your application uses multiple - subscriptions. This makes your subscriptions easier to look up, - update, and delete elsewhere in your app. - -When you create a subscription, Realm looks for data matching a query on a -specific object type. You can have multiple subscription sets on different -object types. You can also have multiple queries on the same object type. - - -You can create a subscription with an explicit name. Then, you can -search for that subscription by name to update or remove it. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.explicitly-named-subscription.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.explicitly-named-subscription.java - :language: java - :copyable: false - -You can also search subscriptions by query. If you omit the name when -creating a subscription, this is the only way to look up your -subscription. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.implicitly-named-subscription.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.implicitly-named-subscription.java - :language: java - :copyable: false - -.. note:: Duplicate subscriptions - - Subscription names must be unique. Adding a subscription - with the same name as an existing subscription throws an error. - - If you do not explicitly name a subscription, and instead subscribe - to the same unnamed query more than once, Realm does not persist - duplicate queries to the subscription set. - - If you subscribe to the same query more than once under different names, - Realm persists both subscriptions to the subscription set. - -.. _java-sync-add-subscription: - -Add a Subscription -~~~~~~~~~~~~~~~~~~ - -Add a subscription in a subscriptions write block. You append each -new subscription to the client's Realm subscriptions. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.add-a-subscription.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.add-a-subscription.java - :language: java - :copyable: false - -.. note:: Object Links - - You must add both an object and its linked object to the subscription - set to see a linked object. - - If your subscription results contain an object with a property that links - to an object not contained in the results, the link appears to be null. - There is no way to distinguish whether that property's value is - legitimately null, or whether the object it links to exists but is out of - view of the query subscription. - -.. _java-sync-check-subscription-state: -.. _java-sync-react-to-subscription-changes: - -Wait for Subscription Changes to Sync -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Writing an update to the subscription set locally is only one component -of changing a subscription. After the local subscription change, the client -synchronizes with the server to resolve any updates to the data due to -the subscription change. This could mean adding or removing data from the -synced realm. Use the :java-sdk:`waitForInitialRemoteData() -` -builder method to force your application to block until client subscription -data synchronizes to the backend before opening the realm: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.wait-for-subscription-sync.kt - :language: kotlin - :emphasize-lines: 11-14 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.wait-for-subscription-sync.java - :language: java - :emphasize-lines: 10 - :copyable: false - -You can also use :java-sdk:`SubscriptionSet.waitForSynchronization() -` -or :java-sdk:`SubscriptionSet.waitForSynchronizationAsync() -` -to delay execution until subscription sync completes after instantiating -a sync connection. - -SubscriptionSet.State Enum -`````````````````````````` - -Additionally, you can watch the state of the subscription set with the -:java-sdk:`SubscriptionSet.State ` enum. -You can use subscription state to: - -- Show a progress indicator while data is downloading -- Find out when a subscription set becomes superseded - -You can access the state of your application's subscription set using -:java-sdk:`SubscriptionSet.getState() `. - -.. include:: /includes/note-sync-state-complete.rst - -Superseded -`````````` - -``SUPERSEDED`` is a ``SubscriptionSet.State`` that can occur when another -thread writes a subscription on a different instance of the -subscription set. If the state becomes ``SUPERSEDED``, you must obtain -a new instance of the subscription set before you can write to it. - -.. _java-update-subscriptions-with-new-query: - -Update Subscriptions with a New Query -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can update subscriptions using :java-sdk:`SubscriptionSet.update() -`. -In this example, we use :java-sdk:`MutableSubscriptionSet.addOrUpdate() -` -to update the query for the subscription named "my frog subscription": - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.update-subscriptions-by-name.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.update-subscriptions-by-name.java - :language: java - :copyable: false - -You cannot update subscriptions created without a name. However, you can -look up unnamed subscriptions by their query, remove them from the -subscription set, then add a new subscription with an updated query: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.update-subscriptions-by-query.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.update-subscriptions-by-query.java - :language: java - :copyable: false - -.. _java-remove-subscriptions: - -Remove Subscriptions -~~~~~~~~~~~~~~~~~~~~ - -To remove subscriptions, you can: - -- Remove a single subscription query -- Remove all subscriptions to a specific object type -- Remove all subscriptions - -When you remove a subscription query, Realm asynchronously removes the -synced data that matched the query from the client device. - -Remove a Single Subscription -```````````````````````````` - -You can remove a specific subscription query -using :java-sdk:`MutableSubscriptionSet.remove() -`. -You can either look up the subscription by name, then pass the returned -subscription to ``remove()``, or pass the subscription name directly to -``remove()``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-single-subscription.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-single-subscription.java - :language: java - :copyable: false - -Remove All Subscriptions to an Object Type -`````````````````````````````````````````` - -If you want to remove all subscriptions to a specific object type, pass -a class to the :java-sdk:`removeAll() -` -method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-all-subscriptions-to-an-object-type.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-all-subscriptions-to-an-object-type.java - :language: java - :copyable: false - -Remove All Subscriptions -```````````````````````` - -To remove all subscriptions from the subscription set, use -:java-sdk:`removeAll() ` -with no arguments: - -.. warning:: - - If you remove all subscriptions and do not add a new one, you'll - get an error. A realm opened with a flexible sync configuration needs - at least one subscription to sync with the server. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-all-subscriptions.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/FlexibleSyncTest.snippet.remove-all-subscriptions.java - :language: java - :copyable: false - -.. _java-flexible-sync-rql-limitations: - -Flexible Sync RQL Requirements and Limitations ------------------------------------------------ - -.. include:: /includes/flex-sync-limitations.rst diff --git a/source/sdk/java/sync/handle-sync-errors.txt b/source/sdk/java/sync/handle-sync-errors.txt deleted file mode 100644 index 250e5d531d..0000000000 --- a/source/sdk/java/sync/handle-sync-errors.txt +++ /dev/null @@ -1,40 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-handle-sync-errors: - -============================= -Handle Sync Errors - Java SDK -============================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -You can configure an error handler to detect and respond to any errors that -occur in the Sync process. To define an error handler, pass an -:java-sdk:`ErrorHandler ` -to the :java-sdk:`SyncConfiguration.Builder.errorHandler() -` -builder method: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ErrorHandlerTest.snippet.error-handler.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ErrorHandlerTest.snippet.error-handler.java - :language: java - :copyable: false - -.. include:: /includes/sync-errors-in-app-services.rst - \ No newline at end of file diff --git a/source/sdk/java/sync/manual-client-reset-data-recovery.txt b/source/sdk/java/sync/manual-client-reset-data-recovery.txt deleted file mode 100644 index 67f94360be..0000000000 --- a/source/sdk/java/sync/manual-client-reset-data-recovery.txt +++ /dev/null @@ -1,337 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-advanced-manual-client-reset-data-recovery: - -============================================ -Manual Client Reset Data Recovery - Java SDK -============================================ - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. important:: Manual Recovery is Manual - - Manual recovery requires significant amounts of code, schema concessions, - and custom conflict resolution logic. If your application can accommodate - losing unsynced data during a client reset, try the - :ref:`discard unsynced changes ` - client reset strategy instead. - -.. warning:: Avoid Making Breaking Schema Changes in Production - - Do not expect to recover all unsynced data after a breaking schema - change. The best way to preserve user data is to never make a - breaking - also called destructive - schema change at all. - -.. include:: /includes/destructive-schema-change-app-update.rst - -The **manually recover unsynced changes** client reset strategy gives -developers the opportunity to recover data already written to -the client realm file but not yet synced to the backend. The -following steps demonstrate the process at a high level: - -1. **Client reset error**: Your application receives a client reset - error code from the backend. - -#. **Strategy implementation**: The SDK calls your strategy - implementation. - -#. **Close all instances of the realm**: Close *all open instances* of - the realm experiencing the - client reset. If your application architecture makes this difficult - (for instance, if your app uses many realm instances simultaneously - in listeners throughout the application), it may be easier to restart - the application. You can do this programmatically or through a direct - request to the user in a dialog. - -#. **Move the realm to a backup file**: Call the ``executeClientReset()`` - method of the provided :java-sdk:`ClientResetRequiredError - `. - This method moves the current copy of the client realm file to a - backup file. - -#. **Open new instance of the realm**: Open a new instance of the realm - using your typical sync configuration. If your application uses - multiple realms, you can identify the realm experiencing a client - reset from the backup file name. - -#. **Download all realm data from the backend**: Download the entire set - of data in the realm before you proceed. If your sync configuration - doesn't specify the :java-sdk:`waitForInitialRemoteData() - ` - option, you can call :java-sdk:`SyncSession.downloadAllServerChanges() - ` - after opening the realm. - -#. **Open the realm backup**: Use the :java-sdk:`getBackupRealmConfiguration() - ` - method of the provided ``ClientResetRequiredError`` to open an - instance of the client realm file from the backup file. You must open - this instance as a :java-sdk:`DynamicRealm `, - a type of realm that uses text field lookups for all data access. - -#. **Migrate unsynced changes**: Query the backup realm for data to - recover. Insert, delete or update data in the new realm accordingly. - -To handle client resets with the "manually recover unsynced changes" -strategy, pass an instance of :java-sdk:`ManuallyRecoverUnsyncedChangesStrategy -` to -the :java-sdk:`defaultSyncClientResetStrategy() -` -builder method when you instantiate your ``App``. Your -``ManuallyRecoverUnsyncedChangesStrategy`` instance must implement the -following methods: - -- ``onClientReset()``: called when the SDK receives a client reset error - from the backend. - -The following example implements this strategy: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-manually-recover-unsynced-changes.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-manually-recover-unsynced-changes.java - :language: java - :copyable: false - -.. note:: ``handleManualReset()`` Implementation - - This client reset example calls a separate method that handles the - specific logic of the client reset. Continue reading the sections - below for an :ref:`example implementation `. - -The specifics of manual recovery depend heavily upon your application -and your schema. However, there are a few techniques that can help with -most manual recoveries. The following example implementation demonstrates -one method of recovering unsynced changes from a backup realm. - -Example -------- - -This example adds a "Last Updated Time" to each object model to track -when each object last changed. We'll watch the realm for the -"Last Synced Time" to determine when the realm last uploaded its state -to the backend. Then, we can find objects that were deleted, created, -or updated since the last sync with the backend, and copy that data from -the backup realm to the new realm. - -.. _java-manual-recovery-implementation-track-updates: - -Track Updates to Objects -~~~~~~~~~~~~~~~~~~~~~~~~ - -Ordinarily, there is no way to detect when a Realm object was last -modified. This makes it difficult to determine which changes were synced -to the backend. By adding a timestamp to your Realm object classes and -updating that timestamp to the current time whenever a change occurs, -you can keep track of when objects were changed: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/Potato.snippet.potato-kotlin-definition.kt - :language: kotlin - :caption: Potato.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/PotatoJava.snippet.potato-java-definition.java - :language: java - :caption: Potato.java - :copyable: false - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/Onion.snippet.onion-kotlin-definition.kt - :language: kotlin - :caption: Onion.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/OnionJava.snippet.onion-java-definition.java - :language: java - :caption: Onion.java - :copyable: false - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/Rice.snippet.rice-kotlin-definition.kt - :language: kotlin - :caption: Rice.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/RiceJava.snippet.rice-java-definition.java - :language: java - :caption: Rice.java - :copyable: false - -.. _java-manual-recovery-implementation-track-successful-syncs: - -Track Successful Syncs -~~~~~~~~~~~~~~~~~~~~~~ - -Just knowing when objects were changed isn't enough to recover data -during a client reset. You also need -to know when the realm last completed a sync successfully. This example -implementation uses a singleton object called ``LastSynced`` in the -realm, paired with an upload progress listener, to record whenever a -realm finishes syncing successfully. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/LastSynced.snippet.last-synced-kotlin-definition.kt - :language: kotlin - :caption: LastSynced.kt - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/LastSyncedJava.snippet.last-synced-java-definition.java - :language: java - :caption: LastSynced.java - :copyable: false - -You can use :java-sdk:`SyncSession.addUploadProgressListener() -` -to listen for upload progress events in your ``App``. Implement -``onChange()`` to handle these events. Call -:java-sdk:`Progress.isTransferComplete() -` to check if -the upload has completed. When ``isTransferComplete()`` returns true, -all clientside updates, inserts, and deletes in the realm have -successfully synced to the backend, and you can -update the ``LastSynced`` time to the current time. To prevent -``LastSynced`` from looping on updates to the ``LastSynced`` time, -don't update the ``LastSynced`` time if it's been less than, say, -10ms since you last updated the time. - -Register your progress listener with :java-sdk:`ProgressMode.INDEFINITELY -` to subscribe -your listener to all future upload progress events, instead of just the -current upload's progress events. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.keep-track-of-last-synced-time.kt - :language: kotlin - :caption: Upload Progress Listener - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.keep-track-of-last-synced-time.java - :language: Upload Progress Listener - :copyable: false - -.. _java-manual-recovery-implementation: - -Manual Recovery with Last Updated Time and Last Synced Time -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Now that you've recorded update times for all objects in your application -as well as the last time your application completed a sync, it's time to -implement the manual recovery process. This example handles two main -recovery operations: - -- restoring unsynced inserts and updates from the backup realm -- deleting objects from the new realm that were previously deleted from - the backup realm - -You can follow along with the implementation of these operations in the -code samples below. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.handle-manual-reset.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.handle-manual-reset.java - :language: java - :copyable: false - -.. note:: This Example is Simplified - - This example keeps track of the last time each *object* was updated. As - a result, the recovery operation overwrites the entire object in the - new realm if any field was updated after the last successful sync - of the backup realm. This could overwrite fields updated by other - clients with old data from this client. If your realm objects contain - multiple fields containing important data, consider keeping track of - the last updated time of each *field* instead, and recovering each - field individually. - -Alternative Implementations ---------------------------- - -Other possible implementations include: - -- **Overwrite the entire backend with the backup state**: - with no "last updated time" or "last synced time", ``insertOrUpdate()`` - all objects from the backup realm into the new realm. There is no way - to recovered unsynced deletions with this approach. This approach - overwrites all data written to the backend by other clients since the - last sync. Recommended for applications where only one user writes - to each realm. - -- **Track changes by field**: - Instead of tracking a "last updated time" for every *object*, track the - "last updated time" for every *field*. Update fields individually using - this logic to avoid overwriting field writes from other clients with - old data. Recommended for applications with many fields per-object - where conflicts must be resolved at the field level. - -- **Track updates separately from objects**: - Instead of tracking a "last updated time" in the schema of each object, - create another model in your schema called ``Updates``. Every time any - field in any object (besides ``Updates``) updates, record the primary - key, field, and time of the update. During a client reset, "re-write" - all of the ``Update`` events that occurred after the "last synced time" - using the latest value of that field in the backup realm. - This approach should replicate all unsynced local changes in the new - realm without overwriting any fields with stale data. However, storing - the collection of updates could become expensive if your application - writes frequently. Recommended for applications where adding "lastUpdated" - fields to object models is undesirable. diff --git a/source/sdk/java/sync/network-connection.txt b/source/sdk/java/sync/network-connection.txt deleted file mode 100644 index 6afa4aa6e9..0000000000 --- a/source/sdk/java/sync/network-connection.txt +++ /dev/null @@ -1,51 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-check-network-connection: - -=============================================== -Check the Current Network Connection - Java SDK -=============================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -To check the current network connection, call :java-sdk:`getConnectionState() ` on your :java-sdk:`SyncSession `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-current-network-connection.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-current-network-connection.java - :language: java - :copyable: false - -.. important:: Connection States vs. Session States - - The SDK manages communication with App Services at two levels: - **connection state** and **session state**. *Connection state* tracks - the state of the network connection between a client device and your - backend App. *Session state* refers to a single user's - synchronization state, which can be :ref:`paused and resumed - ` in the SDK at will. As a - result, you must check *both* states to determine whether - a user's local changes will sync to the backend. Synchronization - only occurs when the connection state is "connected" and the session - state is "active". - -You can also subscribe to connection changes on your ``SyncSession`` -with :java-sdk:`addConnectionChangeListener() -`, -which works similarly to :ref:`upload and download listeners -`. diff --git a/source/sdk/java/sync/partition-based-sync.txt b/source/sdk/java/sync/partition-based-sync.txt deleted file mode 100644 index aaf8b14c8f..0000000000 --- a/source/sdk/java/sync/partition-based-sync.txt +++ /dev/null @@ -1,175 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-partition-based-sync: - -=============================== -Partition-Based Sync - Java SDK -=============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Partition-Based Sync is an older mode for using Atlas Device Sync with the -Realm Java SDK. We recommend using :ref:`Flexible Sync ` -for new apps. The information on this page is for users who are still -using Partition-Based Sync. - -.. tip:: - - Realm Java SDK v10.16.0 and newer supports the ability to migrate from - Partition-Based Sync to Flexible Sync. For more information, refer to: - :ref:`java-migrate-pbs-to-fs`. - -For more information about Partition-Based Sync and how to configure it -in Atlas App Services, refer to :ref:`Partition-Based Sync ` -in the App Services documentation. - -.. _java-partition-based-sync-fundamentals: - -Partition Value ---------------- - -When you select :ref:`Partition-Based Sync ` for your -backend App configuration, your client implementation must include a -partition value. This is the value of the :ref:`partition key -` field you select when you configure Partition-Based Sync. - -The partition value determines which data the client application can access. - -You pass in the partition value when you open a synced realm. - -Open a Synced Realm --------------------- - -To configure settings for a realm, create a -:java-sdk:`SyncConfiguration ` with a -:java-sdk:`SyncConfiguration.Builder `. - -The following example configures a synced realm with: - -- partition-based Sync -- synchronous reads explicitly allowed on the UI thread -- synchronous writes explicitly allowed on the UI thread -- explicit waiting for all backend changes to synchronize to the device - before returning an open realm -- automatic compaction when launching the realm to save file space - -.. warning:: Production Applications Should Handle Client Resets - - Applications used in production environments should handle client - reset errors. To learn more, see :ref:`Reset a Client Realm - `. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/OpenARealmTest.snippet.configure-a-realm.kt - :language: kotlin - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/OpenARealmTest.snippet.configure-a-realm.java - :language: java - -.. include:: /includes/java-synchronous-reads-writes-ui-thread.rst - -.. _java-open-synced-realm: -.. _java-open-a-synced-realm-while-online: - -Open a Synced Realm While Online -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/java-open-synced-realm.rst - -.. _java-open-a-synced-realm-while-offline: - -Open a Synced Realm While Offline -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can open a synced realm when offline with the exact same syntax -that you use to :ref:`open a synced realm while online -`. Not all SDKs follow this -pattern, so cross-platform developers should consult the documentation -for each SDK to learn more. - -.. _java-migrate-pbs-to-fs: - -Migrate from Partition-Based Sync to Flexible Sync --------------------------------------------------- - -You can migrate your App Services Device Sync Mode from Partition-Based Sync -to Flexible Sync. Migrating is an automatic process that does not require -any changes to your application code. Automatic migration requires Realm -Java SDK version 10.16.0 or newer. - -Migrating enables you to keep your existing App Services users and -authentication configuration. Flexible Sync provides more versatile permissions -configuration options and more granular data synchronization. - -For more information about how to migrate your App Services App from -Partition-Based Sync to Flexible Sync, refer to :ref:`Migrate Device Sync Modes -`. - -.. _java-update-client-code-after-pbs-to-fs-migration: - -Updating Client Code After Migration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The automatic migration from Partition-Based Sync to Flexible Sync does not -require any changes to your client code. However, to support this -functionality, Realm automatically handles the differences between the two -Sync Modes by: - -- Automatically creating Flexible Sync subscriptions for each object type - where ``partitionKey == partitionValue``. -- Injecting a ``partitionKey`` field into every object if one does not already - exist. This is required for the automatic Flexible Sync subscription. - -If you need to make updates to your client code after migration, consider -updating your client codebase to remove hidden migration functionality. -You might want update your client codebase when: - -- You add a new model or change a model in your client codebase -- You add or change functionality that involves reading or writing Realm objects -- You want to implement more fine-grained control over what data you sync - -Make these changes to convert your Partition-Based Sync client code to use -Flexible Sync: - -- Update your :java-sdk:`SyncConfiguration.Builder - ` to use - :ref:`Flexible Sync `. This involves - removing the ``partitionValue`` and adding a set of initial subscriptions, - if needed. -- Add relevant properties to your object models to use in your Flexible Sync - subscriptions. For example, you might add an ``ownerId`` property to enable - a user to sync only their own data. -- Remove automatic Flexible Sync subscriptions. If you did not add initial - subscriptions in the ``SyncConfiguration.Builder``, manually create the - relevant subscriptions. - -For examples of Flexible Sync permissions strategies, including examples of -how to model data for these strategies, refer to :ref:`flexible-sync-permissions-guide`. - -Remove and Manually Create Subscriptions -```````````````````````````````````````` - -When you migrate from Partition-Based Sync to Flexible Sync, Realm -automatically creates hidden Flexible Sync subscriptions for your app. The -next time you add or change subscriptions, we recommend that you: - -1. :ref:`Remove the automatically-generated subscriptions `. -2. :ref:`Manually add the relevant subscriptions in your client codebase `. - -This enables you to see all of your subscription logic together in your -codebase for future iteration and debugging. - -For more information about the automatically-generated Flexible Sync -subscriptions, refer to :ref:`realm-sync-migrate-client`. diff --git a/source/sdk/java/sync/pause-resume-sync.txt b/source/sdk/java/sync/pause-resume-sync.txt deleted file mode 100644 index 68c2072d35..0000000000 --- a/source/sdk/java/sync/pause-resume-sync.txt +++ /dev/null @@ -1,60 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-pause-or-resume-a-sync-session: - -========================================= -Pause or Resume a Sync Session - Java SDK -========================================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -To pause a currently active sync session, call -:java-sdk:`stop() ` -on your :java-sdk:`SyncSession `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.pause-sync-session.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.pause-sync-session.java - :language: java - :copyable: false - -To resume a currently paused sync session, call -:java-sdk:`start() ` -on your :java-sdk:`SyncSession `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.resume-sync-session.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.resume-sync-session.java - :language: java - :copyable: false - -When to Pause a Sync Session -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/when-to-pause-sync.rst - \ No newline at end of file diff --git a/source/sdk/java/sync/reset-a-client-realm.txt b/source/sdk/java/sync/reset-a-client-realm.txt deleted file mode 100644 index 3fd175817b..0000000000 --- a/source/sdk/java/sync/reset-a-client-realm.txt +++ /dev/null @@ -1,164 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-client-resets: -.. _java-reset-a-client-realm-file: - -======================= -Client Reset - Java SDK -======================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. seealso:: Learn More About Client Resets - - To learn about the causes of and strategies for handling client - resets, check out the Sync :ref:`Client Resets ` page. - -The SDK reads and writes to a realm file on the device. When -you use Atlas Device Sync, this local realm syncs with the application backend. -Some conditions can cause the realm to be unable to sync with the backend. -When this occurs, you get a **client reset error**. - -This error means you must reset the realm file in the client application. -Clients in this state may continue to run and save data locally. Until you -perform the client reset, the realm does not sync with the backend. - -Choose a **client reset strategy** to handle client reset errors. These -strategies restore realm to a syncable state, but have tradeoffs: - -- :ref:`Discard Unsynced Changes `. Restore - Sync by discarding local changes since the last sync. Maintains change - listeners. -- :ref:`Manually Recover Unsynced Changes - `:. Move the unsyncable realm and - download a new copy. Invalidates change listeners. - -Both options let you write custom logic to recover local changes. Neither -option can recover local changes for you. - -Discard unsynced changes is a less complex alternative to manual recovery. -However, this strategy cannot handle every client reset error. You must -maintain a manual client reset handler as a fallback. - -.. _java-discard-unsynced-changes: - -Discard Unsynced Changes ------------------------- - -.. versionadded:: 10.10.0 - -**Discard unsynced changes** is a client reset strategy provided by the SDK. -This strategy requires minimal code. This strategy performs a reset without -closing the realm or missing notifications. - -It *does* delete all local changes made since the last successful sync. -This includes any data already written to the realm but not yet synced to -the application backend. Do not use this strategy if your application -cannot lose unsynced data. - -Discard unsynced changes cannot handle :ref:`breaking or destructive schema -changes `. When breaking changes occur, -the SDK falls back to manual recovery mode. - -To use this strategy, pass an instance of -:java-sdk:`DiscardUnsyncedChangesStrategy -` to the -:java-sdk:`defaultSyncClientResetStrategy() -` -builder method when you instantiate your ``App``. Your -``DiscardUnsyncedChangesStrategy`` instance must implement the following -methods: - -- ``onBeforeReset()``. The SDK calls this block when it receives a client - reset error from the backend. This occurs before the SDK executes the - client reset strategy. -- ``onAfterReset()``. The SDK calls this block after successfully executing - this strategy. This block provides a frozen copy of the original realm. - It also returns a live instance of the realm in a syncable state. -- ``onError()``. The SDK calls this method during a breaking schema change. - Behaves similarly to - :java-sdk:`defaultClientResetStrategy() - `. - - .. seealso:: - - :ref:`Discard Unsynced Changes after Breaking Schema Changes - `. - -The following example implements this strategy: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-discard-unsynced-changes.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-discard-unsynced-changes.java - :language: java - :copyable: false - -.. _java-discard-unsynced-changes-after-destructive-schema-changes: - -Discard Unsynced Changes after Breaking Schema Changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/destructive-schema-change-app-update.rst - -The discard unsynced changes strategy cannot handle breaking changes. You -must manually handle the client reset in the ``onError()`` method. This -example manually discards unsynced changes to handle the client reset: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-discard-unsynced-changes-with-simple-manual-fallback.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ClientResetTest.snippet.client-reset-discard-unsynced-changes-with-simple-manual-fallback.java - :language: java - :copyable: false - -.. _java-manually-recover-unsynced-changes: - -Manually Recover Unsynced Changes ---------------------------------- - -.. tip:: - - Manual recovery replaces the deprecated - ``SyncSession.ClientResetHandler``. - Clients using the deprecated handler can update to manual recovery - with no logic changes. - -We do not recommend manual client reset recovery. It requires: - -- Substantial amounts of code -- Schema concessions -- Complex conflict resolution logic. - -To learn more, see the :ref:`Advanced Guide to Manual Client Reset Data Recovery -`. - -.. _java-test-client-reset-handling: - -Test Client Reset Handling --------------------------- - -.. include:: /includes/test-client-reset.rst diff --git a/source/sdk/java/sync/sync-progress.txt b/source/sdk/java/sync/sync-progress.txt deleted file mode 100644 index 1bbfcb158b..0000000000 --- a/source/sdk/java/sync/sync-progress.txt +++ /dev/null @@ -1,66 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-check-sync-progress: - -============================================================== -Check Upload & Download Progress for a Sync Session - Java SDK -============================================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. include:: /includes/flex-sync-unsupported-progress-notifications.rst - -To subscribe to progress updates for uploads, -call :java-sdk:`addUploadProgressListener() -` -on your :java-sdk:`SyncSession ` -with a :java-sdk:`ProgressMode ` -and a :java-sdk:`ProgressListener() `. -The ``ProgressMode`` passed determines which upload events your listener -receives: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-upload-progress.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-upload-progress.java - :language: java - :copyable: false - -To subscribe to progress updates for downloads, -call :java-sdk:`addDownloadProgressListener() -` -on your :java-sdk:`SyncSession ` -with a :java-sdk:`ProgressMode ` -and a :java-sdk:`ProgressListener() `. -The ``ProgressMode`` passed determines which download events your listener -receives: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-download-progress.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.check-download-progress.java - :language: java - :copyable: false diff --git a/source/sdk/java/telemetry.txt b/source/sdk/java/telemetry.txt deleted file mode 100644 index b6b9c385ec..0000000000 --- a/source/sdk/java/telemetry.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _telemetry-java: - -==================== -Telemetry - Java SDK -==================== - -.. include:: /includes/sdk-telemetry.rst diff --git a/source/sdk/java/test-and-debug.txt b/source/sdk/java/test-and-debug.txt deleted file mode 100644 index e87185b344..0000000000 --- a/source/sdk/java/test-and-debug.txt +++ /dev/null @@ -1,21 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-test-and-debug: - -========================== -Troubleshooting - Java SDK -========================== - -.. toctree:: - :titlesonly: - - Log Realm Events - Debugging - Testing - Troubleshooting - -- :doc:`Log Realm Events ` -- :doc:`Debugging ` -- :doc:`Testing ` -- :doc:`Troubleshooting ` diff --git a/source/sdk/java/test-and-debug/debugging.txt b/source/sdk/java/test-and-debug/debugging.txt deleted file mode 100644 index db3eb67dd5..0000000000 --- a/source/sdk/java/test-and-debug/debugging.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-debugging: - -==================== -Debugging - Java SDK -==================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Android Studio Debugging ------------------------- - -.. important:: - - The Android Studio debugger can provide misleading values for - Realm object fields. For correct values, you can watch - accessor values instead, or use the Realm object - ``toString()`` method to see the latest field values. - -This section details information you should keep in mind when debugging -Realm applications with Android Studio to avoid incorrect -value reporting. When you watch a Realm object, -you'll see values displayed in the object's fields. These values -are incorrect because the field values themselves are not used. This is -because Realm creates a :ref:`proxy object -` behind the scenes, overriding -the getters and setters to access the persisted data in the -realm. To see the correct values, add a watch on the accessors. -See the image below: - -.. figure:: /images/android-studio-debugging.png - :alt: When using the Android Studio debugger, accessors display the correct field value, while fields show outdated information. - -In the image above, the debugger has stopped on line ``113``. There are -three watch values: - -- The ``person`` variable -- The ``person.getName()`` accessor -- The ``person.getAge()`` accessor - -The code from lines ``107`` to ``111`` alters the ``person`` instance by -changing the name and age in a write transaction. On line ``113``, the ``person`` watch instance reports -incorrect values for the *field* watch values. The watch values that use -the *accessors* report values that are correct. - -NDK Debugging -------------- - -The Realm Java SDK library contains native code. -Debugging NDK crashes can be cumbersome, as the default stack trace -provides minimal information. - -We recommend you use a crash reporting tool such as -`Crashlytics `__. This gives you the -ability to track native errors and gather other valuable information. We -can help with your issues faster if you have this information. - -To enable NDK crash reporting in Crashlytics for -your project, add the following to the root of your application -``build.gradle`` file: - -.. code-block:: groovy - :copyable: false - - crashlytics { - enableNdk true - } - -.. note:: - - The values ``androidNdkOut`` and ``androidNdkLibsOut`` are not needed. diff --git a/source/sdk/java/test-and-debug/log-realm-events.txt b/source/sdk/java/test-and-debug/log-realm-events.txt deleted file mode 100644 index 19a43a60cd..0000000000 --- a/source/sdk/java/test-and-debug/log-realm-events.txt +++ /dev/null @@ -1,46 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-log-realm-events: - -=========================== -Log Realm Events - Java SDK -=========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -The SDK logs events to the Android system log automatically. You can -view these events using :android:`Logcat `. - -.. _java-set-the-client-log-level: - -Set the Client Log Level ------------------------- - -Realm uses the log levels defined by `Log4J -`_. -To configure the log level for Realm logs in your application, pass a -:java-sdk:`LogLevel ` to -:java-sdk:`RealmLog.setLevel() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.set-client-log-level.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/SyncDataTest.snippet.set-client-log-level.java - :language: java - :copyable: false - -.. include:: /includes/tip-sync-log-levels.rst diff --git a/source/sdk/java/test-and-debug/testing.txt b/source/sdk/java/test-and-debug/testing.txt deleted file mode 100644 index a9e63b732a..0000000000 --- a/source/sdk/java/test-and-debug/testing.txt +++ /dev/null @@ -1,401 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-testing: - -================== -Testing - Java SDK -================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -You can test your application using unit tests or integration tests. -**Unit tests** only assess the logic written in your application's code. -**Integration tests** assess your application logic, database queries and -writes, and calls to your application's backend, if you have one. Unit tests -run on your development machine using the JVM, while integration tests -run on a physical or emulated Android device. You can run integration -tests by communicating with actual instances of Realm -or an App backend using Android's built-in instrumented tests. - -Android uses specific file paths and folder names in Android projects -for unit tests and instrumented tests: - -.. list-table:: - :header-rows: 1 - :widths: 50 50 - - * - Test Type - - Path - - * - Unit Tests - - :file:`/app/src/test` - - * - Instrumented Tests - - :file:`/app/src/androidTest` - -Because the SDK uses C++ code via Android Native for data -storage, unit testing requires you to entirely mock interactions with -Realm. Prefer integration tests for logic that requires -extensive interaction with the database. - -Integration Tests ------------------ - -This section shows how to integration test an application that uses -the Realm SDK. It covers the following concepts in the test -environment: - -- acquiring an application context -- executing logic on a ``Looper`` thread -- how to delay test execution while asynchronous method calls complete - -Applications that use Sync or a backend App also require (not -covered here): - -- a separate App backend for testing, with separate user accounts - and data -- a separate Atlas cluster containing test-only data - -.. _java-testing-context: - -Application Context -~~~~~~~~~~~~~~~~~~~ - -To initialize the SDK, you'll need to provide an application or activity -:android:`context `. -This isn't available by default in Android integration tests. However, -you can use Android's built-in testing :android:`ActivityScenario -` -class to start an activity in your tests. You can use any activity from -your application, or you can create an empty activity just for testing. -Call ``ActivityScenario.launch()`` with your activity class as a -parameter to start the simulated activity. - -Next, use the ``ActivityScenario.onActivity()`` method to run a lambda -on the simulated activity's main thread. In this lambda, you should call -the ``Realm.init()`` function to initialize the SDK with your activity -as a parameter. Additionally, you should save the parameter passed to -your lambda (the newly created instance of your activity) for future -use. - -Because the ``onActivity()`` method runs on a different thread, you -should :ref:`block your test from executing further -` until this initial setup completes. - -The following example uses an ``ActivityScenario``, an empty testing -activity, and a ``CountDownLatch`` to demonstrate how to set up an -environment where you can test your Realm application: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.initialize-realm-with-context.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.initialize-realm-with-context.java - :language: java - :copyable: false - -Looper Thread -~~~~~~~~~~~~~ - -Realm functionality such as -:ref:`Live objects ` and change notifications only -work on :android:`Looper ` threads. -Threads configured with a ``Looper`` object pass events over a message -loop coordinated by the ``Looper``. Test functions normally don't have -a ``Looper`` object, and configuring one to work in your tests can be -very error-prone. - -Instead, you can use the :android:`Activity.runOnUiThread() -` -method of your test activity to execute logic on a thread that already -has a ``Looper`` configured. Combine ``Activity.runOnUiThread()`` with -a ``CountDownLatch`` as described in the :ref:`delay section -` to prevent your test from completing -and exiting before your logic has executed. Within the ``runOnUiThread()`` -call, you can interact with the SDK just like you normally would in your -application code: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.test-logic-looper.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.test-logic-looper.java - :language: java - :copyable: false - -.. _java-testing-delay-while-async: - -Delay Test Execution While Async Calls Complete -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Because the SDK uses asynchronous calls for common operations such as -database queries, authentication, and function calls, tests need a way -to wait for those async calls to complete. Otherwise, your tests will -exit before your asynchronous (or multi-threaded) calls run. This example -uses Java's built-in `CountDownLatch -`__. Follow these steps to use a ``CountDownLatch`` in your own tests: - -1. Instantiate a ``CountDownLatch`` with a count of 1. -#. After running the async logic your test needs to wait for, call that - ``CountDownLatch`` instance's ``countDown()`` method. -#. When you need to wait for async logic, add a ``try``/``catch`` block - that handles an ``InterruptedException``. In that block, - call that ``CountDownLatch`` instance's ``await()`` method. -#. Pass a timeout interval and unit to ``await()``, and wrap - the call in a ``Assert.assertTrue()`` assertion. If the logic takes - too long, the ``await()`` call times out, returning false and failing - the test. - -The following example demonstrates the use of a ``CountDownLatch`` to -wait for authentication and opening a realm asynchronously on a separate -thread: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.wait-for-async.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.wait-for-async.java - :language: java - :copyable: false - -Testing Backend -~~~~~~~~~~~~~~~ - -Applications that use an App backend should not connect to the -production backend for testing purposes for the following reasons: - -- you should always keep test users and production users separate - for security and privacy reasons -- tests often require a clean initial state, so there's a good chance - your tests will include a setup or teardown method that deletes all - users or large chunks of data - -You can use :ref:`environments ` to manage separate -apps for testing and production. - -Testing Atlas Cluster -~~~~~~~~~~~~~~~~~~~~~ - -Applications that use Sync or :ref:`MongoDB queries -` may read, write, update, or delete data -stored in connected Atlas clusters. For security purposes, you shouldn't -store production data and testing data on the same cluster. Additionally, -tests may require schema changes before those changes are gracefully -handled in your production application. As a result, you should use a -separate Atlas cluster when testing your application. - -Full Example -~~~~~~~~~~~~ - -The following example shows a full Junit instrumented ``androidTest`` -example running Realm in integration tests: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.test-integration-testing.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/TestTest.snippet.test-integration-testing.java - :language: java - :copyable: false - -.. seealso:: - - See the :github:`Realm Documentation Examples App - ` for an example - of integration testing the SDK locally and with a live backend. - -Unit Tests ----------- - -To unit test Realm applications that use Realm, -you must :wikipedia:`mock ` Realm (and your -application backend, if you use one). Use the following libraries to -mock SDK functionality: - -- `Robolectric `__ -- `PowerMock `__ -- `Mockito `__ - -To make these libraries available for unit testing in your Android project, -add the following to the ``dependencies`` block of your application -``build.gradle`` file: - -.. code-block:: - :copyable: false - - testImplementation "org.robolectric:robolectric:4.1" - testImplementation "org.mockito:mockito-core:3.3.3" - testImplementation "org.powermock:powermock-module-junit4:2.0.9" - testImplementation "org.powermock:powermock-module-junit4-rule:2.0.9" - testImplementation "org.powermock:powermock-api-mockito2:2.0.9" - testImplementation "org.powermock:powermock-classloading-xstream:2.0.9" - -.. note:: Version Compatibility - - Mocking the SDK in unit tests requires Robolectric, Mockito, and - Powermock because the SDK uses Android Native C++ method calls to - interact with Realm. Because the frameworks required to - override these method calls can be delicate, you should use the - versions listed above to ensure that your mocking is successful. Some - recent version updates (particularly Robolectric version 4.2+) can - break compiliation of unit tests using the SDK. - -To configure your unit tests to use Robolectric, PowerMock, and Mockito -with the SDK, add the following annotations to each unit test class that -mocks the SDK: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.annotations.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.annotations.java - :language: java - :copyable: false - -Then, bootstrap Powermock globally in the test class: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.bootstrap-powermock.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.bootstrap-powermock.java - :language: java - :copyable: false - -Next, mock the components of the SDK that might query native C++ code -so we don't hit the limitations of the test environment: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.mock-realm-components.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.mock-realm-components.java - :language: java - :copyable: false - -Once you've completed the setup required for mocking, you can start -mocking components and wiring up behavior for your tests. You can also -configure PowerMockito to return specific objects when new objects of -a type are instantiated, so even code that references the default -realm in your application won't break your tests: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.mock-a-realm.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.mock-a-realm.java - :language: java - :copyable: false - -After mocking a realm, you'll have to configure data for your test -cases. See the full example below for some examples of how you can -provide testing data in unit tests. - -Full Example -~~~~~~~~~~~~ - -The following example shows a full JUnit ``test`` -example mocking Realm in unit tests. This example tests -an activity that performs some basic Realm operations. -The tests use mocking to simulate those operations when that activity is -started during a unit test: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/local/UnitTestActivity.snippet.unit-test-activity.kt - :language: kotlin - :copyable: false - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.test-unit-testing.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/local/UnitTestActivity.snippet.unit-test-activity.java - :language: java - :copyable: false - - .. literalinclude:: /examples/generated/java/local/TestTest.snippet.test-unit-testing.java - :language: java - :copyable: false - -.. seealso:: - - See the :github:`Unit Testing Example App - ` - for an example of unit testing an application that uses - Realm. diff --git a/source/sdk/java/test-and-debug/troubleshooting.txt b/source/sdk/java/test-and-debug/troubleshooting.txt deleted file mode 100644 index f84a938044..0000000000 --- a/source/sdk/java/test-and-debug/troubleshooting.txt +++ /dev/null @@ -1,242 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-troubleshooting: - -========================== -Troubleshooting - Java SDK -========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Couldn't load "librealm-jni.so" -------------------------------- - -If your app uses native libraries that don't ship with support for -64-bit architectures, Android will fail to load Realm's -``librealm-jni.so`` file on ARM64 devices. This happens because Android -cannot load 32-bit and 64-bit native libraries concurrently. Ideally, -all libraries could provide the same set of supported ABIs, but -sometimes that may not be doable when using a 3rd-party library. - -To work around this issue, you can exclude Realm's ARM64 library from -the APK file by adding the following code to the application's -``build.gradle``. You can refer to Mixing 32- and 64-bit Dependencies in Android for more information. - -.. code-block:: gradle - :copyable: false - - android { - //... - packagingOptions { - exclude "lib/arm64-v8a/librealm-jni.so" - } - //... - } - -.. seealso:: - - For more information, see `Mixing 32- and 64-bit Dependencies in Android - `__. - -Network Calls to Mixpanel -------------------------- - -Realm collects anonymous analytics when you run the -Realm bytecode transformer on your source code. This is -completely anonymous and helps us improve the product by flagging: - -- which version of the SDK you use -- which operating system you use -- if your application uses Kotlin -- if your application uses local-only Realm or Sync - -Analytics do not run when your application runs on user devices - only -when you compile your source code. To opt out of analytics, you can set -the ``REALM_DISABLE_ANALYTICS`` environment variable to ``true``. - -.. _java-client-notifications-android-12: - -Change Listeners in Android 12 with SDK Versions Below 10.5.1 -------------------------------------------------------------- - -Due to a change in the Linux kernel, -:ref:`object, collection, and realm notifications -` do not work in SDK versions below -10.5.1 on devices running certain early versions of -Android 12. - -This change effects Linux kernel versions beginning with ``5.5``. -Linux kernel version ``5.14-rc4`` fixed the issue. The fix was -also backported to ``LTS 5.10.56`` and ``LTS 5.13.8``. All mainline -and LTS Android 12 branches contain the fix or a backport of it. - -If you experience this issue, you can restore notification functionality -with the following fixes: - -- upgrade to a version of the SDK later than 10.5.1. -- upgrade to a version of Android 12 that uses a Linux kernel release - that contains the fix (kernel commit ``3a34b13a88caeb2800ab44a4918f230041b37dd9``) - or the backport of the fix (kernel commit ``4b20d2de0b367bca627b49efd8d2e9e01bb66753``). - -Configurations Cannot be Different if Used to Open the Same File ----------------------------------------------------------------- - -Realm runs checks whenever you open a realm file to -avoid corruption. In order to avoid accidentally opening a realm -file with incompatible settings, the SDK uses Java's ``equals()`` method -to compare ``RealmConfiguration`` objects. This prevents the SDK from -opening a single realm file with different schemas, durability levels, -or writability settings. However, configurations that include lambda -functions, such as those passed to -:java-sdk:`initialData() ` -and -:java-sdk:`compactOnLaunch() `, -can break this ``equals()`` comparison, since two different lambdas are -never considered equal using Java's built-in comparison. -To avoid this error when using lambdas, you can either: - -1. Store a single configuration statically in your application, so that - separate realm instances use the exact same - ``RealmConfiguration`` object and it passes the check. - -#. Override the default equals check of the ``RealmConfiguration``: - - .. code-block:: kotlin - :copyable: false - - val config = RealmConfiguration.Builder() - .initialData(object: Realm.Transaction { - override fun execute(realm: Realm) { - TODO("Not yet implemented") - } - - override fun equals(other: Any?): Boolean { - return true - } - - override fun hashCode(): Int { - return 37 - } - }).build() - -Kapt Exceptions During Builds ------------------------------ - -If you experience an exception in the Kapt library with a description -like the following: - -.. code-block:: - - A failure occurred while executing org.jetbrains.kotlin.gradle.internal.KaptWithoutKotlincTask$KaptExecutionWorkAction - -This most likely means there is an issue with one of your model classes. -Possible causes include: - -- introducing a field type that is not :ref:`supported ` by the SDK -- using a visibility type other than ``open`` or ``public`` for a realm object model class -- using a Realm annotation on an incompatible field - -If you experience this error, check any recent updates to your schema for -problems. - -Installation Size ------------------ - -Once your app is built for release and split for distribution, the SDK -should only add about 800KB to your APK in most cases. The releases are -significantly larger because they include support for more architectures, -such as ARM7, ARMv7, ARM64, x86, and MIPS. The APK file contains all -supported architectures, but the Android installer only installs native -code for the device's architecture. This means that the installed app -is smaller than the size of the APK file. - -You can reduce the size of the Android APK itself by splitting the APK -into a version for each architecture. Use the Android Build Tool ABI -Split support by adding the following to your :file:`build.gradle`: - -.. code-block:: gradle - - android { - splits { - abi { - enable true - reset() - include 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64' - } - } - } - -Select the architectures that you'd like to include to build a separate -APK for each. - -.. seealso:: - - See the :android:`Android Tools documentation about ABI Splits - ` - for more information, or the :github:`example on GitHub - `. - -If you don't want to handle multiple APKs, you can restrict the number -of architectures supported in a single APK. This is done by adding -``abiFilters`` to your :file:`build.gradle`: - -.. code-block:: gradle - - android { - defaultConfig { - ndk { - abiFilters 'armeabi-v7a', 'arm64-v8a', 'mips', 'x86', 'x86_64' - } - } - } - -.. seealso:: - - `Controlling APK Size When Using Native Libraries - `__. - -Customize Dependecies Defined by the Realm Gradle Plugin --------------------------------------------------------- - -Realm uses a Gradle plugin because it makes it easier to set -up a large number of dependencies. Unfortunately this also makes it a -bit harder to ignore specific transitive dependencies. - -If you want to customize Realm beyond what is exposed by the -plugin, you can manually set up all the dependencies and ignore the -Gradle plugin. The following example demonstrates how to set up the SDK -for an Android application using Kotlin manually: - -.. code-block:: gradle - - buildscript { - ext.kotlin_version = '1.5.21' - ext.realm_version = '{+java-sdk-version+}' - repositories { - jcenter() - mavenCentral() - } - dependencies { - classpath "io.realm:realm-transformer:$realm_version" - classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" - } - } - - apply plugin: 'com.android.application' - apply plugin: 'kotlin-android' - apply plugin: 'kotlin-kapt' - - import io.realm.transformer.RealmTransformer - android.registerTransform(new RealmTransformer(project)) - - dependencies { - api "io.realm:realm-annotations:$realm_version" - api "io.realm:realm-android-library:$realm_version" - api "io.realm:realm-android-kotlin-extensions:$realm_version" - kapt "io.realm:realm-annotations-processor:$realm_version" - } diff --git a/source/sdk/java/troubleshooting.txt b/source/sdk/java/troubleshooting.txt deleted file mode 100644 index 80309719b9..0000000000 --- a/source/sdk/java/troubleshooting.txt +++ /dev/null @@ -1,21 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-troubleshooting: - -========================== -Troubleshooting - Java SDK -========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java_custom_android_roms: - -Use in System Apps on Custom Android ROMs ------------------------------------------ - -.. include:: /includes/custom-android-roms.rst diff --git a/source/sdk/java/users/authenticate-users.txt b/source/sdk/java/users/authenticate-users.txt deleted file mode 100644 index 1371d1ce92..0000000000 --- a/source/sdk/java/users/authenticate-users.txt +++ /dev/null @@ -1,481 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-authenticate-users: -.. _java-authenticate: - -============================= -Authenticate Users - Java SDK -============================= - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Realm provides an API for authenticating users using any enabled -authentication provider. Instantiate a ``Credentials`` object and pass -it to either of the ``app.login()`` or ``app.loginAsync()`` methods to -authenticate a user login and create a ``User`` object. Each -authentication provider corresponds to a static helper method used to -instantiate ``Credentials`` objects using that authentication provider. - -.. _java-login: - -Log In ------- - -You can authenticate users with either the ``app.login()`` or -``app.loginAsync()`` methods of your application's instance of the -``io.realm.mongodb.App`` class. While the ``app.login()`` method blocks -code execution in the calling thread until the supplied credentials have -either succeeded or failed to authenticate a user, the -``app.loginAsync()`` method allows execution to continue, handling -success or failure with a callback function that is guaranteed to -execute on the same thread that called ``app.loginAsync()``. - -If successful, the ``app.login()`` method returns a ``User`` object. -In the event of a failure, the ``app.login()`` method throws an -exception of type ``ObjectServerError``. - -Pass a callback to the ``app.loginAsync()`` method to handle success or -failure. This callback accepts a single parameter of type -``App.Result``. The ``isSuccess()`` method of the ``App.Result`` object -passed to the callback returns a boolean that indicates whether the -operation succeeded. In the event of a failure, you can view the -error that caused the failure using the ``getError()`` method. - -.. _java-anonymous-login: -.. _java-login-anonymous: - -Anonymous User -~~~~~~~~~~~~~~ - -The :ref:`anonymous authentication provider ` -enables users to log in to your application with short-term accounts -that store no persistent personal information. To log in with anonymous -authentication, create an anonymous credential by calling -``Credentials.anonymous()`` and then pass the generated credential to -``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.anonymous.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.anonymous.kt - :language: kotlin - :copyable: false - -.. _java-email-password-login: -.. _java-login-email-password: - -Email/Password User -~~~~~~~~~~~~~~~~~~~ - -The :ref:`Email/Password authentication provider ` -enables users to log in to your application with an email username and -a password. To log in with email/password authentication, create an -email/password credential by calling ``Credentials.emailPassword()`` -with the user's email and password. Then pass the generated credential -to ``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.email-password.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.email-password.kt - :language: kotlin - :copyable: false - -.. _java-api-key-login: -.. _java-login-api-key: - -API Key User -~~~~~~~~~~~~ - -The :ref:`API Key authentication provider ` -enables users to log in to your application with an API Key generated -automatically in the client SDK. To log in with API Key authentication, create an -API Key credential by calling ``Credentials.apiKey()`` -with an API Key. Then pass the generated credential -to ``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.api-key.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.api-key.kt - :language: kotlin - :copyable: false - -.. _java-custom-jwt-login: -.. _java-login-custom-jwt: - -Custom JWT User -~~~~~~~~~~~~~~~ - -The :ref:`Custom JWT authentication provider ` -enables users to log in to your application with a custom JSON Web Token. -To log in with custom JWT authentication, create a -custom JWT credential by calling ``Credentials.jwt()`` -with your custom JWT. Then pass the generated credential -to ``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.custom-jwt.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.custom-jwt.kt - :language: kotlin - :copyable: false - -.. _java-custom-function-login: -.. _java-login-custom-function: - -Custom Function User -~~~~~~~~~~~~~~~~~~~~ - -The :ref:`Custom Function authentication provider ` -enables users to log in to your application using a -:ref:`Realm Function ` defined in your App. To log in with custom -function authentication, create a credential by calling -``Credentials.customFunction()``. The :java-sdk:`customFunction() -` method expects a -Document that contains the properties and values used by the Realm auth function. -For example, suppose the backend function expects the input parameter to include -a field named ``username``, like this: - -.. code-block:: js - :copyable: false - - exports = async function(loginPayload) { - const { username } = loginPayload; - ... - } - -The document you pass to ``Credentials.customFunction()`` might look like this: - -.. code-block:: java - :copyable: false - - Document("username", "bob") - -You then pass the generated credential to ``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.custom-function.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.custom-function.kt - :language: kotlin - :copyable: false - -.. _java-facebook-login: -.. _java-login-facebook: - -Facebook User -~~~~~~~~~~~~~ - -The :ref:`Facebook ` authentication provider allows -you to authenticate users through a Facebook app using their existing Facebook -account. - -.. include:: /includes/note-enable-facebook-auth.rst - -.. include:: /includes/note-facebook-profile-picture-url.rst - -Follow the official :facebook:`Facebook Login for Android Quickstart -` to set up the authentication flow for your -application. In the login completion handler, get the logged in user's access -token from the Facebook :facebook:`LoginResult -`. Use the access token to -create a Realm Facebook credential and then log the user into your -Realm app. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.facebook.java - :language: java - :emphasize-lines: 10-17 - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.facebook.kt - :language: kotlin - :emphasize-lines: 10-21 - :copyable: false - -.. _java-google-login: -.. _java-login-google: - -Google User -~~~~~~~~~~~ - -.. important:: - - To log a user in with their existing Google account, you must configure and - enable the :ref:`Google authentication provider ` for - your application. - -To set up your application for Google User authentication: - -1. In the `Google Cloud Platform console - `__, create an - OAuth 2.0 client ID of type "Web application". - -#. Configure your backend App to use that client ID and the associated - client secret. - -#. Enable OpenID Connect on the backend. - -Use Google's official :google:`Sign-In for Android ` to authenticate Google -users in your Android application: - -.. note:: Code Example Below - - For an implementation of these instructions, check out the code block - below. - -1. Add the Google Sign-In for Android dependency to the ``dependencies`` - block of your application level ``build.gradle``: - - .. code-block:: groovy - :copyable: false - - com.google.android.gms:play-services-auth:19.2.0 - -#. Create a :google:`GoogleSignInOptions - ` - with the following builder options: - - - :google:`default sign in - ` - - an :google:`ID token request - ` - -- pass your OAuth 2.0 client ID as the ``serverClientId``. - -#. Use the ``GoogleSignInOptions`` to create a ``GoogleSignInClient`` - with :google:`GoogleSignIn.getClient() - ` - -#. Use the ``GoogleSignInClient`` to create an ``Intent`` capable of - triggering Google Sign-In. - -#. Use :android:`registerForActivityResult() - ` - to configure a callback. Your callback should use :google:`GoogleSignIn.getSignedInAccountFromIntent() - ` - to access the result of Google Sign-In: a ``Task``. - -#. Use the :android:`launch() - ` - method of the :android:`ActivityResultLauncher - ` - returned in the previous step to start Google Sign-In. Pass the - ``launch()`` method your Google Sign-In ``Intent``. - -#. Use ``isSuccessful()`` to handle Google Sign-In errors. - -#. Access the result of the task (a :google:`GoogleSignInAccount - `) - with ``getResult()``. - -#. Access the ID token for the ``GoogleSignInAccount`` with ``getIdToken()``. - -#. Create a Realm ``Credentials`` object with :java-sdk:`Credentials.google() - `. - Pass the ID token as the first parameter, and :java-sdk:`GoogleAuthType.ID_TOKEN - ` as the second parameter. - -#. Use the :java-sdk:`app.loginAsync() - ` - or :java-sdk:`app.login() ` - methods to authenticate with the Atlas App Services backend using the token. - -The following code implements this flow, starting with a method call to -``loginWithGoogle()``: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthActivity.snippet.google.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthActivity.snippet.google.kt - :language: kotlin - :copyable: false - -.. seealso:: - - To learn more about Google Sign-In for Android, check out the - official :google:`Google Sign-In for Android Integration Guide - `. - -.. _java-apple-login: -.. _java-login-apple: - -Apple User -~~~~~~~~~~ - -The :ref:`Sign-in with Apple authentication provider ` -enables users to log in to your application with a custom token provided -by Apple. To log in with Sign-in with Apple authentication, create a -Sign-in with Apple credential by calling ``Credentials.apple()`` -with the token provided by Apple. Then pass the generated credential -to ``app.login()`` or ``app.loginAsync()``. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.apple.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.apple.kt - :language: kotlin - :copyable: false - -.. include:: /includes/authorization-appleidcredential-string.rst - -Offline Login -------------- - -App Services manages sessions with access tokens and refresh tokens. Client -SDKs supply the logic to manage tokens, and provide them with requests. - -The SDK stores these tokens in -`Shared Preferences `_. - -.. seealso:: - - :ref:`` - -.. include:: /includes/offline-login.rst - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.offline.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.offline.kt - :language: kotlin - :copyable: false - -.. _java-get-user-access-token: - -Get a User Access Token ------------------------ - -.. include:: /includes/user-access-token.rst - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.get-valid-access-token.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.get-valid-access-token.kt - :language: kotlin - :copyable: false - -.. _java-logout: - -Log a User Out --------------- - -You can log out any user, regardless of the authentication provider used -to log in, using the ``user.logOut()`` or ``user.logOutAsync()`` -methods. Both methods: - -- delete locally stored user credentials from the device - -- immediately halt any synchronization to and from the user's realms - -Because logging out halts synchronization, you should only log out after -all local Realm updates have uploaded to the server. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.log-out.java - :language: java - :copyable: false - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AuthenticationTest.snippet.log-out.kt - :language: kotlin - :copyable: false diff --git a/source/sdk/java/users/create-delete-users.txt b/source/sdk/java/users/create-delete-users.txt deleted file mode 100644 index 8a459f1549..0000000000 --- a/source/sdk/java/users/create-delete-users.txt +++ /dev/null @@ -1,53 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-create-and-delete-users: - -================================== -Create and Delete Users - Java SDK -================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. _java-create-user: - -Create a User -------------- - -For most :ref:`authentication methods `, Realm -automatically creates a :ref:`user account ` the first time -a user authenticates. The only exception is email/password authentication. -When you use email/password authentication, you must :ref:`register -` and :ref:`confirm -` a user before the user can -authenticate to a Realm application. - -.. _java-delete-user: - -Delete a User -------------- - -The Java SDK does not have the ability to delete users through the SDK. -You can delete users from the server using the :ref:`App Services -Admin API ` ``delete a user`` endpoints. You could optionally -create an :ref:`Atlas Function ` that uses the Admin API to -delete a user, and :ref:`call the function from the SDK `. - -To use your app in the future, the user must sign up for a new account. -They can use the same credentials (depending on the authentication provider), -but will not have the same User ID as their deleted account. - -.. important:: Deleting All User Data - - Deleting a user only deletes the :ref:`user object `, - which may contain associated metadata from the associated auth provider. - This does not delete :ref:`custom user data ` - or other user data that your app stores in a linked collection or external services. - - Use the :ref:`Authentication Trigger DELETE event ` - to programmatically clean up other data when you delete a user. For example, - you can delete the user's data from your custom user data collection or another service. diff --git a/source/sdk/java/users/custom-user-data.txt b/source/sdk/java/users/custom-user-data.txt deleted file mode 100644 index 50c4f91a29..0000000000 --- a/source/sdk/java/users/custom-user-data.txt +++ /dev/null @@ -1,168 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-custom-user-data: - -=========================== -Custom User Data - Java SDK -=========================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -You can read arbitrary data about your application users, known as -custom user data, directly within your java application. For example, -you might store a user's preferred language, date of birth, or local -timezone. To learn more about custom user data, see :ref:`Enable Custom -User Data `. - -.. include:: /includes/use-custom-data-note.rst - -.. _java-read-a-users-custom-data: -.. _java-access-custom-user-data: - -Read a User's Custom Data -------------------------- - -You can read the custom user data of a currently logged in user -through that user's ``User`` object. You cannot edit custom user data -through a ``User`` object. To edit custom user data, see -:ref:`Update Custom User Data `. -To access the data, call the -:java-sdk:`User.customData() ` -method on the ``User`` object of a logged in user: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.read-custom-user-data.kt - :language: kotlin - :emphasize-lines: 6 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.read-custom-user-data.java - :language: java - :emphasize-lines: 6 - :copyable: false - -.. warning:: Custom Data May Be Stale - - Atlas App Services does not dynamically update the value of - :java-sdk:`User.customData() ` - immediately when underlying data changes. Instead, App Services - fetches the most recent version of custom user data whenever a user - refreshes their :ref:`access token `, which occurs - during most SDK operations that contact the App Services back end. - Realm refreshes access tokens every 30 minutes, so custom - user data can be stale for no more than 30 minutes. - - If you require the most recent version of custom user data, use the - :java-sdk:`User.refreshCustomData() - ` method to request - the latest version of a user's custom data. - -.. _java-create-a-users-custom-data-document: -.. _java-create-custom-user-data: - -Create a User's Custom Data Document ------------------------------------- - -.. tip:: - - To create, update, or delete custom user data, you will need the following - information from your custom user data configuration: - - - the custom user data cluster - - - the custom user data database - - - the custom user data collection in which custom - user data documents are stored - - - the user ID field used to map custom user data documents - to users (via user ID) - - You can find this information in the App Services UI on the - :guilabel:`App Users` page under the :guilabel:`Custom User Data` tab. - -To create custom user data for a user, create a MongoDB document in the -custom user data collection. The user ID field of the document should -contain the the user's user ID. The following example uses -:ref:`MongoDB Data Access ` to insert a -document containing the user ID of the currently logged in user and a -``favoriteColor`` value into the custom user data collection: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.create-custom-user-data.kt - :language: kotlin - :emphasize-lines: 11 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.create-custom-user-data.java - :language: java - :emphasize-lines: 11,12 - :copyable: false - - -You can add any number of arbitrary fields and values to the custom user -data document when you create it. The user ID field is the only -requirement for the document to become available on the ``User`` object -as custom user data. - -.. _java-update-a-users-custom-data: -.. _java-update-custom-user-data: - -Update a User's Custom Data ---------------------------- - -You can update custom user data using :ref:`MongoDB Data Access -`, Realm :ref:`Sync -`, :compass:`MongoDB Compass `, -or the :atlas:`MongoDB Atlas Data -Explorer `. - -To update a user's custom user data with MongoDB Data Access, edit the -MongoDB document whose user ID field contains the user ID of the user. - -.. tip:: - - To determine a user's ID, access the ``User.id`` property or find the user in the App Services UI - on the :guilabel:`App Users` page under the :guilabel:`Users` tab. - -The following example uses :ref:`MongoDB Data Access -` to update the ``favoriteColor`` field of -the the document containing the user ID of the currently logged in user -in the custom user data collection: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.update-custom-user-data.kt - :language: kotlin - :emphasize-lines: 11 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/AccessCustomUserDataTest.snippet.update-custom-user-data.java - :language: java - :emphasize-lines: 11,12 - :copyable: false diff --git a/source/sdk/java/users/email-password-users.txt b/source/sdk/java/users/email-password-users.txt deleted file mode 100644 index 40520803a7..0000000000 --- a/source/sdk/java/users/email-password-users.txt +++ /dev/null @@ -1,193 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-manage-email-password-users: - -====================================== -Manage Email/Password Users - Java SDK -====================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -When you have enabled the :ref:`email/password provider -` in your App, you can register a new -account, confirm an email address, and reset a user's password from -client code. - -.. _java-register-a-new-user-account: - -Register a New User Account ---------------------------- - -To register a new user, pass a user-provided email and password to the -:java-sdk:`registerUser() ` -or :java-sdk:`registerUserAsync() -` -methods of your Realm ``App``'s :java-sdk:`EmailPasswordAuth ` -instance: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.register-a-new-user-account.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.register-a-new-user-account.java - :language: java - :copyable: false - -.. _java-confirm-a-new-users-email-address: - -Confirm a New User's Email Address ----------------------------------- - -To confirm a newly-created user, pass a confirmation ``token`` and -``tokenId`` to the :java-sdk:`confirmUser() ` -or :java-sdk:`confirmUserAsync() ` -methods of your Realm ``App``'s :java-sdk:`EmailPasswordAuth ` -instance: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.confirm-a-new-users-email-address.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.confirm-a-new-users-email-address.java - :language: java - :copyable: false - -.. tip:: - - To access the ``token`` and ``tokenId`` values sent in the user - confirmation email, you can use a :ref:`custom confirmation email subject - ` containing a `deep link - `__. - -.. _java-reset-a-users-password: - -Reset a User's Password ------------------------ - -To reset a user password in Sync, you can either: - -- Send a password reset email -- Run a password reset function - -Select your preferred password reset method by going to: - -1. Your App -#. :guilabel:`Authentication` -#. :guilabel:`Authentication Providers` -#. :guilabel:`Email/Password` - and press the :guilabel:`EDIT` button - -Send a Password Reset Email -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To reset a user's password, first send the user a password reset email with -:java-sdk:`sendResetPasswordEmail() ` -or :java-sdk:`sendResetPasswordEmailAsync() `: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.send-reset-password-email.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.send-reset-password-email.java - :language: java - :copyable: false - -Password reset emails contain two values, ``token`` and ``tokenId``. -To complete the password reset flow, prompt the user to enter a new -password and pass the ``token`` and ``tokenId`` values along with the -new password value to your Realm ``App``'s -:java-sdk:`EmailPasswordAuth ` -instance's :java-sdk:`resetPassword() ` -or :java-sdk:`resetPasswordAsync() -` -methods: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.reset-password.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.reset-password.java - :language: java - :copyable: false - -.. tip:: - - To access the ``token`` and ``tokenId`` values sent in the password - reset email, you can use a :ref:`custom password reset email subject - ` containing a `deep link - `__. - -Run a Password Reset Function -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When you configure your app to :ref:`run a password reset function -`, you'll define the function that -should run when you call :java-sdk:`callResetPasswordFunction() ` -or :java-sdk:`callResetPasswordFunctionAsync() ` -from the SDK. This function can take a username, a password, and any number -of additional arguments. You can use these arguments to specify details -like security question answers or other challenges that the user should -pass to successfully complete a password reset. - -You might prefer to use a custom password reset function when you want to -define your own password reset flows. For example, you might send a custom -password reset email from a specific domain, or through a service other -than email. - -.. seealso:: - - For more information on how to define a custom password reset function - in your App, see: :ref:`Run a Password Reset Function - `. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.run-password-reset-func.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/ManageEmailPasswordTest.snippet.run-password-reset-func.java - :language: java - :copyable: false diff --git a/source/sdk/java/users/link-user-identities.txt b/source/sdk/java/users/link-user-identities.txt deleted file mode 100644 index fdd1b87078..0000000000 --- a/source/sdk/java/users/link-user-identities.txt +++ /dev/null @@ -1,39 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-link-user-identities: - -=============================== -Link User Identities - Java SDK -=============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -.. include:: /includes/link-user-identities.rst - -You link identities using -:java-sdk:`linkCredentials() ` -or :java-sdk:`linkCredentialsAsync() -`. -This links the new user identity to the logged-in :java-sdk:`User -` object. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/LinkUserIdentitiesTest.snippet.link-users.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/LinkUserIdentitiesTest.snippet.link-users.java - :language: java - :copyable: false diff --git a/source/sdk/java/users/manage-user-api-keys.txt b/source/sdk/java/users/manage-user-api-keys.txt deleted file mode 100644 index e0ba3a5c67..0000000000 --- a/source/sdk/java/users/manage-user-api-keys.txt +++ /dev/null @@ -1,195 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-manage-user-api-keys: - -=============================== -Manage User API Keys - Java SDK -=============================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Application users can generate user API keys with the SDK. You -can allow devices or services to communicate with Realm -on behalf of a user by associating a unique user API key with each -device or service. - -User API keys are always associated with a user object created by another -non-anonymous authentication provider. Each user can associate up to 20 -user keys with their account. - -.. tip:: - - User API keys are not the same as **server API keys**, which allow a - user or service to directly authenticate with Realm using the - :ref:`API Key authentication provider `. To learn - more about server API keys, see :ref:`API Key Authentication - `. - -.. _java-create-a-user-api-key: - -Create a User API Key ---------------------- - -To create a new user API key, call the :java-sdk:`create() -` or -:java-sdk:`createAsync() ` -methods of a logged in user's :java-sdk:`apiKeyAuth ` -instance. The user API key will be associated with the logged in user -and can be used to interact with Realm on their behalf. You cannot -create user API keys for anonymous users. - -.. include:: /includes/note-store-user-api-key-value.rst - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.create-a-user-api-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.create-a-user-api-key.java - :language: java - :copyable: false - -.. _java-look-up-a-user-api-key: - -Look up a User API Key ----------------------- - -To get a list of all user API keys associated with the logged in user, -call the synchronous :java-sdk:`fetchAll() ` -method or asynchronous :java-sdk:`fetchAll() -` method of a -logged in user's :java-sdk:`ApiKeyAuth ` instance. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.look-up-a-users-api-keys.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.look-up-a-users-api-keys.java - :language: java - :copyable: false - -To look up a specific user API key for the logged in user, pass the -key's id to the :java-sdk:`fetch() ` -or :java-sdk:`fetchAsync() ` -methods of a logged in user's -:java-sdk:`ApiKeyAuth ` instance. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.look-up-a-specific-user-api-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.look-up-a-specific-user-api-key.java - :language: java - :copyable: false - -.. _java-enable-or-disable-a-user-api-key: - -Enable or Disable a User API Key --------------------------------- - -.. _java-api-key-disable: - -Disable a User API Key -~~~~~~~~~~~~~~~~~~~~~~ - -To disable a specific user API key without deleting it, pass the -key's id to the :java-sdk:`disable() ` -or :java-sdk:`disableAsync() ` -methods of a logged in user's -:java-sdk:`ApiKeyAuth ` instance. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.disable-user-api-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.disable-user-api-key.java - :language: java - :copyable: false - -.. _java-api-key-enable: - -Enable a User API Key -~~~~~~~~~~~~~~~~~~~~~ - -To enable a specific user API key that was previously disabled, pass the -key's id to the :java-sdk:`enable() ` -or :java-sdk:`enableAsync() ` -methods of a logged in user's :java-sdk:`ApiKeyAuth ` instance. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.enable-user-api-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.enable-user-api-key.java - :language: java - :copyable: false - -.. _java-delete-a-user-api-key: - -Delete a User API Key ---------------------- - -To permanently remove a specific user API key, pass the -key's id to the :java-sdk:`delete() ` -or :java-sdk:`deleteAsync() ` -methods of a logged in user's :java-sdk:`ApiKeyAuth ` instance. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.delete-user-api-key.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/UserAPIKeysTest.snippet.delete-user-api-key.java - :language: java - :copyable: false diff --git a/source/sdk/java/users/multi-user-applications.txt b/source/sdk/java/users/multi-user-applications.txt deleted file mode 100644 index 83717e5ae0..0000000000 --- a/source/sdk/java/users/multi-user-applications.txt +++ /dev/null @@ -1,165 +0,0 @@ -.. meta:: - :robots: noindex, nosnippet - -.. _java-multi-user-applications: - -================================== -Multi-User Applications - Java SDK -================================== - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -The Realm SDK allows multiple :ref:`users ` to be logged in to an -app simultaneously on a given device. Realm client applications run -in the context of a single active user even if multiple users are logged in -simultaneously. You can quickly switch between authenticated users without -requiring them to log in again. - -.. warning:: - - **Any logged in user may become the active user without re-authenticating.** - Depending on your app, this may be a security vulnerability. For example, a - user on a shared device may switch to a coworker's logged in account without - providing their credentials or requiring their explicit permission. If your - application requires stricter authentication, avoid switching between users - and prefer to explicitly log the active user out before authenticating - another user. - -User Account States -------------------- - -When a user first logs in through a Realm SDK on a given device or -browser, the SDK saves the user's information and keeps track of the user's -state on the device. The user's data remains on the device, even if they log -out, unless you actively :ref:`remove the user `. - -The following states describe an on-device user at any given time: - -- **Authenticated:** any user that has logged in on the device - and has not logged out or had its session revoked. - - - **Active**: a single authenticated user that is currently using the - app on a given device. The SDK associates this user with outgoing - requests and Atlas App Services evaluates data access permissions and runs - functions in this user's context. See :ref:`active user ` for - more information. - - - **Inactive**: all authenticated users that are not the current - active user. You can :ref:`switch the active user ` to a - currently inactive user at any time. - -- **Logged Out:** any user that authenticated on the device but - has since logged out or had its session revoked. - -The following diagram shows how users within a Realm client app -transition between states when certain events occur: - -.. figure:: /images/multi-user.png - :alt: A diagram the outlines the different states a user can be in: logged out, logged in and active, & logged in and inactive. - -.. _java-add-a-new-user-to-the-device: - -Add a New User to the Device -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Realm SDK automatically adds users to a device when they log in -for the first time on that device. When a user logs in, they immediately become -the application's :ref:`active user `. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.add-a-new-user.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.add-a-new-user.java - :language: java - :copyable: false - -.. _java-list-all-users-on-the-device: - -List All Users on the Device -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can access a list of all :ref:`user accounts ` that are -stored on the device. This list includes all users that have logged in to the -client app on a given device regardless of whether they are currently -authenticated. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.list-all-on-device-users.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.list-all-on-device-users.java - :language: java - :copyable: false - -.. _java-remove-a-user-from-the-device: - -Remove a User from the Device -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To remove all information about a user from a device, -use :java-sdk:`user.remove() ` -or :java-sdk:`user.removeAsync() -`: - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.remove-a-user-from-device.kt - :language: kotlin - :emphasize-lines: 4 - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.remove-a-user-from-device.java - :language: java - :emphasize-lines: 4 - :copyable: false - -.. _java-change-the-active-user: - -Change the Active User -~~~~~~~~~~~~~~~~~~~~~~ - -You can quickly switch an app's :ref:`active user ` to another -logged in user at any time. - -.. tabs-realm-languages:: - - .. tab:: - :tabid: kotlin - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.switch-the-active-user.kt - :language: kotlin - :copyable: false - - .. tab:: - :tabid: java - - .. literalinclude:: /examples/generated/java/sync/MultipleUsersTest.snippet.switch-the-active-user.java - :language: java - :copyable: false