আপনার পছন্দের ভাষায় কন্টেন্ট অনুবাদ করতে Google তার AI প্রযুক্তি ব্যবহার করে। AI-এর মাধ্যমে করা অনুবাদে ভুল থাকতে পারে।

কাস্টম ডকুমেন্ট প্রোভাইডার তৈরি করুন

আপনি যদি এমন কোনও অ্যাপ ডেভেলপ করেন যা ফাইলের জন্য স্টোরেজ পরিষেবা প্রদান করে (যেমন ক্লাউড সেভ পরিষেবা), তাহলে আপনি কাস্টম ডকুমেন্ট প্রোভাইডার লিখে স্টোরেজ অ্যাক্সেস ফ্রেমওয়ার্ক (SAF)-এর মাধ্যমে আপনার ফাইল উপলভ্য করতে পারবেন। এই পৃষ্ঠায় কাস্টম ডকুমেন্ট প্রোভাইডার কীভাবে তৈরি করতে হয় তা বর্ণনা করা হয়েছে।

Storage Access Framework কীভাবে কাজ করে সেই সম্পর্কে আরও জানতে, Storage Access Framework ওভারভিউ দেখুন।

ম্যানিফেস্ট

কাস্টম ডকুমেন্ট প্রোভাইডার প্রয়োগ করতে, আপনার অ্যাপ্লিকেশনের ম্যানিফেস্টে নিম্নলিখিতগুলি যোগ করুন:

API লেভেল ১৯ বা তার পরবর্তী ভার্সনের টার্গেট।
একটি <provider> এলিমেন্ট যা আপনার কাস্টম স্টোরেজ প্রদানকারীকে ঘোষণা করে।
android:name অ্যাট্রিবিউট আপনার DocumentsProvider সাবক্লাসের নামে সেট করা হয়েছে, যা হল এর ক্লাস নেম, প্যাকেজের নাম সহ:
com.example.android.storageprovider.MyCloudProvider।
android:authority অ্যাট্রিবিউট, যা আপনার প্যাকেজের নাম (এই উদাহরণে, com.example.android.storageprovider) এবং কন্টেন্ট প্রোভাইডারের ধরন (documents)।
android:exported অ্যাট্রিবিউট "true"-এ সেট করা হয়েছে। অন্যান্য অ্যাপ যাতে এটি দেখতে পায় তার জন্য আপনাকে অবশ্যই আপনার প্রদানকারী এক্সপোর্ট করতে হবে।
android:grantUriPermissions অ্যাট্রিবিউট "true"-এ সেট করা হয়েছে। এই সেটিং সিস্টেমকে আপনার প্রদানকারীর কন্টেন্টে অন্যান্য অ্যাপকে অ্যাক্সেস দেওয়ার অনুমতি দেয়। এইসব অন্যান্য অ্যাপ কীভাবে আপনার প্রদানকারীর কন্টেন্টে অ্যাক্সেস চালিয়ে যেতে পারে সেই বিষয়ে আলোচনার জন্য, পারসিস্ট অনুমতি দেখুন।
MANAGE_DOCUMENTS অনুমতি। ডিফল্ট হিসেবে, একজন পরিষেবা প্রদানকারী সকলের জন্য উপলভ্য। এই অনুমতি যোগ করলে, আপনার প্রদানকারীকে সিস্টেমে সীমাবদ্ধ করে দেয়। নিরাপত্তার জন্য এই বিধিনিষেধ গুরুত্বপূর্ণ।
একটি ইনটেন্ট ফিল্টার যাতে android.content.action.DOCUMENTS_PROVIDER অ্যাকশন অন্তর্ভুক্ত থাকে, যাতে সিস্টেম প্রোভাইডার সার্চ করার সময় পিকারে আপনার প্রোভাইডার দেখা যায়।

এখানে একটি নমুনা ম্যানিফেস্ট থেকে উদ্ধৃতি দেওয়া হল যাতে একজন পরিষেবা প্রদানকারী অন্তর্ভুক্ত রয়েছে:

<manifest... >
    ...
    <uses-sdk
        android:minSdkVersion="19"
        android:targetSdkVersion="19" />
        ....
        <provider
            android:name="com.example.android.storageprovider.MyCloudProvider"
            android:authorities="com.example.android.storageprovider.documents"
            android:grantUriPermissions="true"
            android:exported="true"
            android:permission="android.permission.MANAGE_DOCUMENTS">
            <intent-filter>
                <action android:name="android.content.action.DOCUMENTS_PROVIDER" />
            </intent-filter>
        </provider>
    </application>

</manifest>

Android 4.3 এবং তার আগের যেকোনও ভার্সনে চলে এমন ডিভাইসে কাজ করে

ACTION_OPEN_DOCUMENT ইনটেন্ট শুধুমাত্র Android 4.4 ও তার পরবর্তী যেকোনও ভার্সনে চলে এমন ডিভাইসে উপলভ্য। আপনি যদি চান যে আপনার অ্যাপ্লিকেশন ACTION_GET_CONTENT-কে সমর্থন করুক যাতে Android 4.3 এবং তার নিচের ভার্সন চলছে এমন ডিভাইসগুলি ব্যবহার করা যায়, তাহলে আপনাকে Android 4.4 বা তার বেশি ভার্সন চলছে এমন ডিভাইসের জন্য আপনার ম্যানিফেস্টে ACTION_GET_CONTENT ইনটেন্ট ফিল্টার বন্ধ করতে হবে। ডকুমেন্ট প্রদানকারী এবং ACTION_GET_CONTENT-কে একে অপরের থেকে আলাদা হিসেবে বিবেচনা করা উচিত। আপনি যদি একই সাথে দুটিকেই সাপোর্ট করেন, তাহলে আপনার অ্যাপ সিস্টেম পিকার UI-তে দুবার দেখা যাবে, যা আপনার সেভ করা ডেটা অ্যাক্সেস করার দুটি ভিন্ন উপায় অফার করবে। এটি ব্যবহারকারীদের বিভ্রান্ত করে।

