-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Scaffold page with Swift and Objective-C API descriptions
- Loading branch information
Showing
12 changed files
with
547 additions
and
1 deletion.
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
4
...ectivec/users/custom-user-data-create-custom-user-data-document-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
The following example :ref:`accesses MongoDB <sdks-access-mongodb>` through | ||
the ``MongoClient`` to insert document a into the custom user data collection. | ||
This document contains the user ID of the currently logged in user and a | ||
``favoriteColor`` value. |
6 changes: 6 additions & 0 deletions
6
...tails/objectivec/users/custom-user-data-read-custom-user-data-2-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. note:: | ||
|
||
If you require the most recent version of custom user data, use the | ||
:objc-sdk:`refreshCustomDataWithCompletion | ||
<Classes/RLMUser.html#/c:objc(cs)RLMUser(im)refreshCustomDataWithCompletion:>` | ||
method to request the latest version of a user's custom data. |
2 changes: 2 additions & 0 deletions
2
...details/objectivec/users/custom-user-data-read-custom-user-data-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
To read the data, access the ``customData`` property on the ``User`` object of | ||
a logged-in user. |
5 changes: 5 additions & 0 deletions
5
...tails/objectivec/users/custom-user-data-update-custom-user-data-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
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. | ||
The following example uses :ref:`MongoDB Data Access <sdks-access-mongodb>` 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. |
4 changes: 4 additions & 0 deletions
4
...s/swift/users/custom-user-data-create-custom-user-data-document-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
The following example :ref:`accesses MongoDB <sdks-access-mongodb>` through | ||
the ``MongoClient`` to insert document a into the custom user data collection. | ||
This document contains the user ID of the currently logged in user and a | ||
``favoriteColor`` value. |
6 changes: 6 additions & 0 deletions
6
...pi-details/swift/users/custom-user-data-read-custom-user-data-2-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. note:: | ||
|
||
If you require the most recent version of custom user data, use the | ||
:swift-sdk:`refreshCustomData() | ||
<Extensions/User.html#/s:So7RLMUserC10RealmSwiftE17refreshCustomData7Combine6FutureCySDys11AnyHashableVypGs5Error_pGyF>` | ||
method to request the latest version of a user's custom data. |
2 changes: 2 additions & 0 deletions
2
.../api-details/swift/users/custom-user-data-read-custom-user-data-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
To read the data, access the ``customData`` property on the ``User`` object of | ||
a logged-in user. |
5 changes: 5 additions & 0 deletions
5
...pi-details/swift/users/custom-user-data-update-custom-user-data-description.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
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. | ||
The following example uses :ref:`MongoDB Data Access <sdks-access-mongodb>` 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. |
63 changes: 63 additions & 0 deletions
63
...cludes/sdk-examples/users/custom-user-data-create-custom-user-data-document.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
.. tabs-drivers:: | ||
|
||
tabs: | ||
- id: cpp-sdk | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/cpp/asymmetric-sync.snippet.create-asymmetric-object.cpp | ||
:language: cpp | ||
|
||
- id: csharp | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.cs | ||
:language: csharp | ||
|
||
- id: dart | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/flutter/data_ingest.test.snippet.write-asymmetric-object.dart | ||
:language: dart | ||
|
||
- id: java | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/api.java | ||
:language: java | ||
|
||
- id: java-kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example-java-kotlin.kt | ||
:language: kotlin | ||
|
||
- id: javascript | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.js | ||
:language: javascript | ||
|
||
- id: kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/kotlin/AsymmetricSyncTest.snippet.create-asymmetric-object.kt | ||
:language: kotlin | ||
:emphasize-lines: 10, 11 | ||
|
||
- id: objectivec | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.create-custom-user-data.m | ||
:language: objectivec | ||
|
||
- id: swift | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.create-custom-user-data.swift | ||
:language: swift | ||
|
||
- id: typescript | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/node/asymmetric-sync.snippet.write-asymmetric-object.ts | ||
:language: typescript |
63 changes: 63 additions & 0 deletions
63
source/includes/sdk-examples/users/custom-user-data-read-custom-user-data.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
.. tabs-drivers:: | ||
|
||
tabs: | ||
- id: cpp-sdk | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/cpp/asymmetric-sync.snippet.create-asymmetric-object.cpp | ||
:language: cpp | ||
|
||
- id: csharp | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.cs | ||
:language: csharp | ||
|
||
- id: dart | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/flutter/data_ingest.test.snippet.write-asymmetric-object.dart | ||
:language: dart | ||
|
||
- id: java | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/api.java | ||
:language: java | ||
|
||
- id: java-kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example-java-kotlin.kt | ||
:language: kotlin | ||
|
||
- id: javascript | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.js | ||
:language: javascript | ||
|
||
- id: kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/kotlin/AsymmetricSyncTest.snippet.create-asymmetric-object.kt | ||
:language: kotlin | ||
:emphasize-lines: 10, 11 | ||
|
||
- id: objectivec | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.read-custom-user-data.m | ||
:language: objectivec | ||
|
||
- id: swift | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.read-custom-user-data.swift | ||
:language: swift | ||
|
||
- id: typescript | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/node/asymmetric-sync.snippet.write-asymmetric-object.ts | ||
:language: typescript |
63 changes: 63 additions & 0 deletions
63
source/includes/sdk-examples/users/custom-user-data-update-custom-user-data.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
.. tabs-drivers:: | ||
|
||
tabs: | ||
- id: cpp-sdk | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/cpp/asymmetric-sync.snippet.create-asymmetric-object.cpp | ||
:language: cpp | ||
|
||
- id: csharp | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.cs | ||
:language: csharp | ||
|
||
- id: dart | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/flutter/data_ingest.test.snippet.write-asymmetric-object.dart | ||
:language: dart | ||
|
||
- id: java | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/api.java | ||
:language: java | ||
|
||
- id: java-kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example-java-kotlin.kt | ||
:language: kotlin | ||
|
||
- id: javascript | ||
content: | | ||
|
||
.. literalinclude:: /examples/MissingPlaceholders/example.js | ||
:language: javascript | ||
|
||
- id: kotlin | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/kotlin/AsymmetricSyncTest.snippet.create-asymmetric-object.kt | ||
:language: kotlin | ||
:emphasize-lines: 10, 11 | ||
|
||
- id: objectivec | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.update-custom-user-data.m | ||
:language: objectivec | ||
|
||
- id: swift | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/code/start/CustomUserData.snippet.update-custom-user-data.swift | ||
:language: swift | ||
|
||
- id: typescript | ||
content: | | ||
|
||
.. literalinclude:: /examples/generated/node/asymmetric-sync.snippet.write-asymmetric-object.ts | ||
:language: typescript |
Oops, something went wrong.