From ece56dd095c7a337191e032cf4514e4589a05037 Mon Sep 17 00:00:00 2001 From: mbfakourii Date: Thu, 25 May 2023 20:06:42 +0430 Subject: [PATCH 1/2] fix flutter doc --- _config.yml | 2 +- _includes/flutter/getting-started.md | 6 +++--- _includes/flutter/queries.md | 2 +- assets/symbols.svg | 4 ++++ flutter-api.md | 2 +- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/_config.yml b/_config.yml index bf6834b4c..c9b4e6889 100644 --- a/_config.yml +++ b/_config.yml @@ -23,7 +23,7 @@ apis: js: https://parseplatform.org/Parse-SDK-JS/api/master/ php: https://parseplatform.org/parse-php-sdk/namespaces/Parse.html dotnet: https://parseplatform.org/Parse-SDK-dotNET/api/ - flutter: https://parseplatform.org/Parse-SDK-Flutter/api/ + flutter: flutter/api/ parse-server: https://parseplatform.org/parse-server/api/ # Build settings diff --git a/_includes/flutter/getting-started.md b/_includes/flutter/getting-started.md index 4d2c91bb5..25875cbb4 100644 --- a/_includes/flutter/getting-started.md +++ b/_includes/flutter/getting-started.md @@ -37,14 +37,14 @@ await Parse().initialize( ⚠️ The master key should only be used in safe environments and never on client side. Using this package on a server should be fine. -### Early Web Support +## Early Web Support Due to Cross-Origin Resource Sharing (CORS) restrictions, web support requires adding `X-Parse-Installation-Id` as an allowed header in the Parse Server configuration: - When running directly via docker, set the env var `PARSE_SERVER_ALLOW_HEADERS=X-Parse-Installation-Id`. - When running via express, set the [Parse Server option](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) `allowHeaders: ['X-Parse-Installation-Id']`. -### Desktop Support (macOS) +## Desktop Support (macOS) The security entitlements posed by the macOS framework require that your app is granted permission to open outgoing network connections, so that the Parse Flutter SDK can communicate with Parse Server. To grant this permission, add the following code: @@ -60,7 +60,7 @@ to the following files: /macOS/Runner/DebugProfile.entitlements ``` -### Network client +## Network client By default, this SDK uses the `ParseHTTPClient`. Another option is use `ParseDioClient`. This client supports the most features (for example a progress callback at the file upload), but a benchmark has shown that dio is slower than http on web. diff --git a/_includes/flutter/queries.md b/_includes/flutter/queries.md index abb672de6..455e9ad03 100644 --- a/_includes/flutter/queries.md +++ b/_includes/flutter/queries.md @@ -24,7 +24,7 @@ if (dietPlan.success) { } ``` -### Alternative Query Methods +## Alternative Query Methods The standard query method `query()` returns a `ParseResponse` that contains the result or the error. As an alternative, you can also use `Future> find()` for receiving options. This method returns an `Future` that either resolves in an error (equivalent to the error in the `ParseResponse`) or an `List` containing the queried objects. One difference, you should be aware of, is the fact that `Future> find()` will return an empty list instead of the `No results` error you receive in case no object matches your query. diff --git a/assets/symbols.svg b/assets/symbols.svg index 9535613b8..a2d107288 100755 --- a/assets/symbols.svg +++ b/assets/symbols.svg @@ -12,6 +12,10 @@ + + + + diff --git a/flutter-api.md b/flutter-api.md index 6450dc6b3..9ad648746 100644 --- a/flutter-api.md +++ b/flutter-api.md @@ -3,5 +3,5 @@ layout: redirected sitemap: false permalink: /flutter/api/ redirect_to: - - https://pub.dev/documentation/parse_server_sdk/latest/ + - https://pub.dev/documentation/parse_server_sdk_flutter/latest/ --- From 29c34dc48139b33f9a7a3d4a9f7c6b5e1d0b56f2 Mon Sep 17 00:00:00 2001 From: mbfakourii Date: Thu, 25 May 2023 20:20:08 +0430 Subject: [PATCH 2/2] fix php api --- _config.yml | 2 +- php-api.md | 2 +- php.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index c9b4e6889..447a8a36e 100644 --- a/_config.yml +++ b/_config.yml @@ -21,7 +21,7 @@ apis: osx: https://parseplatform.org/Parse-SDK-iOS-OSX/api/ android: https://parseplatform.org/Parse-SDK-Android/api/ js: https://parseplatform.org/Parse-SDK-JS/api/master/ - php: https://parseplatform.org/parse-php-sdk/namespaces/Parse.html + php: https://parseplatform.org/parse-php-sdk/ dotnet: https://parseplatform.org/Parse-SDK-dotNET/api/ flutter: flutter/api/ parse-server: https://parseplatform.org/parse-server/api/ diff --git a/php-api.md b/php-api.md index 5be755e45..2db59a224 100644 --- a/php-api.md +++ b/php-api.md @@ -3,5 +3,5 @@ layout: redirected sitemap: false permalink: /php/api/ redirect_to: - - https://parse-community.github.io/parse-php-sdk/namespaces/Parse.html + - https://parse-community.github.io/parse-php-sdk/ --- diff --git a/php.md b/php.md index ddb8ef135..acb65ce25 100644 --- a/php.md +++ b/php.md @@ -5,7 +5,7 @@ layout: guide platform: php language: php display_platform: PHP -api_reference: https://parse-community.github.io/parse-php-sdk/namespaces/Parse.html +api_reference: https://parse-community.github.io/parse-php-sdk/ sections: - "php/getting-started.md"