Android ভার্সন 4.4 বা তার পরবর্তী যেকোনও ভার্সনে রান করা ডিভাইসের জন্য ACTION_GET_CONTENT ইনটেন্ট ফিল্টার বন্ধ করার সাজেস্ট করা পদ্ধতি এখানে দেওয়া হল:

res/values/-এর অধীনে আপনার bool.xml রিসোর্স ফাইলে, এই লাইনটি যোগ করুন:
```
<bool name="atMostJellyBeanMR2">true</bool>
```
res/values-v19/-এর অধীনে আপনার bool.xml রিসোর্স ফাইলে, এই লাইনটি যোগ করুন:
```
<bool name="atMostJellyBeanMR2">false</bool>
```

4.4 (API লেভেল 19) এবং তার পরবর্তী ভার্সনের জন্য ACTION_GET_CONTENT ইনটেন্ট ফিল্টার বন্ধ করতে অ্যাক্টিভিটি অ্যালিয়াস যোগ করুন। যেমন:

<!-- This activity alias is added so that GET_CONTENT intent-filter
     can be disabled for builds on API level 19 and higher. -->
<activity-alias android:name="com.android.example.app.MyPicker"
        android:targetActivity="com.android.example.app.MyActivity"
        ...
        android:enabled="@bool/atMostJellyBeanMR2">
    <intent-filter>
        <action android:name="android.intent.action.GET_CONTENT" />
        <category android:name="android.intent.category.OPENABLE" />
        <category android:name="android.intent.category.DEFAULT" />
        <data android:mimeType="image/*" />
        <data android:mimeType="video/*" />
    </intent-filter>
</activity-alias>

চুক্তি

সাধারণত, আপনি যখন কোনও কাস্টম কন্টেন্ট প্রোভাইডার লেখেন, তখন অন্যতম একটি কাজ হল কনট্র্যাক্ট ক্লাস প্রয়োগ করা, যেমনটি কন্টেন্ট প্রোভাইডার ডেভেলপার নির্দেশিকায় বর্ণনা করা হয়েছে। কনট্র্যাক্ট ক্লাস হল একটি public final ক্লাস যেটিতে URI, কলামের নাম, MIME-এর প্রকার এবং প্রোভাইডারের সাথে সম্পর্কিত অন্যান্য মেটাডেটার জন্য কনস্ট্যান্ট সংজ্ঞা থাকে। SAF আপনার জন্য এইসব কনট্র্যাক্ট ক্লাস প্রদান করে, তাই আপনাকে নিজের কনট্র্যাক্ট ক্লাস লিখতে হয় না:

যেমন, আপনার ডকুমেন্ট প্রদানকারীকে ডকুমেন্ট বা রুটের জন্য কোয়েরি করা হলে, আপনি কার্সরে যেসব কলাম ফেরত দিতে পারেন সেগুলি এখানে দেওয়া হল:

Kotlin

private val DEFAULT_ROOT_PROJECTION: Array<String> = arrayOf(
        DocumentsContract.Root.COLUMN_ROOT_ID,
        DocumentsContract.Root.COLUMN_MIME_TYPES,
        DocumentsContract.Root.COLUMN_FLAGS,
        DocumentsContract.Root.COLUMN_ICON,
        DocumentsContract.Root.COLUMN_TITLE,
        DocumentsContract.Root.COLUMN_SUMMARY,
        DocumentsContract.Root.COLUMN_DOCUMENT_ID,
        DocumentsContract.Root.COLUMN_AVAILABLE_BYTES
)
private val DEFAULT_DOCUMENT_PROJECTION: Array<String> = arrayOf(
        DocumentsContract.Document.COLUMN_DOCUMENT_ID,
        DocumentsContract.Document.COLUMN_MIME_TYPE,
        DocumentsContract.Document.COLUMN_DISPLAY_NAME,
        DocumentsContract.Document.COLUMN_LAST_MODIFIED,
        DocumentsContract.Document.COLUMN_FLAGS,
        DocumentsContract.Document.COLUMN_SIZE
)

জাভা

private static final String[] DEFAULT_ROOT_PROJECTION =
        new String[]{Root.COLUMN_ROOT_ID, Root.COLUMN_MIME_TYPES,
        Root.COLUMN_FLAGS, Root.COLUMN_ICON, Root.COLUMN_TITLE,
        Root.COLUMN_SUMMARY, Root.COLUMN_DOCUMENT_ID,
        Root.COLUMN_AVAILABLE_BYTES,};
private static final String[] DEFAULT_DOCUMENT_PROJECTION = new
        String[]{Document.COLUMN_DOCUMENT_ID, Document.COLUMN_MIME_TYPE,
        Document.COLUMN_DISPLAY_NAME, Document.COLUMN_LAST_MODIFIED,
        Document.COLUMN_FLAGS, Document.COLUMN_SIZE,};

রুটের জন্য আপনার কার্সারে নির্দিষ্ট কিছু প্রয়োজনীয় কলাম অন্তর্ভুক্ত করতে হবে। এই কলামগুলি হল:

ডকুমেন্টের কার্সারে নিম্নলিখিত প্রয়োজনীয় কলামগুলি অন্তর্ভুক্ত করতে হবে:

DocumentsProvider-এর সাবক্লাস তৈরি করুন

কাস্টম ডকুমেন্ট প্রোভাইডার লেখার পরবর্তী ধাপ হল অ্যাবস্ট্রাক্ট ক্লাস DocumentsProvider-এর সাবক্লাস তৈরি করা। কমপক্ষে, আপনাকে নিম্নলিখিত পদ্ধতিগুলি প্রয়োগ করতে হবে:

আপনাকে শুধুমাত্র এইসব পদ্ধতিই প্রয়োগ করতে হবে, তবে আপনি চাইলে আরও অনেক পদ্ধতি প্রয়োগ করতে পারেন। আরও বিবরণের জন্য DocumentsProvider দেখুন।

রুট নির্দিষ্ট করুন

