Skip to content

Commit

Permalink
New documentation URL (#1621)
Browse files Browse the repository at this point in the history
* New documentation URL
* Update others docs urls (#1626)
---------
Co-authored-by: Kasper Overgård Nielsen <[email protected]>
  • Loading branch information
kneth authored Apr 12, 2024
1 parent 6e0eb92 commit f22f129
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This repository holds the source code for the Realm SDK for Flutter™ and Dart
* **Simple:** Realm’s object-oriented data model is simple to learn, doesn’t need an ORM, and the [API](https://pub.dev/documentation/realm/latest/) lets you write less code to get apps up & running in minutes.
* **Modern:** Realm supports latest Dart and Flutter versions and is built with sound null-safety.
* **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-dart-flutter-todo) and [create the cloud backend](https://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dart_github).
* **[MongoDB Atlas 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-dart-flutter-todo) and [create the cloud backend](https://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_dart_github).

## Getting Started

Expand Down Expand Up @@ -90,7 +90,7 @@ For API documentation go to

Use [realm](https://pub.dev/packages/realm) package for Flutter and [realm_dart](https://pub.dev/packages/realm_dart) package for Dart applications.

For complete documentation of the SDKs, go to the [Realm SDK documentation](https://docs.mongodb.com/realm/sdk/flutter/).
For complete documentation of the SDKs, go to the [Realm SDK documentation](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/).

If you are using the Realm SDK for the first time, refer to the [Quick Start documentation](https://www.mongodb.com/docs/realm/sdk/flutter/quick-start/).

Expand Down Expand Up @@ -352,7 +352,7 @@ This section is about how to use the Realm with [Device Sync](https://www.mongod
1. Add a sync subscription and write data.

Only data matching the query in the subscription will be synced to the server and only data matching the subscription will be downloaded to the local device realm file.

``` dart
realm.subscriptions.update((mutableSubscriptions) {
mutableSubscriptions.add(realm.query<Task>(r'status == $0 AND progressMinutes == $1', ["completed", 100]));
Expand Down
8 changes: 4 additions & 4 deletions packages/realm_dart/lib/src/credentials.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import 'app.dart';
import 'user.dart';

/// An enum containing all authentication providers. These have to be enabled manually for the application before they can be used.
/// [Authentication Providers Docs](https://docs.mongodb.com/realm/authentication/providers/)
/// [Authentication Providers Docs](https://www.mongodb.com/docs/atlas/app-services/authentication/#authentication-providers)
/// {@category Application}
enum AuthProviderType {
/// For authenticating without credentials.
Expand Down Expand Up @@ -61,7 +61,7 @@ class Credentials implements Finalizable {

/// Returns a [Credentials] object that can be used to authenticate an anonymous user.
/// Setting [reuseCredentials] to `false` will create a new anonymous user, upon [App.logIn].
/// [Anonymous Authentication Docs](https://docs.mongodb.com/realm/authentication/anonymous)
/// [Anonymous Authentication Docs](https://www.mongodb.com/docs/atlas/app-services/authentication/anonymous/#anonymous-authentication)
Credentials.anonymous({bool reuseCredentials = true}) : _handle = realmCore.createAppCredentialsAnonymous(reuseCredentials);

/// Returns a [Credentials] object that can be used to authenticate a user with a Google account using an id token.
Expand All @@ -70,11 +70,11 @@ class Credentials implements Finalizable {
/// Returns a [Credentials] object that can be used to authenticate a user with their email and password.
/// A user can login with email and password only after they have registered their account and verified their
/// email.
/// [Email/Password Authentication Docs](https://docs.mongodb.com/realm/authentication/email-password)
/// [Email/Password Authentication Docs](https://www.mongodb.com/docs/atlas/app-services/authentication/email-password/#email-password-authentication)
Credentials.emailPassword(String email, String password) : _handle = realmCore.createAppCredentialsEmailPassword(email, password);

/// Returns a [Credentials] object that can be used to authenticate a user with a custom JWT.
/// [Custom-JWT Authentication Docs](https://docs.mongodb.com/realm/authentication/custom-jwt)
/// [Custom-JWT Authentication Docs](https://www.mongodb.com/docs/atlas/app-services/authentication/custom-jwt/#custom-jwt-authentication)
Credentials.jwt(String token) : _handle = realmCore.createAppCredentialsJwt(token);

/// Returns a [Credentials] object that can be used to authenticate a user with a Facebook account.
Expand Down
4 changes: 2 additions & 2 deletions packages/realm_dart/lib/src/user.dart
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class User {

/// Gets an [ApiKeyClient] instance that exposes functionality for managing
/// user API keys.
/// [API Keys Authentication Docs](https://docs.mongodb.com/realm/authentication/api-key/)
/// [API Keys Authentication Docs](https://www.mongodb.com/docs/atlas/app-services/authentication/api-key/#api-key-authentication)
ApiKeyClient get apiKeys {
_ensureLoggedIn('access API keys');

Expand All @@ -50,7 +50,7 @@ class User {

/// Gets a [FunctionsClient] instance that exposes functionality for calling remote Atlas Functions.
/// A [FunctionsClient] instance scoped to this [User].
/// [Atlas Functions Docs](https://docs.mongodb.com/realm/functions/)
/// [Atlas Functions Docs](hhttps://www.mongodb.com/docs/atlas/app-services/functions/#atlas-functions)
FunctionsClient get functions {
_ensureLoggedIn('access API keys');

Expand Down

0 comments on commit f22f129

Please sign in to comment.