2 |
66 |
--------------------------------------------------------------------------------
/codelabs/codelab-friendlychat-web/steps/src/app/pages/chat-page/chat-page.component.spec.ts:
--------------------------------------------------------------------------------
1 | import { ComponentFixture, TestBed } from '@angular/core/testing';
2 |
3 | import { ChatPageComponent } from './chat-page.component';
4 |
5 | describe('ChatPageComponent', () => {
6 | let component: ChatPageComponent;
7 | let fixture: ComponentFixture
3 | @for (message of (messages$ | async); track message) {
4 |
49 |
5 |
47 | }
48 |
6 | @if (user$ | async; as user) {
7 |
46 |
8 | ![]()
10 |
44 | }
45 |
11 |
42 |
43 |
12 | @if (message['text'] && message['text'].length > 0){
13 |
28 |
29 | @if (message['response'] && message['response'].length > 0){
30 |
14 | {{message['text']}}
15 |
16 | }
17 | @if (message['imageUrl'] && message['imageUrl'].length > 0) {
18 |
19 | ![image]()
20 |
21 | }
22 |
23 |
24 | {{message['timestamp'].toDate().toLocaleTimeString()}}
25 |
26 |
27 |
31 |
40 | }
41 |
32 | {{message['response']}}
33 |
34 |
35 |
36 | ✨ ai generated
37 |
38 |
39 |
50 |
65 |
51 |
52 |
64 |
53 |
56 |
57 |
60 |
63 |
2 |
--------------------------------------------------------------------------------
/codelabs/codelab-friendlychat-web/steps/src/app/pages/login-page/login-page.component.spec.ts:
--------------------------------------------------------------------------------
1 | import { ComponentFixture, TestBed } from '@angular/core/testing';
2 |
3 | import { LoginPageComponent } from './login-page.component';
4 |
5 | describe('LoginPageComponent', () => {
6 | let component: LoginPageComponent;
7 | let fixture: ComponentFixture
3 | 
4 |
5 |
4 |
6 |
15 |
7 | 
8 | Friendly Chat
9 |
10 |
14 |
8 | Friendly Chat
9 | Firebase App Check Debug Token: 58 | 123a4567-b89c-12d3-e456-78901234567859 | 60 | {# Google-internal common file: #} 61 | <<../_includes/manage-debug-tokens.md>> 62 | 63 | After you register the token, Firebase backend services will accept it as valid. 64 | 65 | Because this token allows access to your Firebase resources without a 66 | valid device, it is crucial that you keep it private. Don't commit it to a 67 | public repository, and if a registered token is ever compromised, revoke it 68 | immediately in the Firebase console. 69 | 70 | ## Android 71 | 72 | To use the debug provider while running your Flutter app in an Android environment, 73 | implement the following code in your Flutter application: 74 | 75 | ```dart 76 | import 'package:flutter/material.dart'; 77 | import 'package:firebase_core/firebase_core.dart'; 78 | 79 | // Import the firebase_app_check plugin 80 | import 'package:firebase_app_check/firebase_app_check.dart'; 81 | 82 | Future
D DebugAppCheckProvider: Enter this debug secret into the allow list in 99 | the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678100 | 101 | {# Google-internal common file: #} 102 | <<../_includes/manage-debug-tokens.md>> 103 | 104 | After you register the token, Firebase backend services will accept it as valid. 105 | 106 | ## Web 107 | 108 | To use the debug provider while running your app from `localhost` (during 109 | development, for example), do the following: 110 | 111 | Warning: _Do not_ try to enable `localhost` debugging by adding `localhost` to 112 | reCAPTCHA’s allowed domains. Doing so would allow anyone to run your app from 113 | their local machines! 114 | 115 | 1. In the file `web/index.html`, enable debug mode by setting 116 | `self.FIREBASE_APPCHECK_DEBUG_TOKEN` to `true`: 117 | 118 | ```html 119 | 120 | 123 | 124 | ... 125 | 126 | 127 | ``` 128 | 129 | 1. Run your web app locally and open the browser’s developer tool. In the 130 | debug console, you’ll see a debug token: 131 | 132 |
AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678". You will 133 | need to safelist it in the Firebase console for it to work.134 | 135 | This token is stored locally in your browser and will be used whenever you 136 | use your app in the same browser on the same machine. If you want to use the 137 | token in another browser or on another machine, set 138 | `self.FIREBASE_APPCHECK_DEBUG_TOKEN` to the token string instead of `true`. 139 | 140 | {# Google-internal common file: #} 141 | <<../_includes/manage-debug-tokens.md>> 142 | 143 | After you register the token, Firebase backend services will accept it as valid. 144 | 145 | Because this token allows access to your Firebase resources without a 146 | valid device, it is crucial that you keep it private. Don't commit it to a 147 | public repository, and if a registered token is ever compromised, revoke it 148 | immediately in the Firebase console. 149 | -------------------------------------------------------------------------------- /docs/flutter/app-check/default-providers.md: -------------------------------------------------------------------------------- 1 | Project: /docs/_project.yaml 2 | Book: /docs/_book.yaml 3 | 4 | 5 | 6 | # Get started using App Check in Flutter apps 7 | 8 | This page shows you how to enable App Check in a Flutter app, using the 9 | default providers: Play Integrity on Android, Device Check on Apple platforms, and 10 | reCAPTCHA v3 on web. When you enable App Check, you help ensure that 11 | only your app can access your project's Firebase resources. See an 12 | [Overview](/docs/app-check) of this feature. 13 | 14 | 15 | ## 1. Set up your Firebase project {:#project-setup} 16 | 17 | 1. [Install and initialize FlutterFire](/docs/flutter/setup) if you haven't 18 | already done so. 19 | 20 | 1. Register your apps to use App Check with the Play Integrity, Device Check, and reCAPTCHA providers in the 21 | [**Project Settings > App Check**](https://console.firebase.google.com/project/_/appcheck) 22 | section of the Firebase console. 23 | 24 | You usually need to register all of your project's apps, because once you 25 | enable enforcement for a Firebase product, only registered apps will be able 26 | to access the product's backend resources. 27 | 28 | 1. **Optional**: In the app registration settings, set a custom time-to-live 29 | (TTL) for App Check tokens issued by the provider. You can set the TTL 30 | to any value between 30 minutes and 7 days. When changing this value, be 31 | aware of the following tradeoffs: 32 | 33 | - Security: Shorter TTLs provide stronger security, because it reduces the 34 | window in which a leaked or intercepted token can be abused by an 35 | attacker. 36 | - Performance: Shorter TTLs mean your app will perform attestation more 37 | frequently. Because the app attestation process adds latency to network 38 | requests every time it's performed, a short TTL can impact the performance 39 | of your app. 40 | - Quota and cost: Shorter TTLs and frequent re-attestation deplete your 41 | quota faster, and for paid services, potentially cost more. 42 | See [Quotas & limits](/docs/app-check#quotas_limits). 43 | 44 | The default TTL 45 | is reasonable for most apps. Note that the App Check library refreshes 46 | tokens at approximately half the TTL duration. 47 | 48 | 49 | ## 2. Add the App Check library to your app {:#install-sdk} 50 | 51 | 1. From the root of your Flutter project, run the following command to install the plugin: 52 | 53 | ```bash 54 | flutter pub add firebase_app_check 55 | ``` 56 | 57 | 1. Once complete, rebuild your Flutter application: 58 | 59 | ```bash 60 | flutter run 61 | ``` 62 | 63 | 64 | ## 3. Initialize App Check {:#initialize} 65 | 66 | Add the following initialization code to your app so that it runs before you 67 | use any Firebase services such as Storage, but after calling 68 | `Firebase.initializeApp()`; 69 | 70 | ```dart 71 | import 'package:flutter/material.dart'; 72 | import 'package:firebase_core/firebase_core.dart'; 73 | 74 | // Import the firebase_app_check plugin 75 | import 'package:firebase_app_check/firebase_app_check.dart'; 76 | 77 | Future
flutter pub add firebase_analytics 13 |14 | 15 | 1. Make sure that your Flutter app's Firebase configuration is up-to-date by 16 | running the following command from the root directory of your Flutter 17 | project: 18 | 19 |
flutterfire configure 21 |22 | 23 | 1. Once complete, rebuild your Flutter application: 24 | 25 |
flutter run 27 |28 | 29 | Your Flutter project is now set up to use {{firebase_analytics}}. 30 | -------------------------------------------------------------------------------- /docs/flutter/database/_usecase_security_preamble.md: -------------------------------------------------------------------------------- 1 | Note: By default, read and write access to your database is restricted so only 2 | authenticated users can read or write data. To get started without setting up 3 | Firebase Authentication, you can [configure your rules for public access](/docs/rules/basics#default_rules_locked_mode). 4 | This does make your database open to anyone, even people not using your app, so 5 | be sure to restrict your database again when you set up authentication. 6 | -------------------------------------------------------------------------------- /docs/flutter/database/start.md: -------------------------------------------------------------------------------- 1 | Project: /docs/database/_project.yaml 2 | Book: /docs/_book.yaml 3 | page_type: guide 4 | 5 | 6 | 7 | # Get Started with Realtime Database 8 | 9 | ## Prerequisites 10 | 11 | 1. [Install `firebase_core`](/docs/flutter/setup) and add the initialization code 12 | to your app if you haven't already. 13 | 1. Add your app to your Firebase project in the Firebase console. 14 | 15 | ## Create a Database 16 | 17 | {# TODO(markarndt): Decide whether to include common files instead. #} 18 | 19 | 1. Navigate to the **Realtime Database** section of the Firebase console. 20 | You'll be prompted to select an existing Firebase project. 21 | Follow the database creation workflow. 22 | 23 | 1. Select a starting mode for your security rules: 24 | 25 | **Test mode** 26 | 27 | Good for getting started with the mobile and web client libraries, 28 | but allows anyone to read and overwrite your data. After testing, **make 29 | sure to review the [Understand Firebase Realtime Database Rules](/docs/database/security/) 30 | section.** 31 | 32 | Note: If you create a database in Test mode and make no changes to the 33 | default world-readable and world-writeable security rules within a trial 34 | period, you will be alerted by email, then your database rules will 35 | deny all requests. Note the expiration date during the Firebase console 36 | setup flow. 37 | 38 | 39 | To get started, select testmode. 40 | 41 | **Locked mode** 42 | 43 | Denies all reads and writes from mobile and web clients. 44 | Your authenticated application servers can still access your database. 45 | 46 | 1. Choose a region for the database. Depending on your choice of region, 47 | the database namespace will be of the form `
Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
105 | * Logging network request trace: URL
106 |
107 | 1. Click on the URL to view your data in the Firebase console. It may take a few
108 | moments for the data to update in the dashboard.
109 |
110 | ## **Step 4**: _(Optional)_ Add custom monitoring for specific code {:#add-custom-trace}
111 |
112 | To monitor performance data associated with specific code in your app, you can
113 | instrument [**custom code traces**](/docs/perf-mon/custom-code-traces?platform=flutter).
114 |
115 | With a custom code trace, you can measure how long it takes your app to complete
116 | a specific task or set of tasks, such as loading a set of images or querying
117 | your database. The default metric for a custom code trace is its duration, but
118 | you can also add custom metrics, such as cache hits and memory warnings.
119 |
120 | In your code, you define the beginning and the end of a custom code trace (and
121 | add any desired custom metrics) using the API provided by the Performance Monitoring SDK.
122 |
123 | Visit [Add monitoring for specific code](/docs/perf-mon/custom-code-traces?platform=flutter)
124 | to learn more about these features and how to add them to your app.
125 |
126 | ## **Step 5**: Deploy your app then review results {:#deploy-then-review-results}
127 |
128 | After you've validated Performance Monitoring using the an emulator and one or more
129 | test devices, you can deploy the updated version of your app to your users.
130 |
131 | You can monitor performance data in the
132 | [_Performance_ dashboard](//console.firebase.google.com/project/_/performance)
133 | of the Firebase console.
134 |
135 |
136 | ## Next steps
137 |
138 | * Learn more about data automatically collected by Performance Monitoring:
139 |
140 | * Data related to your app's lifecycle, like
141 | [app start time](/docs/perf-mon/app-start-foreground-background-traces)
142 | * Data for [HTTP/S network requests](/docs/perf-mon/network-traces) issued
143 | by your app
144 |
145 | * [View, track, and filter](/docs/perf-mon/console) your
146 | performance data in the Firebase console.
147 |
148 | * Add monitoring for specific tasks or workflows in your app by
149 | [instrumenting custom code traces](/docs/perf-mon/custom-code-traces?platform=flutter).
150 |
151 | * [Use attributes to filter performance data](/docs/perf-mon/attributes).
152 |
--------------------------------------------------------------------------------
/docs/flutter/reference/_toc.yaml:
--------------------------------------------------------------------------------
1 | toc:
2 | - title: cloud_firestore
3 | path: https://pub.dev/documentation/cloud_firestore/latest/
4 | status: external
5 | - title: cloud_firestore_web
6 | path: https://pub.dev/documentation/cloud_firestore_web/latest/
7 | status: external
8 | - title: cloud_functions
9 | path: https://pub.dev/documentation/cloud_functions/latest/
10 | status: external
11 | - title: cloud_functions_web
12 | path: https://pub.dev/documentation/cloud_functions_web/latest/
13 | status: external
14 | - title: firebase_analytics
15 | path: https://pub.dev/documentation/firebase_analytics/latest/
16 | status: external
17 | - title: firebase_analytics_web
18 | path: https://pub.dev/documentation/firebase_analytics_web/latest/
19 | status: external
20 | - title: firebase_app_check
21 | path: https://pub.dev/documentation/firebase_app_check/latest/
22 | status: external
23 | - title: firebase_app_installations
24 | path: https://pub.dev/documentation/firebase_app_installations/latest/
25 | status: external
26 | - title: firebase_auth
27 | path: https://pub.dev/documentation/firebase_auth/latest/
28 | status: external
29 | - title: firebase_auth_web
30 | path: https://pub.dev/documentation/firebase_auth_web/latest/
31 | status: external
32 | - title: firebase_core
33 | path: https://pub.dev/documentation/firebase_core/latest/
34 | status: external
35 | - title: firebase_core_web
36 | path: https://pub.dev/documentation/firebase_core_web/latest/
37 | status: external
38 | - title: firebase_crashlytics
39 | path: https://pub.dev/documentation/firebase_crashlytics/latest/
40 | status: external
41 | - title: firebase_database
42 | path: https://pub.dev/documentation/firebase_database/latest/
43 | status: external
44 | - title: firebase_dynamic_links
45 | path: https://pub.dev/documentation/firebase_dynamic_links/latest/
46 | status: external
47 | - title: firebase_in_app_messaging
48 | path: https://pub.dev/documentation/firebase_in_app_messaging/latest/
49 | status: external
50 | - title: firebase_messaging
51 | path: https://pub.dev/documentation/firebase_messaging/latest/
52 | status: external
53 | - title: firebase_messaging_web
54 | path: https://pub.dev/documentation/firebase_messaging_web/latest/
55 | status: external
56 | - title: firebase_ml_model_downloader
57 | path: https://pub.dev/documentation/firebase_ml_model_downloader/latest/
58 | status: external
59 | - title: firebase_performance
60 | path: https://pub.dev/documentation/firebase_performance/latest/
61 | status: external
62 | # - title: firebase_performance_platform_interface
63 | # path: https://pub.dev/documentation/firebase_performance_platform_interface/latest/
64 | # status: external
65 | - title: firebase_performance_web
66 | path: https://pub.dev/documentation/firebase_performance_web/latest/
67 | status: external
68 | - title: firebase_remote_config
69 | path: https://pub.dev/documentation/firebase_remote_config/latest/
70 | status: external
71 | - title: firebase_storage
72 | path: https://pub.dev/documentation/firebase_storage/latest/
73 | status: external
74 | - title: firebase_storage_web
75 | path: https://pub.dev/documentation/firebase_storage_web/latest/
76 | status: external
77 | - title: flutterfire_ui
78 | path: https://pub.dev/documentation/flutterfire_ui/latest/
79 | status: external
80 |
--------------------------------------------------------------------------------
/docs/flutter/setup/_setup_prereq_android.md:
--------------------------------------------------------------------------------
1 | {# This content gets published to the following location: #}
2 | {# https://firebase.google.com/docs/flutter/setup #}
3 |
4 | * Install your preferred [editor or IDE](//docs.flutter.dev/get-started/editor/).
5 |
6 | * Set up a device or emulator for running your app.
7 | [Emulators](https://developer.android.com/studio/run/managing-avds){: .external}
8 | must use an emulator image with Google Play.
9 |
10 | * Make sure that your app meets the following requirements:
11 |
12 | * Targets API level {{android_min_api_level}} ({{android_min_api_codename}})
13 | or higher
14 | * Uses Android {{android_min_version}} or higher
15 |
16 | * [Install Flutter](//docs.flutter.dev/get-started/install/) for your specific
17 | operating system, including the following:
18 |
19 | * Flutter SDK
20 | * Supporting libraries
21 | * Platform-specific software and SDKs
22 |
23 | * [Sign into Firebase]({{name_appmanagerURL}}){: .external} using your Google
24 | account.
25 |
26 | If you don't already have a Flutter app, you can complete the [Get
27 | Started: Test Drive](//docs.flutter.dev/get-started/test-drive#androidstudio) to
28 | create a new Flutter app using your preferred editor or IDE.
29 |
--------------------------------------------------------------------------------
/docs/flutter/setup/_setup_prereq_ios.md:
--------------------------------------------------------------------------------
1 | {# This content gets published to the following location: #}
2 | {# https://firebase.google.com/docs/flutter/setup #}
3 |
4 | * Install your preferred [editor or IDE](//docs.flutter.dev/get-started/editor/).
5 |
6 | * Set up a physical Apple device or use a simulator to run your app.
7 |
8 | {# Google-internal file; not on GitHub. #}
9 | <<../../../_internal/includes/docs/guides/_setup-ios_prereq_want-to-use-fcm.md>>
10 |
11 | * Make sure that your Flutter app targets the following platform versions or
12 | later:
13 | * iOS {{min_ios_os_version}}
14 | * macOS {{min_mac_os_version}}
15 |
16 | * [Install Flutter](//docs.flutter.dev/get-started/install/) for your specific
17 | operating system, including the following:
18 |
19 | * Flutter SDK
20 | * Supporting libraries
21 | * Platform-specific software and SDKs
22 |
23 | * [Sign into Firebase]({{name_appmanagerURL}}){: .external} using your Google
24 | account.
25 |
26 | If you don't already have a Flutter app, you can complete the [Get
27 | Started: Test Drive](//docs.flutter.dev/get-started/test-drive/#androidstudio) to
28 | create a new Flutter app using your preferred editor or IDE.
29 |
30 | Note: If you're targeting macOS or macOS Catalyst, you must add the [Keychain Sharing capability](https://firebase.google.com/docs/ios/troubleshooting-faq#macos-keychain-sharing) to your target. In Xcode, navigate to your target's *Signing & Capabilities* tab, and then click **+ Capabilities** to add a new capability.
31 |
--------------------------------------------------------------------------------
/docs/flutter/setup/_setup_prereq_web.md:
--------------------------------------------------------------------------------
1 | {# This content gets published to the following location: #}
2 | {# https://firebase.google.com/docs/flutter/setup #}
3 |
4 | * Install your preferred [editor or IDE](//docs.flutter.dev/get-started/editor/).
5 |
6 | * [Install Flutter](//docs.flutter.dev/get-started/install/) for your specific
7 | operating system, including the following:
8 |
9 | * Flutter SDK
10 | * Supporting libraries
11 | * Platform-specific software and SDKs
12 |
13 | * [Sign into Firebase]({{name_appmanagerURL}}){: .external} using your Google
14 | account.
15 |
16 | If you don't already have a Flutter app, you can complete the [Get
17 | Started: Test Drive](//docs.flutter.dev/get-started/test-drive?tab=vscode) to
18 | create a new Flutter app using your preferred editor or IDE.
19 |
--------------------------------------------------------------------------------
/docs/flutter/storage/create-reference.md:
--------------------------------------------------------------------------------
1 | Project: /docs/storage/_project.yaml
2 | Book: /docs/_book.yaml
3 | page_type: guide
4 |
5 |
6 |
7 | # Create a Cloud Storage reference on Flutter
8 |
9 | Your files are stored in a
10 | [Cloud Storage](//cloud.google.com/storage) bucket. The
11 | files in this bucket are presented in a hierarchical structure, just like the
12 | file system on your local hard disk, or the data in the Firebase Realtime Database.
13 | By creating a reference to a file, your app gains access to it. These references
14 | can then be used to upload or download data, get or update metadata or delete
15 | the file. A reference can either point to a specific file or to a higher level
16 | node in the hierarchy.
17 |
18 | If you've used the [Firebase Realtime Database](/docs/database), these paths should
19 | seem very familiar to you. However, your file data is stored in
20 | Cloud Storage, **not** in the Realtime Database.
21 |
22 |
23 | ## Create a Reference
24 |
25 | Create a reference to upload, download, or delete a file,
26 | or to get or update its metadata. A reference
27 | can be thought of as a pointer to a file in the cloud. References are
28 | lightweight, so you can create as many as you need. They are also reusable for
29 | multiple operations.
30 |
31 | Create a reference using the `FirebaseStorage` singleton instance and
32 | calling its `ref()` method.
33 |
34 | ```dart
35 | final storageRef = FirebaseStorage.instance.ref();
36 | ```
37 |
38 | Next, you can create a reference to a location lower in the tree,
39 | say `"images/space.jpg"` by using the `child()` method on an existing reference.
40 |
41 | ```dart
42 | // Create a child reference
43 | // imagesRef now points to "images"
44 | final imagesRef = storageRef.child("images");
45 |
46 | // Child references can also take paths
47 | // spaceRef now points to "images/space.jpg
48 | // imagesRef still points to "images"
49 | final spaceRef = storageRef.child("images/space.jpg");
50 | ```
51 |
52 | ## Navigate with References
53 |
54 | You can also use the `parent` and `root` properties to navigate up in our
55 | file hierarchy. `parent` navigates up one level,
56 | while `root` navigates all the way to the top.
57 |
58 | ```dart
59 | // parent allows us to move our reference to a parent node
60 | // imagesRef2 now points to 'images'
61 | final imagesRef2 = spaceRef.parent;
62 |
63 | // root allows us to move all the way back to the top of our bucket
64 | // rootRef now points to the root
65 | final rootRef = spaceRef.root;
66 | ```
67 |
68 | `child()`, `parent`, and `root` can be chained together multiple
69 | times, as each is a reference. But accessing `root.parent` results in `null`.
70 |
71 | ```dart
72 | // References can be chained together multiple times
73 | // earthRef points to 'images/earth.jpg'
74 | final earthRef = spaceRef.parent?.child("earth.jpg");
75 |
76 | // nullRef is null, since the parent of root is null
77 | final nullRef = spaceRef.root.parent;
78 | ```
79 |
80 |
81 | ## Reference Properties
82 |
83 | You can inspect references to better understand the files they point to
84 | using the `fullPath`, `name`, and `bucket` properties. These properties
85 | get the file's full path, name and bucket.
86 |
87 | ```dart
88 | // Reference's path is: "images/space.jpg"
89 | // This is analogous to a file path on disk
90 | spaceRef.fullPath;
91 |
92 | // Reference's name is the last segment of the full path: "space.jpg"
93 | // This is analogous to the file name
94 | spaceRef.name;
95 |
96 | // Reference's bucket is the name of the storage bucket that the files are stored in
97 | spaceRef.bucket;
98 | ```
99 |
100 | ## Limitations on References
101 |
102 | Reference paths and names can contain any sequence of valid Unicode characters,
103 | but certain restrictions are imposed including:
104 |
105 | 1. Total length of reference.fullPath must be between 1 and 1024 bytes when UTF-8 encoded.
106 | 1. No Carriage Return or Line Feed characters.
107 | 1. Avoid using `#`, `[`, `]`, `*`, or `?`, as these do not work well with
108 | other tools such as the [Firebase Realtime Database](/docs/database/overview)
109 | or [gsutil](https://cloud.google.com/storage/docs/gsutil).
110 |
111 | ## Full Example
112 |
113 | ```dart
114 | // Points to the root reference
115 | final storageRef = FirebaseStorage.instance.ref();
116 |
117 | // Points to "images"
118 | Reference? imagesRef = storageRef.child("images");
119 |
120 | // Points to "images/space.jpg"
121 | // Note that you can use variables to create child values
122 | final fileName = "space.jpg";
123 | final spaceRef = imagesRef.child(fileName);
124 |
125 | // File path is "images/space.jpg"
126 | final path = spaceRef.fullPath;
127 |
128 | // File name is "space.jpg"
129 | final name = spaceRef.name;
130 |
131 | // Points to "images"
132 | imagesRef = spaceRef.parent;
133 | ```
134 |
135 | Next, let's learn how to [upload files](upload-files) to Cloud Storage.
136 |
--------------------------------------------------------------------------------
/docs/flutter/storage/delete-files.md:
--------------------------------------------------------------------------------
1 | Project: /docs/storage/_project.yaml
2 | Book: /docs/_book.yaml
3 | page_type: guide
4 |
5 |
6 |
7 | # Delete files with Cloud Storage on Flutter
8 |
9 | After uploading files to Cloud Storage, you can also delete them.
10 |
11 | Note: By default, a Cloud Storage bucket requires Firebase Authentication to
12 | perform any action on the bucket's data or files. You can
13 | [change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
14 | to allow unauthenticated access. Since Firebase and your project's default
15 | App Engine app share this bucket, configuring public access may make newly
16 | uploaded App Engine files publicly accessible, as well. Be sure to restrict
17 | access to your Cloud Storage bucket again when you set up Authentication.
18 |
19 |
20 | ## Delete a File
21 |
22 | To delete a file, first [create a reference](create-reference)
23 | to that file. Then call the `delete()` method on that reference.
24 |
25 | ```dart
26 | // Create a reference to the file to delete
27 | final desertRef = storageRef.child("images/desert.jpg");
28 |
29 | // Delete the file
30 | await desertRef.delete();
31 | ```
32 |
33 | Warning: Deleting a file is a permanent action! If you care about restoring
34 | deleted files, make sure to back up your files, or
35 | [enable Object Versioning](https://cloud.google.com/storage/docs/using-object-versioning#set)
36 | on your Cloud Storage bucket.
37 |
38 |
39 | ## Handle Errors
40 |
41 | There are a number of reasons why errors may occur on file deletes,
42 | including the file not existing, or the user not having permission
43 | to delete the desired file. More information on errors can be found in the
44 | [Handle Errors](handle-errors) section of the docs.
45 |
--------------------------------------------------------------------------------
/docs/flutter/storage/download-files.md:
--------------------------------------------------------------------------------
1 | Project: /docs/storage/_project.yaml
2 | Book: /docs/_book.yaml
3 | page_type: guide
4 |
5 |
6 |
7 | # Download files with Cloud Storage on Flutter
8 |
9 | Cloud Storage for Firebase allows you to quickly and easily download
10 | files from a [Cloud Storage](//cloud.google.com/storage)
11 | bucket provided and managed by Firebase.
12 |
13 | Note: By default, a Cloud Storage bucket requires Firebase Authentication to
14 | perform any action on the bucket's data or files. You can
15 | [change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
16 | to allow unauthenticated access. Since Firebase and your project's default
17 | App Engine app share this bucket, configuring public access may make newly
18 | uploaded App Engine files publicly accessible, as well. Be sure to restrict
19 | access to your Cloud Storage bucket again when you set up Authentication.
20 |
21 |
22 |
23 | ## Create a Reference
24 |
25 | To download a file, first [create a Cloud Storage reference](create-reference)
26 | to the file you want to download.
27 |
28 | You can create a reference by appending child paths to the root of your
29 | Cloud Storage bucket, or you can create a reference from an existing
30 | `gs://` or `https://` URL referencing an object in Cloud Storage.
31 |
32 | ```dart
33 | // Create a storage reference from our app
34 | final storageRef = FirebaseStorage.instance.ref();
35 |
36 | // Create a reference with an initial file path and name
37 | final pathReference = storageRef.child("images/stars.jpg");
38 |
39 | // Create a reference to a file from a Google Cloud Storage URI
40 | final gsReference =
41 | FirebaseStorage.instance.refFromURL("gs://YOUR_BUCKET/images/stars.jpg");
42 |
43 | // Create a reference from an HTTPS URL
44 | // Note that in the URL, characters are URL escaped!
45 | final httpsReference = FirebaseStorage.instance.refFromURL(
46 | "https://firebasestorage.googleapis.com/b/YOUR_BUCKET/o/images%20stars.jpg");
47 | ```
48 |
49 |
50 | ## Download Files
51 |
52 | Once you have a reference, you can download files from Cloud Storage
53 | by calling the `getData()` or `getStream()`. If you prefer to download the file
54 | with another library, you can get a download URL with `getDownloadUrl()`.
55 |
56 | ### Download in memory
57 |
58 | Download the file to a `UInt8List` with the `getData()` method. This is the
59 | easiest way to download a file, but it must load the entire contents of
60 | your file into memory. If you request a file larger than your app's available
61 | memory, your app will crash. To protect against memory issues, `getData()`
62 | takes a maximum amount of bytes to download. Set the maximum size to something
63 | you know your app can handle, or use another download method.
64 |
65 | ```dart
66 | final islandRef = storageRef.child("images/island.jpg");
67 |
68 | try {
69 | const oneMegabyte = 1024 * 1024;
70 | final Uint8List? data = await islandRef.getData(oneMegabyte);
71 | // Data for "images/island.jpg" is returned, use this as needed.
72 | } on FirebaseException catch (e) {
73 | // Handle any errors.
74 | }
75 | ```
76 |
77 | ### Download to a local file
78 |
79 | The `writeToFile()` method downloads a file directly to a local device. Use this if
80 | your users want to have access to the file while offline or to share the file in a
81 | different app. `writeToFile()` returns a `DownloadTask` which you can use to manage
82 | your download and monitor the status of the download.
83 |
84 | ```dart
85 | final islandRef = storageRef.child("images/island.jpg");
86 |
87 | final appDocDir = await getApplicationDocumentsDirectory();
88 | final filePath = "${appDocDir.absolute}/images/island.jpg";
89 | final file = File(filePath);
90 |
91 | final downloadTask = islandRef.writeToFile(file);
92 | downloadTask.snapshotEvents.listen((taskSnapshot) {
93 | switch (taskSnapshot.state) {
94 | case TaskState.running:
95 | // TODO: Handle this case.
96 | break;
97 | case TaskState.paused:
98 | // TODO: Handle this case.
99 | break;
100 | case TaskState.success:
101 | // TODO: Handle this case.
102 | break;
103 | case TaskState.canceled:
104 | // TODO: Handle this case.
105 | break;
106 | case TaskState.error:
107 | // TODO: Handle this case.
108 | break;
109 | }
110 | });
111 | ```
112 |
113 | ## Download Data via URL
114 |
115 | If you already have download infrastructure based around URLs, or just want
116 | a URL to share, you can get the download URL for a file by calling the
117 | `getDownloadURL()` method on a Cloud Storage reference.
118 |
119 | ```dart
120 | final imageUrl =
121 | await storageRef.child("users/me/profile.png").getDownloadURL();
122 | ```
123 |
124 | ## Handle Errors
125 |
126 | There are a number of reasons why errors may occur on download, including the
127 | file not existing, or the user not having permission to access the desired file.
128 | More information on errors can be found in the [Handle Errors](handle-errors)
129 | section of the docs.
130 |
131 | ## Full Example
132 |
133 | A full example of a download with error handling is shown below:
134 |
135 | ```dart
136 | final islandRef = storageRef.child("images/island.jpg");
137 |
138 | final appDocDir = await getApplicationDocumentsDirectory();
139 | final filePath = "${appDocDir.absolute}/images/island.jpg";
140 | final file = File(filePath);
141 |
142 | final downloadTask = islandRef.writeToFile(file);
143 | downloadTask.snapshotEvents.listen((taskSnapshot) {
144 | switch (taskSnapshot.state) {
145 | case TaskState.running:
146 | // TODO: Handle this case.
147 | break;
148 | case TaskState.paused:
149 | // TODO: Handle this case.
150 | break;
151 | case TaskState.success:
152 | // TODO: Handle this case.
153 | break;
154 | case TaskState.canceled:
155 | // TODO: Handle this case.
156 | break;
157 | case TaskState.error:
158 | // TODO: Handle this case.
159 | break;
160 | }
161 | });
162 | ```
163 |
164 | You can also [get and update metadata](file-metadata) for files that are stored
165 | in Cloud Storage.
166 |
--------------------------------------------------------------------------------
/docs/flutter/storage/file-metadata.md:
--------------------------------------------------------------------------------
1 | Project: /docs/storage/_project.yaml
2 | Book: /docs/_book.yaml
3 | page_type: guide
4 |
5 |
6 |
7 | # Use file metadata with Cloud Storage on Flutter
8 |
9 | After uploading a file to Cloud Storage reference, you can also get
10 | and update the file metadata, for example to view or update the content type.
11 | Files can also store custom key/value pairs with additional file metadata.
12 |
13 | Note: By default, a Cloud Storage bucket requires Firebase Authentication to
14 | perform any action on the bucket's data or files. You can
15 | [change your Firebase Security Rules for Cloud Storage](/docs/storage/security/rules-conditions#public)
16 | to allow unauthenticated access. Since Firebase and your project's default
17 | App Engine app share this bucket, configuring public access may make newly
18 | uploaded App Engine files publicly accessible, as well. Be sure to restrict
19 | access to your Cloud Storage bucket again when you set up Authentication.
20 |
21 |
22 |
23 | ## Get File Metadata
24 |
25 | File metadata contains common properties such as `name`, `size`, and
26 | `contentType` (often referred to as MIME type) in addition to some less
27 | common ones like `contentDisposition` and `timeCreated`. This metadata can be
28 | retrieved from a Cloud Storage reference using
29 | the `getMetadata()` method.
30 |
31 | ```dart
32 | // Create reference to the file whose metadata we want to retrieve
33 | final forestRef = storageRef.child("images/forest.jpg");
34 |
35 | // Get metadata properties
36 | final metadata = await forestRef.getMetadata();
37 |
38 | // Metadata now contains the metadata for 'images/forest.jpg'
39 | ```
40 |
41 |
42 | ## Update File Metadata
43 |
44 | You can update file metadata at any time after the file upload completes by
45 | using the `updateMetadata()` method. Refer to the
46 | [full list](#file-metadata-properties) for more information on what properties
47 | can be updated. Only the properties specified in the metadata are updated,
48 | all others are left unmodified.
49 |
50 | ```dart
51 | // Create reference to the file whose metadata we want to change
52 | final forestRef = storageRef.child("images/forest.jpg");
53 |
54 | // Create file metadata to update
55 | final newMetadata = SettableMetadata(
56 | cacheControl: "public,max-age=300",
57 | contentType: "image/jpeg",
58 | );
59 |
60 | // Update metadata properties
61 | final metadata = await forestRef.updateMetadata(newMetadata);
62 |
63 | // Updated metadata for 'images/forest.jpg' is returned
64 | ```
65 |
66 | You can delete writable metadata properties by passing `null`:
67 |
68 | ```dart
69 | // Delete the cacheControl property
70 | final newMetadata = SettableMetadata(cacheControl: null);
71 | final metadata = await forestRef.updateMetadata(newMetadata);
72 | ```
73 |
74 |
75 | ## Handle Errors
76 |
77 | There are a number of reasons why errors may occur on getting or updating
78 | metadata, including the file not existing, or the user not having permission
79 | to access the desired file. More information on errors can be found in the
80 | [Handle Errors](handle-errors) section of the docs.
81 |
82 | ## Custom Metadata
83 |
84 | You can specify custom metadata using the `customMetadata` parameter of the
85 | `SettableMetadata` constructor:
86 |
87 | ```dart
88 | // Create reference to the file whose metadata we want to change
89 | final forestRef = storageRef.child("images/forest.jpg");
90 |
91 | // Create file metadata to update
92 | final newCustomMetadata = SettableMetadata(
93 | customMetadata: {
94 | "location": "Yosemite, CA, USA",
95 | "activity": "Hiking",
96 | },
97 | );
98 |
99 | // Update metadata properties
100 | final metadata = await forestRef.updateMetadata(newCustomMetadata);
101 |
102 | // Updated metadata for 'images/forest.jpg' is returned
103 | ```
104 |
105 | You can store app-specific data for each file in custom metadata, but we highly
106 | recommend using a database (such as the
107 | [Firebase Realtime Database](/docs/database/overview)) to store and synchronize this type of
108 | data.
109 |
110 |
111 | ## File Metadata Properties {:#file-metadata-properties}
112 |
113 | A full list of metadata properties on a file is available below:
114 |
115 | Property | Type | Settable?
116 | ---------------------|-----------------------|----------
117 | `bucket` | `String` | No
118 | `generation` | `String` | No
119 | `metageneration` | `String` | No
120 | `metadataGeneration` | `String` | No
121 | `fullPath` | `String` | No
122 | `name` | `String` | No
123 | `size` | `int` | No
124 | `timeCreated` | `DateTime` | No
125 | `updated` | `DateTime` | No
126 | `md5Hash` | `String` | No
127 | `cacheControl` | `String` | Yes
128 | `contentDisposition` | `String` | Yes
129 | `contentEncoding` | `String` | Yes
130 | `contentLanguage` | `String` | Yes
131 | `contentType` | `String` | Yes
132 | `customMetadata` | `Map