queryRoots()-এর আপনার ইমপ্লিমেন্টেশনে Cursor রিটার্ন করতে হবে যা আপনার ডকুমেন্ট প্রদানকারীর সব রুট ডিরেক্টরিকে পয়েন্ট করে, DocumentsContract.Root-এ উল্লেখ করা কলাম ব্যবহার করে।

নিম্নলিখিত স্নিপেটে, projection প্যারামিটারটি সেই নির্দিষ্ট ফিল্ডকে দেখায় যেটি কলার ফেরত পেতে চায়। স্ন্যাপশটটি একটি নতুন কার্সর তৈরি করে এবং এতে একটি সারি যোগ করে—একটি রুট, একটি টপ লেভেল ডিরেক্টরি, যেমন ডাউনলোড বা ছবি। অধিকাংশ পরিষেবা প্রদানকারীর একটিই রুট থাকে। আপনার কাছে একাধিক থাকতে পারে, যেমন, একাধিক ব্যবহারকারীর অ্যাকাউন্টের ক্ষেত্রে। সেক্ষেত্রে, কার্সারে শুধু একটি দ্বিতীয় সারি যোগ করুন।

Kotlin

override fun queryRoots(projection: Array<out String>?): Cursor {
    // Use a MatrixCursor to build a cursor
    // with either the requested fields, or the default
    // projection if "projection" is null.
    val result = MatrixCursor(resolveRootProjection(projection))

    // If user is not logged in, return an empty root cursor.  This removes our
    // provider from the list entirely.
    if (!isUserLoggedIn()) {
        return result
    }

    // It's possible to have multiple roots (e.g. for multiple accounts in the
    // same app) -- just add multiple cursor rows.
    result.newRow().apply {
        add(DocumentsContract.Root.COLUMN_ROOT_ID, ROOT)

        // You can provide an optional summary, which helps distinguish roots
        // with the same title. You can also use this field for displaying an
        // user account name.
        add(DocumentsContract.Root.COLUMN_SUMMARY, context.getString(R.string.root_summary))

        // FLAG_SUPPORTS_CREATE means at least one directory under the root supports
        // creating documents. FLAG_SUPPORTS_RECENTS means your application's most
        // recently used documents will show up in the "Recents" category.
        // FLAG_SUPPORTS_SEARCH allows users to search all documents the application
        // shares.
        add(
            DocumentsContract.Root.COLUMN_FLAGS,
            DocumentsContract.Root.FLAG_SUPPORTS_CREATE or
                DocumentsContract.Root.FLAG_SUPPORTS_RECENTS or
                DocumentsContract.Root.FLAG_SUPPORTS_SEARCH
        )

        // COLUMN_TITLE is the root title (e.g. Gallery, Drive).
        add(DocumentsContract.Root.COLUMN_TITLE, context.getString(R.string.title))

        // This document id cannot change after it's shared.
        add(DocumentsContract.Root.COLUMN_DOCUMENT_ID, getDocIdForFile(baseDir))

        // The child MIME types are used to filter the roots and only present to the
        // user those roots that contain the desired type somewhere in their file hierarchy.
        add(DocumentsContract.Root.COLUMN_MIME_TYPES, getChildMimeTypes(baseDir))
        add(DocumentsContract.Root.COLUMN_AVAILABLE_BYTES, baseDir.freeSpace)
        add(DocumentsContract.Root.COLUMN_ICON, R.drawable.ic_launcher)
    }

    return result
}

জাভা

@Override
public Cursor queryRoots(String[] projection) throws FileNotFoundException {

    // Use a MatrixCursor to build a cursor
    // with either the requested fields, or the default
    // projection if "projection" is null.
    final MatrixCursor result =
            new MatrixCursor(resolveRootProjection(projection));

    // If user is not logged in, return an empty root cursor.  This removes our
    // provider from the list entirely.
    if (!isUserLoggedIn()) {
        return result;
    }

    // It's possible to have multiple roots (e.g. for multiple accounts in the
    // same app) -- just add multiple cursor rows.
    final MatrixCursor.RowBuilder row = result.newRow();
    row.add(Root.COLUMN_ROOT_ID, ROOT);

    // You can provide an optional summary, which helps distinguish roots
    // with the same title. You can also use this field for displaying an
    // user account name.
    row.add(Root.COLUMN_SUMMARY, getContext().getString(R.string.root_summary));

    // FLAG_SUPPORTS_CREATE means at least one directory under the root supports
    // creating documents. FLAG_SUPPORTS_RECENTS means your application's most
    // recently used documents will show up in the "Recents" category.
    // FLAG_SUPPORTS_SEARCH allows users to search all documents the application
    // shares.
    row.add(Root.COLUMN_FLAGS, Root.FLAG_SUPPORTS_CREATE |
            Root.FLAG_SUPPORTS_RECENTS |
            Root.FLAG_SUPPORTS_SEARCH);

    // COLUMN_TITLE is the root title (e.g. Gallery, Drive).
    row.add(Root.COLUMN_TITLE, getContext().getString(R.string.title));

    // This document id cannot change after it's shared.
    row.add(Root.COLUMN_DOCUMENT_ID, getDocIdForFile(baseDir));

    // The child MIME types are used to filter the roots and only present to the
    // user those roots that contain the desired type somewhere in their file hierarchy.
    row.add(Root.COLUMN_MIME_TYPES, getChildMimeTypes(baseDir));
    row.add(Root.COLUMN_AVAILABLE_BYTES, baseDir.getFreeSpace());
    row.add(Root.COLUMN_ICON, R.drawable.ic_launcher);

    return result;
}

আপনার ডকুমেন্ট প্রদানকারী যদি ডাইনামিক সেট অফ রুটসের সাথে কানেক্ট করে—যেমন, কোনও USB ডিভাইস যা ডিসকানেক্ট করা হতে পারে অথবা কোনও অ্যাকাউন্ট যেখান থেকে ব্যবহারকারী সাইন-আউট করতে পারেন—আপনি ContentResolver.notifyChange() পদ্ধতি ব্যবহার করে সেইসব পরিবর্তনের সাথে সিঙ্ক করে রাখার জন্য ডকুমেন্ট UI আপডেট করতে পারেন, যেমনটি নিম্নলিখিত কোড স্নিপেটে দেখানো হয়েছে।

