xref: /aosp_15_r20/developers/build/prebuilts/gradle/ScopedDirectoryAccess/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid ScopedDirectoryAccess Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates how to use the Scoped Directory Access API introduced in Android N
6*d353a188SXin Lito easily access to specific directories such as Pictures, Downloads instead of requesting
7*d353a188SXin LiREAD_EXTERNAL_STORAGE or WRITE_EXTERNAL_STORAGE in your manifest.
8*d353a188SXin Li
9*d353a188SXin LiIntroduction
10*d353a188SXin Li------------
11*d353a188SXin Li
12*d353a188SXin LiThis sample demonstrates how to use the Scoped Directory Access API that provides easy way to
13*d353a188SXin Liaccess specific directories instead of:
14*d353a188SXin Li - Requesting READ_EXTERNAL_STORAGE or WRITE_EXTERNAL_STORAGE in your manifest, which allows
15*d353a188SXin Li   access to all public directories on external storage.
16*d353a188SXin Li - Using the Storage Access Framework, where the user usually picks directories via a System UI,
17*d353a188SXin Li   which is unnecessary if you app always accesses to the same external directory.
18*d353a188SXin Li
19*d353a188SXin LiTo access to a specific directory, use a new Intent created using the StorageVolume class like
20*d353a188SXin Lifollowing:
21*d353a188SXin Li
22*d353a188SXin Li```
23*d353a188SXin LiStorageManager sm = getSystemService(StorageManager.class);
24*d353a188SXin LiStorageVolume volume = sm.getPrimaryVolume();
25*d353a188SXin LiIntent intent = volume.createAccessIntent(Environment.DIRECTORY_PICTURES);
26*d353a188SXin ListartActivityForResult(intent, request_code);
27*d353a188SXin Li```
28*d353a188SXin Li
29*d353a188SXin LiNote that the argument passed to StorageVolume.createAccessIntent needs to be one of the
30*d353a188SXin Livalues of Environment.DIRECTORY_\*.
31*d353a188SXin Li
32*d353a188SXin LiOnce the user grants the access, `onActivityResult` override will be called with a
33*d353a188SXin Liresult code of `Activity.RESULT_OK` and an intent data that contains the URI representing
34*d353a188SXin Lithe directory.
35*d353a188SXin Li
36*d353a188SXin LiPre-requisites
37*d353a188SXin Li--------------
38*d353a188SXin Li
39*d353a188SXin Li- Android SDK 24
40*d353a188SXin Li- Android Build Tools v27.0.2
41*d353a188SXin Li- Android Support Repository
42*d353a188SXin Li
43*d353a188SXin LiScreenshots
44*d353a188SXin Li-------------
45*d353a188SXin Li
46*d353a188SXin Li<img src="screenshots/1.png" height="400" alt="Screenshot"/> <img src="screenshots/2.png" height="400" alt="Screenshot"/> <img src="screenshots/3.png" height="400" alt="Screenshot"/>
47*d353a188SXin Li
48*d353a188SXin LiGetting Started
49*d353a188SXin Li---------------
50*d353a188SXin Li
51*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
52*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
53*d353a188SXin Li
54*d353a188SXin LiSupport
55*d353a188SXin Li-------
56*d353a188SXin Li
57*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
58*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
59*d353a188SXin Li
60*d353a188SXin LiIf you've found an error in this sample, please file an issue:
61*d353a188SXin Lihttps://github.com/googlesamples/android-ScopedDirectoryAccess
62*d353a188SXin Li
63*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
64*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
65*d353a188SXin Li
66*d353a188SXin LiLicense
67*d353a188SXin Li-------
68*d353a188SXin Li
69*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
70*d353a188SXin Li
71*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
72*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
73*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
74*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
75*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
76*d353a188SXin Lithe License at
77*d353a188SXin Li
78*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
79*d353a188SXin Li
80*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
81*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
82*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
83*d353a188SXin LiLicense for the specific language governing permissions and limitations under
84*d353a188SXin Lithe License.
85