diff --git a/Docs/index.md b/Docs/index.md index 769cbb924d..aea56b58e0 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -22,9 +22,9 @@ To see what is supported, refer to the [LINQ Support](linqsupport.md) page. Documentation ------------- -The documentation can be found at [https://docs.mongodb.com/realm/sdk/dotnet/](https://docs.mongodb.com/realm/sdk/dotnet/). +The documentation can be found at [https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/). -The API reference is located at [https://docs.mongodb.com/realm-sdks/dotnet/latest/reference/Realms.html](https://docs.mongodb.com/realm-sdks/dotnet/latest/reference/Realms.html). +The API reference is located at [https://www.mongodb.com/docs/realm-sdks/dotnet/latest/](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/). Source ------ diff --git a/NuGet.md b/NuGet.md index a08b399da7..dd6581758d 100644 --- a/NuGet.md +++ b/NuGet.md @@ -3,15 +3,15 @@ realm by MongoDB -Realm is a mobile database that runs directly on phones, tablets or wearables. It supports all major mobile and desktop operating systems, such as iOS, Android, UWP, macOS, Linux, and Windows. For a full list of supported platforms and their versions, check out the [Supported Platforms](https://docs.mongodb.com/realm/dotnet/#supported-platforms) sub-section in the documentation. +Realm is a mobile database that runs directly on phones, tablets or wearables. It supports all major mobile and desktop operating systems, such as iOS, Android, UWP, macOS, Linux, and Windows. For a full list of supported platforms and their versions, check out the [Platform and Framework Compatibility](https://www.mongodb.com/docs/realm/sdk/dotnet/compatibility/) section in the documentation. ## Features * **Mobile-first:** Realm is the first database built from the ground up to run directly inside phones, tablets, and wearables. -* **Simple:** Data is directly [exposed as objects](https://docs.mongodb.com/realm/dotnet/objects/) and [queryable by code](https://docs.mongodb.com/realm/dotnet/query-engine/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://docs.mongodb.com/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. +* **Simple:** Data is directly [exposed as objects](https://www.mongodb.com/docs/realm/sdk/dotnet/model-data/object-models-and-schemas/#std-label-dotnet-objects/) and [queryable by code](https://www.mongodb.com/docs/realm/sdk/dotnet/crud/filter/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. * **Modern:** Realm supports relationships, generics, vectorization and modern C# idioms. * **Fast:** Realm is faster than even raw SQLite on common operations while maintaining an extremely rich feature set. -* **[Device Sync](https://www.mongodb.com/atlas/app-services/device-sync)**: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free with [a template application](https://github.com/mongodb/template-app-maui-todo) and [create the cloud backend](http://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dotnet_github). +* **[Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/)**: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free with [a template application](https://github.com/mongodb/template-app-maui-todo) and [create the cloud backend](http://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dotnet_github). ## Getting Started @@ -71,12 +71,12 @@ peopleWithJ.AsRealmCollection().CollectionChanged += (s, e) => }; ``` -For more examples, see the detailed instructions in our [User Guide](https://docs.mongodb.com/realm/dotnet/install/) to add Realm to your solution. +For more examples, see the detailed instructions in our [User Guide](https://www.mongodb.com/docs/realm/sdk/dotnet/install/) to add Realm to your solution. ## Documentation -The documentation can be found at [docs.mongodb.com/realm/dotnet/](https://docs.mongodb.com/realm/dotnet/). -The API reference is located at [docs.mongodb.com/realm-sdks/dotnet/latest/](https://docs.mongodb.com/realm-sdks/dotnet/latest/). +The documentation can be found at [mongodb.com/docs/atlas/device-sdks/sdk/dotnet/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/). +The API reference is located at [mongodb.com/docs/realm-sdks/dotnet/latest/](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/). ## Getting Help diff --git a/README.md b/README.md index 807e018e9f..19fd421465 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,24 @@ Realm is a mobile database that runs directly on phones, tablets or wearables. -This repository holds the source code for the .NET / C# versions of Realm. Currently, we support all major mobile and desktop operating systems, such as iOS, Android, UWP, macOS, Linux, and Windows. For a full list of supported platforms and their versions, check out the [Supported Platforms](https://docs.mongodb.com/realm/dotnet/#supported-platforms) sub-section in the documentation. +This repository holds the source code for the .NET / C# versions of Realm. Currently, we support all major mobile and desktop operating systems, such as iOS, Android, UWP, macOS, Linux, and Windows. For a full list of supported platforms and their versions, check out the [Platform and Framework Compatibility](https://www.mongodb.com/docs/realm/sdk/dotnet/compatibility/) section in the documentation. ## Features * **Mobile-first:** Realm is the first database built from the ground up to run directly inside phones, tablets, and wearables. -* **Simple:** Data is directly [exposed as objects](https://docs.mongodb.com/realm/dotnet/objects/) and [queryable by code](https://docs.mongodb.com/realm/dotnet/query-engine/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://docs.mongodb.com/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. +* **Simple:** Data is directly [exposed as objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/object-models-and-schemas/) and [queryable by code](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/filter/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. * **Modern:** Realm supports relationships, generics, vectorization and modern C# idioms. * **Fast:** Realm is faster than even raw SQLite on common operations while maintaining an extremely rich feature set. * **[MongoDB Atlas Device Sync](https://www.mongodb.com/atlas/app-services/device-sync)**: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free with [a template application](https://github.com/mongodb/template-app-maui-todo) and [create the cloud backend](http://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dotnet_github). ## Getting Started -Please see the detailed instructions in our [User Guide](https://docs.mongodb.com/realm/dotnet/install/) to add Realm to your solution. +Please see the detailed instructions in our [User Guide](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/install/) to add Realm to your solution. ## Documentation -The documentation can be found at [docs.mongodb.com/realm/dotnet/](https://docs.mongodb.com/realm/dotnet/). -The API reference is located at [docs.mongodb.com/realm-sdks/dotnet/latest/](https://docs.mongodb.com/realm-sdks/dotnet/latest/). +The documentation can be found at [mongodb.com/docs/atlas/device-sdks/sdk/dotnet/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/). +The API reference is located at [mongodb.com/docs/realm-sdks/dotnet/latest/](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/). ## Getting Help @@ -38,7 +38,7 @@ Refer to [this guide](https://www.visualstudio.com/en-us/docs/package/nuget/cons ## Building Realm -We highly recommend [using our pre-built binaries via NuGet](https://docs.mongodb.com/realm/dotnet/install/#open-the-nuget-package-manager) but you can also build from source. +We highly recommend [using our pre-built binaries via NuGet](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/install/#open-the-nuget-package-manager) but you can also build from source. Prerequisites: diff --git a/Realm/Realm.SourceGenerator/Realm.SourceGenerator.csproj b/Realm/Realm.SourceGenerator/Realm.SourceGenerator.csproj index 41edb08480..e3c36223aa 100644 --- a/Realm/Realm.SourceGenerator/Realm.SourceGenerator.csproj +++ b/Realm/Realm.SourceGenerator/Realm.SourceGenerator.csproj @@ -5,7 +5,7 @@ Realm.SourceGenerator Realm.SourceGenerator Realm.SourceGenerator - https://docs.mongodb.com/realm-sdks/dotnet/latest/CHANGELOG.html + https://www.mongodb.com/docs/realm-sdks/dotnet/latest/CHANGELOG.html $(ProjectDir)..\..\global.ruleset Realm.SourceGenerator is a Source Generator used to generate the implementation of Realm model classes. true @@ -36,7 +36,7 @@ runtime; build; native; contentfiles; analyzers; buildtransitive - @@ -46,7 +46,7 @@ $(GetTargetPathDependsOn);GetDependencyTargetPaths diff --git a/Realm/Realm.Unity/README.md b/Realm/Realm.Unity/README.md index 024fea0464..afc486c3d9 100644 --- a/Realm/Realm.Unity/README.md +++ b/Realm/Realm.Unity/README.md @@ -8,19 +8,20 @@ Realm is an embedded mobile database that runs directly on phones, tablets, or d ## Features * **Mobile-first:** Realm is the first database built from the ground up to run directly inside phones, tablets, and wearables. -* **Simple:** Data is directly [exposed as objects](https://docs.mongodb.com/realm/dotnet/objects/) and [queryable by code](https://docs.mongodb.com/realm/dotnet/query-engine/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://docs.mongodb.com/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. +* **Simple:** Data is directly [exposed as objects](https://www.mongodb.com/docs/realm/sdk/dotnet/model-data/object-models-and-schemas/#std-label-dotnet-objects/) and [queryable by code](https://www.mongodb.com/docs/realm/sdk/dotnet/crud/filter/), removing the need for ORM's riddled with performance & maintenance issues. Plus, we've worked hard to [keep our API down to just a few common classes](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/): most of our users pick it up intuitively, getting simple apps up & running in minutes. * **Modern:** Realm supports relationships, generics, vectorization and modern C# idioms. * **Fast:** Realm is faster than even raw SQLite on common operations while maintaining an extremely rich feature set. +* **[Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/)**: Makes it simple to keep data in sync across users, devices, and your backend in real-time. Get started for free with [a template application](https://github.com/mongodb/template-app-maui-todo) and [create the cloud backend](http://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dotnet_github). ## Getting Started -Please see the detailed instructions in our [Install Guide](https://docs.mongodb.com/realm/sdk/dotnet/unity/#install) to add Realm to your Unity project. +Please see the detailed instructions in our [Install Guide](https://www.mongodb.com/docs/realm/sdk/dotnet/unity/) to add Realm to your Unity project. ## Documentation -The documentation can be found at [docs.mongodb.com/realm/dotnet/](https://docs.mongodb.com/realm/dotnet/). +The documentation can be found at [mongodb.com/docs/atlas/device-sdks/sdk/dotnet/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/). -The API reference is located at [docs.mongodb.com/realm-sdks/dotnet/latest/](https://docs.mongodb.com/realm-sdks/dotnet/latest/). +The API reference is located at [mongodb.com/docs/realm-sdks/dotnet/latest/](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/). ## Getting Help diff --git a/Realm/Realm.Unity/package.json b/Realm/Realm.Unity/package.json index 1e748e7e95..5f0b158b90 100644 --- a/Realm/Realm.Unity/package.json +++ b/Realm/Realm.Unity/package.json @@ -17,7 +17,7 @@ "author": { "name": "Realm", "email": "realm-help@mongodb.com", - "url": "https://docs.mongodb.com/realm/dotnet/" + "url": "https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/" }, "bugs": { "url": "https://github.com/realm/realm-dotnet/issues", @@ -29,4 +29,4 @@ "type": "git", "url": "git+ssh://git@github.com:realm/realm-dotnet.git" } -} \ No newline at end of file +} diff --git a/Realm/Realm.UnityUtils/Realm.UnityUtils.csproj b/Realm/Realm.UnityUtils/Realm.UnityUtils.csproj index c2e8acf3cb..cd7c5baf77 100644 --- a/Realm/Realm.UnityUtils/Realm.UnityUtils.csproj +++ b/Realm/Realm.UnityUtils/Realm.UnityUtils.csproj @@ -4,7 +4,7 @@ netstandard2.0 Realm.UnityUtils Realm.UnityUtils - https://docs.mongodb.com/realm-sdks/dotnet/latest/CHANGELOG.html + https://www.mongodb.com/docs/realm-sdks/dotnet/latest/CHANGELOG.html $(ProjectDir)..\..\global.ruleset Realm.UnityUtils true diff --git a/Realm/Realm/Configurations/FlexibleSyncConfiguration.cs b/Realm/Realm/Configurations/FlexibleSyncConfiguration.cs index 13d51cc33d..1e4b610951 100644 --- a/Realm/Realm/Configurations/FlexibleSyncConfiguration.cs +++ b/Realm/Realm/Configurations/FlexibleSyncConfiguration.cs @@ -29,7 +29,7 @@ namespace Realms.Sync /// will be initially empty until one or more subscriptions are added /// via . /// - /// Sync Docs + /// Device Sync Docs public class FlexibleSyncConfiguration : SyncConfigurationBase { /// diff --git a/Realm/Realm/Configurations/PartitionSyncConfiguration.cs b/Realm/Realm/Configurations/PartitionSyncConfiguration.cs index 5c5e5de479..fbf2ffd483 100644 --- a/Realm/Realm/Configurations/PartitionSyncConfiguration.cs +++ b/Realm/Realm/Configurations/PartitionSyncConfiguration.cs @@ -25,7 +25,7 @@ namespace Realms.Sync /// /// A is used to setup a that can be synchronized between devices using Atlas Device Sync. /// - /// Sync Overview Docs + /// Device Sync Docs public class PartitionSyncConfiguration : SyncConfigurationBase { /// diff --git a/Realm/Realm/Configurations/SyncConfigurationBase.cs b/Realm/Realm/Configurations/SyncConfigurationBase.cs index c1dba4f621..a552f114c7 100644 --- a/Realm/Realm/Configurations/SyncConfigurationBase.cs +++ b/Realm/Realm/Configurations/SyncConfigurationBase.cs @@ -34,7 +34,7 @@ namespace Realms.Sync /// allows you to start with an empty Realm and send the server a set of queries which it will run and /// populate the Realm with all documents matching them. /// - /// Sync Overview Docs + /// Device Sync Docs public abstract class SyncConfigurationBase : RealmConfigurationBase { private ClientResetHandlerBase _clientResetHandler = new RecoverOrDiscardUnsyncedChangesHandler(); @@ -66,7 +66,7 @@ public abstract class SyncConfigurationBase : RealmConfigurationBase /// and . /// The default will have no custom actions set for the before and after callbacks. /// - /// Client reset docs + /// Client reset docs public virtual ClientResetHandlerBase ClientResetHandler { get => _clientResetHandler; diff --git a/Realm/Realm/Exceptions/RealmMigrationNeededException.cs b/Realm/Realm/Exceptions/RealmMigrationNeededException.cs index 99bb8fab52..a767a260e0 100644 --- a/Realm/Realm/Exceptions/RealmMigrationNeededException.cs +++ b/Realm/Realm/Exceptions/RealmMigrationNeededException.cs @@ -21,12 +21,12 @@ namespace Realms.Exceptions /// /// Exception thrown when attempting to open a file whose differs from your current class declarations. /// - /// Read more about Migrations. + /// Read more about Migrations. public class RealmMigrationNeededException : RealmFileAccessErrorException { internal RealmMigrationNeededException(string message) : base(message) { - HelpLink = "https://docs.mongodb.com/realm/dotnet/migrations/"; + HelpLink = "https://www.mongodb.com/docs/realm/sdk/dotnet/model-data/change-an-object-model/#migrate-a-schema/"; } } } diff --git a/Realm/Realm/Exceptions/RealmSchemaValidationException.cs b/Realm/Realm/Exceptions/RealmSchemaValidationException.cs index edeee2ea6b..f7714e11e6 100644 --- a/Realm/Realm/Exceptions/RealmSchemaValidationException.cs +++ b/Realm/Realm/Exceptions/RealmSchemaValidationException.cs @@ -22,7 +22,7 @@ namespace Realms.Exceptions /// Exception thrown when the schema specified in your C# models doesn't pass validation for the type of Realm you're trying to open. /// The message contains information about the validation errors and how to correct them. /// - /// + /// /// General information about Realm's schema. /// public class RealmSchemaValidationException : RealmException @@ -31,4 +31,4 @@ internal RealmSchemaValidationException(string detailMessage) : base(detailMessa { } } -} \ No newline at end of file +} diff --git a/Realm/Realm/Exceptions/Sync/ErrorCode.cs b/Realm/Realm/Exceptions/Sync/ErrorCode.cs index c51fd17c82..066e8dc0cb 100644 --- a/Realm/Realm/Exceptions/Sync/ErrorCode.cs +++ b/Realm/Realm/Exceptions/Sync/ErrorCode.cs @@ -64,7 +64,7 @@ public enum ErrorCode /// ManualResetFallback is invoked on one of the automatic client reset handlers. /// /// - /// + /// ClientReset = 1032, /// diff --git a/Realm/Realm/Extensions/CollectionExtensions.cs b/Realm/Realm/Extensions/CollectionExtensions.cs index b5c03acc89..54a7f81eee 100644 --- a/Realm/Realm/Extensions/CollectionExtensions.cs +++ b/Realm/Realm/Extensions/CollectionExtensions.cs @@ -377,7 +377,7 @@ public static IDisposable SubscribeForKeyNotifications(this IDictionary $0 || (Bar.String == $1 && Bar.Bool == $2)", 5, "small", true); /// /// - /// + /// /// Examples of the NSPredicate syntax /// /// NSPredicate Cheatsheet diff --git a/Realm/Realm/Helpers/AsyncHelper.cs b/Realm/Realm/Helpers/AsyncHelper.cs index a8e53b5c12..3744af825e 100644 --- a/Realm/Realm/Helpers/AsyncHelper.cs +++ b/Realm/Realm/Helpers/AsyncHelper.cs @@ -35,7 +35,7 @@ public static void EnsureValidContext() { throw new NotSupportedException(MissingContextErrorMessage) { - HelpLink = "https://docs.mongodb.com/realm/dotnet/threading/" + HelpLink = "https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/threading/" }; } } diff --git a/Realm/Realm/Migration.cs b/Realm/Realm/Migration.cs index 8d9896bb59..02dea33a7c 100644 --- a/Realm/Realm/Migration.cs +++ b/Realm/Realm/Migration.cs @@ -29,7 +29,7 @@ namespace Realms /// You can read from the and access properties that have been removed from /// the classes by using the dynamic API. /// - /// See more in the migrations section in the documentation. + /// See more in the migrations section in the documentation. public class Migration { private IntPtr _migrationSchema; diff --git a/Realm/Realm/Schema/ObjectSchema.cs b/Realm/Realm/Schema/ObjectSchema.cs index 2ab4ccfe7e..ac45931e91 100644 --- a/Realm/Realm/Schema/ObjectSchema.cs +++ b/Realm/Realm/Schema/ObjectSchema.cs @@ -281,7 +281,7 @@ public Builder(Type type) if (Count == 0) { throw new InvalidOperationException( - $"No properties in {type.Name}, has linker stripped it? See https://docs.mongodb.com/realm/sdk/dotnet/troubleshooting/#resolve-a--no-properties-in-class--exception"); + $"No properties in {type.Name}, has linker stripped it? See https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/troubleshooting/#resolve-a--no-properties-in-class--exception"); } Type = type; diff --git a/Realm/Realm/Sync/ApiKey.cs b/Realm/Realm/Sync/ApiKey.cs index 85f45b599d..3e3cf59ea2 100644 --- a/Realm/Realm/Sync/ApiKey.cs +++ b/Realm/Realm/Sync/ApiKey.cs @@ -28,7 +28,7 @@ namespace Realms.Sync /// An API key's is only available when the key is created and cannot be obtained after that. /// This means that it's the caller's responsibility to safely store an API key's value upon creation. /// - /// API Key Authentication Docs + /// API Key Authentication Docs public class ApiKey { /// diff --git a/Realm/Realm/Sync/Credentials.cs b/Realm/Realm/Sync/Credentials.cs index 4c4680e914..6e303eeca1 100644 --- a/Realm/Realm/Sync/Credentials.cs +++ b/Realm/Realm/Sync/Credentials.cs @@ -30,7 +30,7 @@ public class Credentials /// An enum containing the possible authentication providers. These have to manually be enabled for /// your app before they can be used. /// - /// Authentication Providers Docs + /// Authentication Providers Docs public enum AuthProvider { /// @@ -97,7 +97,7 @@ public enum AuthProvider /// a new user will be created on the server. /// /// A Credentials that can be used to authenticate an anonymous user. - /// Anonymous Authentication Docs + /// Anonymous Authentication Docs public static Credentials Anonymous(bool reuseExisting = true) => new(AuthProvider.Anonymous, additionalInfo: reuseExisting.ToString().ToLower()); /// @@ -105,7 +105,7 @@ public enum AuthProvider /// /// The OAuth 2.0 access token representing the Facebook user. /// A Credentials that can be used to authenticate a user with Facebook. - /// Facebook Authentication Docs + /// Facebook Authentication Docs public static Credentials Facebook(string accessToken) { Argument.NotNull(accessToken, nameof(accessToken)); @@ -119,7 +119,7 @@ public static Credentials Facebook(string accessToken) /// The credential representing the Google user. /// The type of the credential. /// A Credentials that can be used to authenticate a user with Google. - /// Google Authentication Docs + /// Google Authentication Docs public static Credentials Google(string credential, GoogleCredentialType type) { Argument.NotNull(credential, nameof(credential)); @@ -131,7 +131,7 @@ public static Credentials Google(string credential, GoogleCredentialType type) /// /// The OAuth 2.0 access token representing the user's Apple ID. /// A Credentials that can be used to authenticate a user via an Apple ID. - /// Apple ID Authentication Docs + /// Apple ID Authentication Docs public static Credentials Apple(string accessToken) { Argument.NotNull(accessToken, nameof(accessToken)); @@ -144,7 +144,7 @@ public static Credentials Apple(string accessToken) /// /// The custom JWT token representing the user. /// A Credentials that can be used to authenticate a user with a custom JWT Token. - /// Custom JWT Authentication Docs + /// Custom JWT Authentication Docs public static Credentials JWT(string customToken) { Argument.NotNull(customToken, nameof(customToken)); @@ -165,7 +165,7 @@ public static Credentials JWT(string customToken) /// provider can also be configured to automatically confirm users or to run a custom confirmation function upon /// user registration. /// - /// Email/Password Authentication Docs + /// Email/Password Authentication Docs public static Credentials EmailPassword(string email, string password) { Argument.NotNullOrEmpty(email, nameof(email)); @@ -185,7 +185,7 @@ public static Credentials EmailPassword(string email, string password) /// Additionally, the names of the fields/properties must match exactly the names that your function /// expects. /// - /// Custom Function Authentication Docs + /// Custom Function Authentication Docs public static Credentials Function(object payload) { return new Credentials(AuthProvider.Function, payload.ToNativeJson()); @@ -196,7 +196,7 @@ public static Credentials Function(object payload) /// /// The API key to use for login. /// A Credentials that can be used to authenticate user with an API key. - /// API Key Authentication Docs + /// API Key Authentication Docs public static Credentials ApiKey(string key) { Argument.NotNull(key, nameof(key)); @@ -209,7 +209,7 @@ public static Credentials ApiKey(string key) /// /// The server API key to use for login. /// A Credentials that can be used to authenticate user with an API key. - /// API Key Authentication Docs + /// API Key Authentication Docs [Obsolete("Use Credentials.ApiKey instead.")] public static Credentials ServerApiKey(string serverApiKey) { diff --git a/Realm/Realm/Sync/ErrorHandling/ClientResetHandlerBase.cs b/Realm/Realm/Sync/ErrorHandling/ClientResetHandlerBase.cs index f58bffdce1..2e16c16c74 100644 --- a/Realm/Realm/Sync/ErrorHandling/ClientResetHandlerBase.cs +++ b/Realm/Realm/Sync/ErrorHandling/ClientResetHandlerBase.cs @@ -26,7 +26,7 @@ namespace Realms.Sync.ErrorHandling /// To use either of them, create a new instance and assign it to on the configuration /// you use to open the synchronized instance. /// - /// Client Resets - .NET SDK + /// Client Resets - .NET SDK public abstract class ClientResetHandlerBase { /// diff --git a/Realm/Realm/Sync/ErrorHandling/DiscardUnsyncedChangesHandler.cs b/Realm/Realm/Sync/ErrorHandling/DiscardUnsyncedChangesHandler.cs index 1e3ce44a4a..c1a4f69290 100644 --- a/Realm/Realm/Sync/ErrorHandling/DiscardUnsyncedChangesHandler.cs +++ b/Realm/Realm/Sync/ErrorHandling/DiscardUnsyncedChangesHandler.cs @@ -32,7 +32,7 @@ namespace Realms.Sync.ErrorHandling /// 3. advanced use cases for data-sensitive applications where the developer wants to recover in the most appropriate way the unsynced data /// 4. backup the whole realm before the client reset happens (in ). Such backup could, for example, be used to restore the unsynced data (see 3.) /// - /// Client Resets - .NET SDK + /// Client Resets - .NET SDK public sealed class DiscardUnsyncedChangesHandler : ClientResetHandlerBase { /// diff --git a/Realm/Realm/Sync/ErrorHandling/ManualRecoveryHandler.cs b/Realm/Realm/Sync/ErrorHandling/ManualRecoveryHandler.cs index 8d21212c46..7cd4e9c5d5 100644 --- a/Realm/Realm/Sync/ErrorHandling/ManualRecoveryHandler.cs +++ b/Realm/Realm/Sync/ErrorHandling/ManualRecoveryHandler.cs @@ -21,7 +21,7 @@ namespace Realms.Sync.ErrorHandling /// /// A client reset strategy where the user needs to fully take care of a client reset. /// - /// Client Resets - .NET SDK + /// Client Resets - .NET SDK public sealed class ManualRecoveryHandler : ClientResetHandlerBase { /// diff --git a/Realm/Realm/Sync/ErrorHandling/RecoverOrDiscardUnsyncedChangesHandler.cs b/Realm/Realm/Sync/ErrorHandling/RecoverOrDiscardUnsyncedChangesHandler.cs index 3c93bf6466..32a6fa51b8 100644 --- a/Realm/Realm/Sync/ErrorHandling/RecoverOrDiscardUnsyncedChangesHandler.cs +++ b/Realm/Realm/Sync/ErrorHandling/RecoverOrDiscardUnsyncedChangesHandler.cs @@ -26,7 +26,7 @@ namespace Realms.Sync.ErrorHandling /// The automatic recovery fails when a client that is configured for recovery is flagged on the server "as not allowed to execute automatic recovery". /// In this situation this strategy falls back to the discard unsynced one. /// To reiterate what it does: it discards all the unsynced local changes and uses the latest realm that is available on the remote sync server. - /// You can read more about the automatic merge rules at Client Resets - .NET SDK. + /// You can read more about the automatic merge rules at Client Resets - .NET SDK. /// The automatic recovery mechanism creates write transactions meaning that all the changes that take place /// are properly propagated through the standard Realm's change notifications. /// The strategy supplies four callbacks: , , @@ -47,7 +47,7 @@ namespace Realms.Sync.ErrorHandling /// 4. Backup the whole realm before the client reset happens (in ). /// Such backup could, for example, be used to restore the unsynced data (see 3.) /// - /// Client Resets - .NET SDK + /// Client Resets - .NET SDK public sealed class RecoverOrDiscardUnsyncedChangesHandler : ClientResetHandlerBase { internal override ClientResyncMode ClientResetMode => ClientResyncMode.RecoverOrDiscard; diff --git a/Realm/Realm/Sync/ErrorHandling/RecoverUnsyncedChangesHandler.cs b/Realm/Realm/Sync/ErrorHandling/RecoverUnsyncedChangesHandler.cs index 7b4ce78c7f..289c952029 100644 --- a/Realm/Realm/Sync/ErrorHandling/RecoverUnsyncedChangesHandler.cs +++ b/Realm/Realm/Sync/ErrorHandling/RecoverUnsyncedChangesHandler.cs @@ -22,7 +22,7 @@ namespace Realms.Sync.ErrorHandling /// A client reset strategy that attempts to automatically recover any unsynchronized changes. /// /// - /// You can read more about the automatic merge rules at Client Resets - .NET SDK. + /// You can read more about the automatic merge rules at Client Resets - .NET SDK. /// The automatic recovery mechanism creates write transactions meaning that all the changes that take place /// are properly propagated through the standard Realm's change notifications. /// The strategy supplies three callbacks: , and . @@ -37,7 +37,7 @@ namespace Realms.Sync.ErrorHandling /// 4. Backup the whole realm before the client reset happens (in ). /// Such backup could, for example, be used to restore the unsynced data (see 3.) /// - /// Client Resets - .NET SDK + /// Client Resets - .NET SDK public sealed class RecoverUnsyncedChangesHandler : ClientResetHandlerBase { internal override ClientResyncMode ClientResetMode => ClientResyncMode.Recover; diff --git a/Realm/Realm/Sync/User.cs b/Realm/Realm/Sync/User.cs index 3098f55380..7f88a87ff2 100644 --- a/Realm/Realm/Sync/User.cs +++ b/Realm/Realm/Sync/User.cs @@ -131,7 +131,7 @@ public string DeviceId /// The data is only refreshed when the user's access token is refreshed or when explicitly calling . /// /// A document containing the user data. - /// Custom User Data Docs + /// Custom User Data Docs public BsonDocument? GetCustomData() { var serialized = Handle.GetCustomData(); @@ -151,7 +151,7 @@ public string DeviceId /// The data is only refreshed when the user's access token is refreshed or when explicitly calling . /// /// A document containing the user data. - /// Custom User Data Docs + /// Custom User Data Docs public T? GetCustomData() where T : class { @@ -181,14 +181,14 @@ public UserIdentity[] Identities /// Gets a instance that exposes functionality for managing user API keys. /// /// A instance scoped to this . - /// API Keys Authentication Docs + /// API Keys Authentication Docs public ApiKeyClient ApiKeys { get; } /// /// Gets a instance that exposes functionality for calling remote Atlas Functions. /// /// A instance scoped to this . - /// Functions Docs + /// Functions Docs public FunctionsClient Functions { get; } internal readonly SyncUserHandle Handle; @@ -444,7 +444,7 @@ private static async Task Handle404(Task task, ObjectId? id = null) /// /// A class exposing functionality for calling remote Atlas Functions. /// - /// Functions Docs + /// Functions Docs public class FunctionsClient { private readonly User _user; diff --git a/SUPPORT.md b/SUPPORT.md index 92be6a5d9c..cbcfee2dea 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -4,7 +4,7 @@ The Realm team is here to help you with your Realm-related issues! ## Documentation -Before asking questions, please familiarize yourself with our [.NET SDK](https://docs.mongodb.com/realm/dotnet/) documentation. +Before asking questions, please familiarize yourself with our [.NET SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/) documentation. ## Stack Overflow @@ -16,4 +16,4 @@ When asking questions on Stack Overflow, please keep in mind Stack Overflow's [q If you are running into issues with Realm, including potential bugs or feature requests, we encourage you to file an issue on our [GitHub issue tracker](https://github.com/realm/realm-dotnet/issues). Please check out our [Contribution Guidelines](CONTRIBUTING.md) for information on how to properly file an issue. -We greatly appreciate demonstration projects that we can run for ourselves in order to see issues or potential bugs; we prioritize clearly-written tickets that include reproduction cases. You may attach these to the ticket; let us know if you need to share them confidentially, and we’ll provide instructions on how to do so. +We greatly appreciate demonstration projects that we can run for ourselves in order to see issues or potential bugs; we prioritize clearly-written tickets that include reproduction cases. You may attach these to the ticket; let us know if you need to share them confidentially, and we’ll provide instructions on how to do so.