Kotlin

val rootsUri: Uri = DocumentsContract.buildRootsUri(BuildConfig.DOCUMENTS_AUTHORITY)
context.contentResolver.notifyChange(rootsUri, null)

জাভা

Uri rootsUri = DocumentsContract.buildRootsUri(BuildConfig.DOCUMENTS_AUTHORITY);
context.getContentResolver().notifyChange(rootsUri, null);

প্রোভাইডারে ডকুমেন্ট তালিকাভুক্ত করুন

আপনার queryChildDocuments()-এর প্রয়োগে অবশ্যই একটি Cursor রিটার্ন করতে হবে যা DocumentsContract.Document-এ সংজ্ঞায়িত কলাম ব্যবহার করে নির্দিষ্ট ডিরেক্টরির সব ফাইলকে পয়েন্ট করে।

ব্যবহারকারী পিকার UI-তে আপনার রুট বেছে নিলে এই পদ্ধতি কল করা হয়। এই পদ্ধতি COLUMN_DOCUMENT_ID-এর মাধ্যমে নির্দিষ্ট করা ডকুমেন্ট আইডির চাইল্ড আইটেম ফিরিয়ে আনে। ব্যবহারকারী আপনার ডকুমেন্ট প্রদানকারীর মধ্যে কোনও সাবডিরেক্টরি বেছে নিলে, সিস্টেম যেকোনও সময় এই পদ্ধতি কল করে।

এই স্নিপেট অনুরোধ করা কলাম সহ একটি নতুন কার্সর তৈরি করে, তারপর কার্সরে পেরেন্ট ডিরেক্টরির প্রতিটি ইমিডিয়েট চাইল্ড সম্পর্কে তথ্য যোগ করে। চাইল্ড কোনও ছবি, অন্য ডিরেক্টরি—যেকোনও ফাইল হতে পারে:

Kotlin

override fun queryChildDocuments(
        parentDocumentId: String?,
        projection: Array<out String>?,
        sortOrder: String?
): Cursor {
    return MatrixCursor(resolveDocumentProjection(projection)).apply {
        val parent: File = getFileForDocId(parentDocumentId)
        parent.listFiles()
                .forEach { file ->
                    includeFile(this, null, file)
                }
    }
}

জাভা

@Override
public Cursor queryChildDocuments(String parentDocumentId, String[] projection,
                              String sortOrder) throws FileNotFoundException {

    final MatrixCursor result = new
            MatrixCursor(resolveDocumentProjection(projection));
    final File parent = getFileForDocId(parentDocumentId);
    for (File file : parent.listFiles()) {
        // Adds the file's display name, MIME type, size, and so on.
        includeFile(result, null, file);
    }
    return result;
}

ডকুমেন্ট সংক্রান্ত তথ্য পান

queryDocument()-এর প্রয়োগ করা সমাধানকে অবশ্যই Cursor রিটার্ন করতে হবে যা নির্দিষ্ট ফাইলকে পয়েন্ট করে, DocumentsContract.Document-এ সংজ্ঞায়িত কলাম ব্যবহার করে।

queryDocument() পদ্ধতিটি queryChildDocuments()-এ পাস করা একই তথ্য ফেরত দেয়, তবে একটি নির্দিষ্ট ফাইলের জন্য:

Kotlin

override fun queryDocument(documentId: String?, projection: Array<out String>?): Cursor {
    // Create a cursor with the requested projection, or the default projection.
    return MatrixCursor(resolveDocumentProjection(projection)).apply {
        includeFile(this, documentId, null)
    }
}

জাভা

@Override
public Cursor queryDocument(String documentId, String[] projection) throws
        FileNotFoundException {

    // Create a cursor with the requested projection, or the default projection.
    final MatrixCursor result = new
            MatrixCursor(resolveDocumentProjection(projection));
    includeFile(result, documentId, null);
    return result;
}

আপনার ডকুমেন্ট প্রদানকারীও DocumentsProvider.openDocumentThumbnail() পদ্ধতি ওভাররাইড করে এবং কাজ করে এমন ফাইলে FLAG_SUPPORTS_THUMBNAIL ফ্ল্যাগ যোগ করে ডকুমেন্টের জন্য থাম্বনেল প্রদান করতে পারে। নিম্নলিখিত কোড স্নিপেট থেকে আপনি জানতে পারবেন যে কীভাবে DocumentsProvider.openDocumentThumbnail() প্রয়োগ করতে হয়।

Kotlin

override fun openDocumentThumbnail(
        documentId: String?,
        sizeHint: Point?,
        signal: CancellationSignal?
): AssetFileDescriptor {
    val file = getThumbnailFileForDocId(documentId)
    val pfd = ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY)
    return AssetFileDescriptor(pfd, 0, AssetFileDescriptor.UNKNOWN_LENGTH)
}

জাভা

@Override
public AssetFileDescriptor openDocumentThumbnail(String documentId, Point sizeHint,
                                                     CancellationSignal signal)
        throws FileNotFoundException {

    final File file = getThumbnailFileForDocId(documentId);
    final ParcelFileDescriptor pfd =
        ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY);
    return new AssetFileDescriptor(pfd, 0, AssetFileDescriptor.UNKNOWN_LENGTH);
}

সতর্কতা: ডকুমেন্ট প্রদানকারীর থাম্বনেল ছবির সাইজ sizeHint প্যারামিটারে উল্লেখ করা সাইজের দ্বিগুণের বেশি হওয়া উচিত নয়।

ডকুমেন্ট খুলুন

নির্দিষ্ট ফাইলকে উপস্থাপন করে এমন ParcelFileDescriptor ফিরিয়ে আনতে আপনাকে অবশ্যই openDocument() প্রয়োগ করতে হবে। অন্যান্য অ্যাপ ডেটা স্ট্রিম করার জন্য ফেরত আসা ParcelFileDescriptor ব্যবহার করতে পারে। ব্যবহারকারী কোনও ফাইল বেছে নেওয়ার পরে সিস্টেম এই পদ্ধতি কল করে, এবং ক্লায়েন্ট অ্যাপ openFileDescriptor() কল করে এতে অ্যাক্সেসের অনুরোধ করে। যেমন:

Kotlin

override fun openDocument(
        documentId: String,
        mode: String,
        signal: CancellationSignal
): ParcelFileDescriptor {
    Log.v(TAG, "openDocument, mode: $mode")
    // It's OK to do network operations in this method to download the document,
    // as long as you periodically check the CancellationSignal. If you have an
    // extremely large file to transfer from the network, a better solution may
    // be pipes or sockets (see ParcelFileDescriptor for helper methods).

    val file: File = getFileForDocId(documentId)
    val accessMode: Int = ParcelFileDescriptor.parseMode(mode)

    val isWrite: Boolean = mode.contains("w")
    return if (isWrite) {
        val handler = Handler(context.mainLooper)
        // Attach a close listener if the document is opened in write mode.
        try {
            ParcelFileDescriptor.open(file, accessMode, handler) {
                // Update the file with the cloud server. The client is done writing.
                Log.i(TAG, "A file with id $documentId has been closed! Time to update the server.")
            }
        } catch (e: IOException) {
            throw FileNotFoundException(
                    "Failed to open document with id $documentId and mode $mode"
            )
        }
    } else {
        ParcelFileDescriptor.open(file, accessMode)
    }
}

জাভা

@Override
public ParcelFileDescriptor openDocument(final String documentId,
                                         final String mode,
                                         CancellationSignal signal) throws
        FileNotFoundException {
    Log.v(TAG, "openDocument, mode: " + mode);
    // It's OK to do network operations in this method to download the document,
    // as long as you periodically check the CancellationSignal. If you have an
    // extremely large file to transfer from the network, a better solution may
    // be pipes or sockets (see ParcelFileDescriptor for helper methods).

    final File file = getFileForDocId(documentId);
    final int accessMode = ParcelFileDescriptor.parseMode(mode);

    final boolean isWrite = (mode.indexOf('w') != -1);
    if(isWrite) {
        // Attach a close listener if the document is opened in write mode.
        try {
            Handler handler = new Handler(getContext().getMainLooper());
            return ParcelFileDescriptor.open(file, accessMode, handler,
                        new ParcelFileDescriptor.OnCloseListener() {
                @Override
                public void onClose(IOException e) {

                    // Update the file with the cloud server. The client is done
                    // writing.
                    Log.i(TAG, "A file with id " +
                    documentId + " has been closed! Time to " +
                    "update the server.");
                }

            });
        } catch (IOException e) {
            throw new FileNotFoundException("Failed to open document with id"
            + documentId + " and mode " + mode);
        }
    } else {
        return ParcelFileDescriptor.open(file, accessMode);
    }
}

আপনার ডকুমেন্ট প্রদানকারী ফাইল স্ট্রিম করলে বা জটিল ডেটা স্ট্রাকচার ম্যানেজ করলে, createReliablePipe() বা createReliableSocketPair() পদ্ধতি প্রয়োগ করার কথা বিবেচনা করুন। এইসব পদ্ধতি আপনাকে এক জোড়া ParcelFileDescriptor অবজেক্ট তৈরি করতে দেয়, যেখানে আপনি একটি ফেরত দিতে পারেন এবং অন্যটি ParcelFileDescriptor.AutoCloseOutputStream বা ParcelFileDescriptor.AutoCloseInputStream-এর মাধ্যমে পাঠাতে পারেন।

Kotlin

override fun queryRecentDocuments(rootId: String?, projection: Array<out String>?): Cursor {
    // This example implementation walks a
    // local file structure to find the most recently
    // modified files.  Other implementations might
    // include making a network call to query a
    // server.

    // Create a cursor with the requested projection, or the default projection.
    val result = MatrixCursor(resolveDocumentProjection(projection))

    val parent: File = getFileForDocId(rootId)

    // Create a queue to store the most recent documents,
    // which orders by last modified.
    val lastModifiedFiles = PriorityQueue(
            5,
            Comparator<File> { i, j ->
                Long.compare(i.lastModified(), j.lastModified())
            }
    )

    // Iterate through all files and directories
    // in the file structure under the root.  If
    // the file is more recent than the least
    // recently modified, add it to the queue,
    // limiting the number of results.
    val pending : MutableList<File> = mutableListOf()

    // Start by adding the parent to the list of files to be processed
    pending.add(parent)

    // Do while we still have unexamined files
    while (pending.isNotEmpty()) {
        // Take a file from the list of unprocessed files
        val file: File = pending.removeAt(0)
        if (file.isDirectory) {
            // If it's a directory, add all its children to the unprocessed list
            pending += file.listFiles()
        } else {
            // If it's a file, add it to the ordered queue.
            lastModifiedFiles.add(file)
        }
    }

    // Add the most recent files to the cursor,
    // not exceeding the max number of results.
    for (i in 0 until Math.min(MAX_LAST_MODIFIED + 1, lastModifiedFiles.size)) {
        val file: File = lastModifiedFiles.remove()
        includeFile(result, null, file)
    }
    return result
}

জাভা

@Override
public Cursor queryRecentDocuments(String rootId, String[] projection)
        throws FileNotFoundException {

    // This example implementation walks a
    // local file structure to find the most recently
    // modified files.  Other implementations might
    // include making a network call to query a
    // server.

    // Create a cursor with the requested projection, or the default projection.
    final MatrixCursor result =
        new MatrixCursor(resolveDocumentProjection(projection));

    final File parent = getFileForDocId(rootId);

    // Create a queue to store the most recent documents,
    // which orders by last modified.
    PriorityQueue lastModifiedFiles =
        new PriorityQueue(5, new Comparator() {

        public int compare(File i, File j) {
            return Long.compare(i.lastModified(), j.lastModified());
        }
    });

    // Iterate through all files and directories
    // in the file structure under the root.  If
    // the file is more recent than the least
    // recently modified, add it to the queue,
    // limiting the number of results.
    final LinkedList pending = new LinkedList();

    // Start by adding the parent to the list of files to be processed
    pending.add(parent);

    // Do while we still have unexamined files
    while (!pending.isEmpty()) {
        // Take a file from the list of unprocessed files
        final File file = pending.removeFirst();
        if (file.isDirectory()) {
            // If it's a directory, add all its children to the unprocessed list
            Collections.addAll(pending, file.listFiles());
        } else {
            // If it's a file, add it to the ordered queue.
            lastModifiedFiles.add(file);
        }
    }

    // Add the most recent files to the cursor,
    // not exceeding the max number of results.
    for (int i = 0; i < Math.min(MAX_LAST_MODIFIED + 1, lastModifiedFiles.size()); i++) {
        final File file = lastModifiedFiles.remove();
        includeFile(result, null, file);
    }
    return result;
}

আপনি StorageProvider কোড স্যাম্পেল ডাউনলোড করে উপরের স্নিপেটের সম্পূর্ণ কোড পেতে পারেন।

ডকুমেন্ট তৈরি করার সুবিধা

আপনি ক্লায়েন্ট অ্যাপকে আপনার ডকুমেন্ট প্রদানকারীর মধ্যে ফাইল তৈরি করার অনুমতি দিতে পারেন। কোনও ক্লায়েন্ট অ্যাপ ACTION_CREATE_DOCUMENT ইনটেন্ট পাঠালে, আপনার ডকুমেন্ট প্রোভাইডার সেই ক্লায়েন্ট অ্যাপকে ডকুমেন্ট প্রোভাইডারের মধ্যে নতুন ডকুমেন্ট তৈরি করার অনুমতি দিতে পারে।

ডকুমেন্ট তৈরি করার জন্য, আপনার রুটে FLAG_SUPPORTS_CREATE ফ্ল্যাগ থাকতে হবে। যেসব ডিরেক্টরি নতুন ফাইল তৈরি করার অনুমতি দেয়, সেগুলিতে FLAG_DIR_SUPPORTS_CREATE ফ্ল্যাগ থাকতে হবে।

আপনার ডকুমেন্ট প্রদানকারীকেও createDocument() পদ্ধতি প্রয়োগ করতে হবে। কোনও ব্যবহারকারী নতুন ফাইল সেভ করার জন্য আপনার ডকুমেন্ট প্রোভাইডারের মধ্যে কোনও ডিরেক্টরি বেছে নিলে, ডকুমেন্ট প্রোভাইডার createDocument()-এ কল পায়। createDocument() পদ্ধতির প্রয়োগের মধ্যে, আপনি ফাইলের জন্য নতুন COLUMN_DOCUMENT_ID ফেরত পাঠান। ক্লায়েন্ট অ্যাপটি তখন ফাইলের হ্যান্ডেল পেতে সেই আইডি ব্যবহার করতে পারে এবং, শেষ পর্যন্ত, নতুন ফাইলে লেখার জন্য openDocument() কল করতে পারে।

নিচের কোড স্নিপেট থেকে বোঝা যায় যে কীভাবে ডকুমেন্ট প্রদানকারীর মধ্যে নতুন ফাইল তৈরি করতে হয়।

Kotlin

override fun createDocument(documentId: String?, mimeType: String?, displayName: String?): String {
    val parent: File = getFileForDocId(documentId)
    val file: File = try {
        File(parent.path, displayName).apply {
            createNewFile()
            setWritable(true)
            setReadable(true)
        }
    } catch (e: IOException) {
        throw FileNotFoundException(
                "Failed to create document with name $displayName and documentId $documentId"
        )
    }

    return getDocIdForFile(file)
}

জাভা

@Override
public String createDocument(String documentId, String mimeType, String displayName)
        throws FileNotFoundException {

    File parent = getFileForDocId(documentId);
    File file = new File(parent.getPath(), displayName);
    try {
        file.createNewFile();
        file.setWritable(true);
        file.setReadable(true);
    } catch (IOException e) {
        throw new FileNotFoundException("Failed to create document with name " +
                displayName +" and documentId " + documentId);
    }
    return getDocIdForFile(file);
}

ডকুমেন্ট ম্যানেজমেন্ট ফিচার সংক্রান্ত সহায়তা

ফাইল খোলা, তৈরি করা এবং দেখার পাশাপাশি, আপনার ডকুমেন্ট প্রদানকারী ক্লায়েন্ট অ্যাপগুলিকে ফাইলের নাম পরিবর্তন, কপি, সরানো এবং মুছে ফেলার অনুমতিও দিতে পারে। আপনার ডকুমেন্ট প্রদানকারীর সাথে ডকুমেন্ট ম্যানেজমেন্ট কার্যকারিতা যোগ করতে, ডকুমেন্টের COLUMN_FLAGS কলামে একটি ফ্ল্যাগ যোগ করুন যাতে কাজ করে এমন কার্যকারিতা দেখানো যায়। এছাড়াও, আপনাকে DocumentsProvider ক্লাসের সংশ্লিষ্ট পদ্ধতি প্রয়োগ করতে হবে।

নিম্নলিখিত সারণীতে COLUMN_FLAGS ফ্ল্যাগ এবং DocumentsProvider পদ্ধতি উল্লেখ করা হয়েছে যা নির্দিষ্ট ফিচার দেখানোর জন্য ডকুমেন্ট প্রদানকারীকে প্রয়োগ করতে হবে।

ফিচার	পতাকা	পদ্ধতি
কোনও ফাইল মুছে ফেলা	`FLAG_SUPPORTS_DELETE`	`deleteDocument()`
ফাইলের নাম পরিবর্তন করুন	`FLAG_SUPPORTS_RENAME`	`renameDocument()`
ডকুমেন্ট প্রদানকারীর মধ্যে নতুন পেরেন্ট ডিরেক্টরিতে ফাইল কপি করুন	`FLAG_SUPPORTS_COPY`	`copyDocument()`
ডকুমেন্ট প্রোভাইডারের মধ্যে একটি ডিরেক্টরি থেকে অন্য ডিরেক্টরিতে ফাইল সরান	`FLAG_SUPPORTS_MOVE`	`moveDocument()`
পেরেন্ট ডিরেক্টরি থেকে ফাইল সরানো	`FLAG_SUPPORTS_REMOVE`	`removeDocument()`

ভার্চুয়াল ফাইল ও বিকল্প ফাইল ফর্ম্যাট সাপোর্ট করে

ভার্চুয়াল ফাইল, Android 7.0 (API লেভেল ২৪)-এ চালু করা একটি ফিচার, যা ডকুমেন্ট প্রদানকারীদের এমন ফাইল দেখার অ্যাক্সেস প্রদান করার অনুমতি দেয় যেগুলির সরাসরি বাইটকোড উপস্থাপনা নেই। অন্যান্য অ্যাপকে ভার্চুয়াল ফাইল দেখার অনুমতি দিতে, আপনার ডকুমেন্ট প্রদানকারীকে ভার্চুয়াল ফাইলের জন্য বিকল্প খোলা যায় এমন ফাইল প্রতিনিধিত্ব তৈরি করতে হবে।

যেমন, ধরুন কোনও ডকুমেন্ট প্রদানকারীর কাছে এমন একটি ফাইল ফর্ম্যাট আছে যা অন্যান্য অ্যাপ সরাসরি খুলতে পারে না, মূলত একটি ভার্চুয়াল ফাইল। যখন কোনও ক্লায়েন্ট অ্যাপ CATEGORY_OPENABLE বিভাগ ছাড়াই ACTION_VIEW ইনটেন্ট পাঠায়, তখন ব্যবহারকারীরা দেখার জন্য ডকুমেন্ট প্রোভাইডারের মধ্যে এইসব ভার্চুয়াল ফাইল বেছে নিতে পারেন। তারপর ডকুমেন্ট প্রদানকারী ভার্চুয়াল ফাইলটি অন্য, কিন্তু খোলা যায় এমন ফাইল ফর্ম্যাটে ফেরত দেয়, যেমন ছবি। ক্লায়েন্ট অ্যাপ তখন ব্যবহারকারীকে দেখানোর জন্য ভার্চুয়াল ফাইল খুলতে পারে।

প্রোভাইডারে কোনও ডকুমেন্ট ভার্চুয়াল হিসেবে ঘোষণা করতে, আপনাকে FLAG_VIRTUAL_DOCUMENT ফ্ল্যাগটি queryDocument() পদ্ধতির মাধ্যমে রিটার্ন করা ফাইলে যোগ করতে হবে। এই ফ্ল্যাগ ক্লায়েন্ট অ্যাপকে সতর্ক করে যে ফাইলটির কোনও সরাসরি বাইটকোড উপস্থাপনা নেই এবং সরাসরি খোলা যাবে না।

আপনার ডকুমেন্ট প্রদানকারীর কোনও ফাইল ভার্চুয়াল বলে ঘোষণা করলে, সেটি ছবি বা পিডিএফের মতো অন্য কোনও MIME-এর প্রকারে উপলভ্য করার জন্য বিশেষভাবে সাজেস্ট করা হয়। ডকুমেন্ট প্রদানকারী বিকল্প MIME-এর প্রকার ঘোষণা করে যা getDocumentStreamTypes() পদ্ধতি ওভাররাইড করে ভার্চুয়াল ফাইল দেখার জন্য সাপোর্ট করে। ক্লায়েন্ট অ্যাপ getStreamTypes(android.net.Uri, java.lang.String) মেথড কল করলে, সিস্টেম ডকুমেন্ট প্রদানকারীর getDocumentStreamTypes() মেথড কল করে। তারপর getDocumentStreamTypes() পদ্ধতিটি বিকল্প MIME প্রকারের একটি অ্যারে রিটার্ন করে যা ডকুমেন্ট প্রদানকারী ফাইলের জন্য সাপোর্ট করে।

ক্লায়েন্ট যখন নির্ধারণ করে যে ডকুমেন্ট প্রদানকারী দেখার উপযুক্ত ফাইল ফর্ম্যাটে ডকুমেন্ট তৈরি করতে পারবে, তখন ক্লায়েন্ট অ্যাপ openTypedAssetFileDescriptor() মেথড কল করে, যা ইন্টার্নালি ডকুমেন্ট প্রদানকারীর openTypedDocument() মেথড কল করে। ডকুমেন্ট প্রদানকারী অনুরোধ করা ফাইলের ফরম্যাটে ক্লায়েন্ট অ্যাপে ফাইলটি ফেরত দেয়।

নিচে দেওয়া কোড স্নিপেট থেকে getDocumentStreamTypes() এবং openTypedDocument() পদ্ধতির সহজ প্রয়োগ সম্পর্কে জানা যাবে।

Kotlin

var SUPPORTED_MIME_TYPES : Array<String> = arrayOf("image/png", "image/jpg")
override fun openTypedDocument(
        documentId: String?,
        mimeTypeFilter: String,
        opts: Bundle?,
        signal: CancellationSignal?
): AssetFileDescriptor? {
    return try {
        // Determine which supported MIME type the client app requested.
        when(mimeTypeFilter) {
            "image/jpg" -> openJpgDocument(documentId)
            "image/png", "image/*", "*/*" -> openPngDocument(documentId)
            else -> throw IllegalArgumentException("Invalid mimeTypeFilter $mimeTypeFilter")
        }
    } catch (ex: Exception) {
        Log.e(TAG, ex.message)
        null
    }
}

override fun getDocumentStreamTypes(documentId: String, mimeTypeFilter: String): Array<String> {
    return when (mimeTypeFilter) {
        "*/*", "image/*" -> {
            // Return all supported MIME types if the client app
            // passes in '*/*' or 'image/*'.
            SUPPORTED_MIME_TYPES
        }
        else -> {
            // Filter the list of supported mime types to find a match.
            SUPPORTED_MIME_TYPES.filter { it == mimeTypeFilter }.toTypedArray()
        }
    }
}

জাভা

public static String[] SUPPORTED_MIME_TYPES = {"image/png", "image/jpg"};

@Override
public AssetFileDescriptor openTypedDocument(String documentId,
    String mimeTypeFilter,
    Bundle opts,
    CancellationSignal signal) {

    try {

        // Determine which supported MIME type the client app requested.
        if ("image/png".equals(mimeTypeFilter) ||
            "image/*".equals(mimeTypeFilter) ||
            "*/*".equals(mimeTypeFilter)) {

            // Return the file in the specified format.
            return openPngDocument(documentId);

        } else if ("image/jpg".equals(mimeTypeFilter)) {
            return openJpgDocument(documentId);
        } else {
            throw new IllegalArgumentException("Invalid mimeTypeFilter " + mimeTypeFilter);
        }

    } catch (Exception ex) {
        Log.e(TAG, ex.getMessage());
    } finally {
        return null;
    }
}

@Override
public String[] getDocumentStreamTypes(String documentId, String mimeTypeFilter) {

    // Return all supported MIME tyupes if the client app
    // passes in '*/*' or 'image/*'.
    if ("*/*".equals(mimeTypeFilter) ||
        "image/*".equals(mimeTypeFilter)) {
        return SUPPORTED_MIME_TYPES;
    }

    ArrayList requestedMimeTypes = new ArrayList&lt;&gt;();

    // Iterate over the list of supported mime types to find a match.
    for (int i=0; i &lt; SUPPORTED_MIME_TYPES.length; i++) {
        if (SUPPORTED_MIME_TYPES[i].equals(mimeTypeFilter)) {
            requestedMimeTypes.add(SUPPORTED_MIME_TYPES[i]);
        }
    }
    return (String[])requestedMimeTypes.toArray();
}

নিরাপত্তা

ধরুন, আপনার ডকুমেন্ট প্রদানকারী হল পাসওয়ার্ড-সুরক্ষিত ক্লাউড স্টোরেজ পরিষেবা এবং আপনি নিশ্চিত করতে চান যে ব্যবহারকারীরা তাদের ফাইল শেয়ার করা শুরু করার আগে লগ-ইন করেছেন। ব্যবহারকারী লগ-ইন না করলে আপনার অ্যাপের কী করা উচিত? সমাধান হল, queryRoots()-এর প্রয়োগে শূন্য রুট রিটার্ন করা। অর্থাৎ, একটি খালি রুট কার্সর:

Kotlin

override fun queryRoots(projection: Array<out String>): Cursor {
...
    // If user is not logged in, return an empty root cursor.  This removes our
    // provider from the list entirely.
    if (!isUserLoggedIn()) {
        return result
    }

জাভা

public Cursor queryRoots(String[] projection) throws FileNotFoundException {
...
    // If user is not logged in, return an empty root cursor.  This removes our
    // provider from the list entirely.
    if (!isUserLoggedIn()) {
        return result;
}

অন্য ধাপটি হল getContentResolver().notifyChange()-এ কল করা। DocumentsContract মনে আছে? এই URI তৈরি করতে আমরা এটি ব্যবহার করছি। ব্যবহারকারীর লগ-ইন স্ট্যাটাস পরিবর্তন হলে, নিম্নলিখিত স্নিপেট সিস্টেমকে আপনার ডকুমেন্ট প্রোভাইডারের রুট কোয়েরি করতে বলে। ব্যবহারকারী লগ-ইন না করে থাকলে, queryRoots()-এ কল করলে, উপরে দেখানো অনুযায়ী খালি কার্সর দেখায়। এটি নিশ্চিত করে যে কোনও পরিষেবা প্রদানকারীর ডকুমেন্ট শুধুমাত্র তখনই উপলভ্য হবে যখন ব্যবহারকারী সেই পরিষেবা প্রদানকারীর অ্যাকাউন্টে লগ-ইন করবেন।

Kotlin

private fun onLoginButtonClick() {
    loginOrLogout()
    getContentResolver().notifyChange(
        DocumentsContract.buildRootsUri(AUTHORITY),
        null
    )
}

জাভা

private void onLoginButtonClick() {
    loginOrLogout();
    getContentResolver().notifyChange(DocumentsContract
            .buildRootsUri(AUTHORITY), null);
}

এই পৃষ্ঠার সাথে সম্পর্কিত স্যাম্পেল কোডের জন্য, এখানে দেখুন:

এই পৃষ্ঠার সাথে সম্পর্কিত ভিডিওর জন্য, এটি দেখুন:

আরও সম্পর্কিত তথ্যের জন্য, এখানে দেখুন:

পূর্ববর্তী

স্টোরেজ অ্যাক্সেস ফ্রেমওয়ার্ক ব্যবহার করে ফাইল খুলুন

পরবর্তী

একটি ক্লাউড মিডিয়া প্রদানকারী তৈরি করুন

ম্যানিফেস্ট

Android 4.3 এবং তার আগের যেকোনও ভার্সনে চলে এমন ডিভাইসে কাজ করে

চুক্তি

Kotlin

জাভা

DocumentsProvider-এর সাবক্লাস তৈরি করুন

রুট নির্দিষ্ট করুন

Kotlin

জাভা

Kotlin

জাভা

প্রোভাইডারে ডকুমেন্ট তালিকাভুক্ত করুন

Kotlin

জাভা

ডকুমেন্ট সংক্রান্ত তথ্য পান

Kotlin

জাভা

Kotlin

জাভা

ডকুমেন্ট খুলুন

Kotlin

জাভা

সাম্প্রতিক ডকুমেন্ট ও সার্চের সুবিধা

Kotlin

জাভা

ডকুমেন্ট তৈরি করার সুবিধা

Kotlin

জাভা

ডকুমেন্ট ম্যানেজমেন্ট ফিচার সংক্রান্ত সহায়তা

ভার্চুয়াল ফাইল ও বিকল্প ফাইল ফর্ম্যাট সাপোর্ট করে

Kotlin

জাভা

নিরাপত্তা

Kotlin

জাভা

Kotlin

জাভা