Langage

DocumentsProvider Classe

Définition

Classe de base pour un fournisseur de documents.

[Android.Runtime.Register("android/provider/DocumentsProvider", DoNotGenerateAcw=true)]
public abstract class DocumentsProvider : Android.Content.ContentProvider
[<Android.Runtime.Register("android/provider/DocumentsProvider", DoNotGenerateAcw=true)>]
type DocumentsProvider = class
    inherit ContentProvider
Héritage
Attributs

Remarques

Classe de base pour un fournisseur de documents. Un fournisseur de documents offre un accès en lecture et écriture à des fichiers durables, tels que des fichiers stockés sur un disque local ou des fichiers dans un service de stockage cloud. Pour créer un fournisseur de documents, étendez cette classe, implémentez les méthodes abstraites et ajoutez-la à votre manifeste comme suit :

&lt;manifest&gt;
               ...
               &lt;application&gt;
                   ...
                   &lt;provider
                       android:name="com.example.MyCloudProvider"
                       android:authorities="com.example.mycloudprovider"
                       android:exported="true"
                       android:grantUriPermissions="true"
                       android:permission="android.permission.MANAGE_DOCUMENTS"
                       android:enabled="@bool/isAtLeastKitKat"&gt;
                       &lt;intent-filter&gt;
                           &lt;action android:name="android.content.action.DOCUMENTS_PROVIDER" /&gt;
                       &lt;/intent-filter&gt;
                   &lt;/provider&gt;
                   ...
               &lt;/application&gt;
            &lt;/manifest&gt;

Lorsque vous définissez votre fournisseur, vous devez le protéger avec android.Manifest.permission#MANAGE_DOCUMENTS, qui est une autorisation que seul le système peut obtenir. Les applications ne peuvent pas utiliser directement un fournisseur de documents ; ils doivent parcourir Intent#ACTION_OPEN_DOCUMENT ou Intent#ACTION_CREATE_DOCUMENT exiger qu’un utilisateur navigue activement et sélectionne des documents. Lorsqu’un utilisateur sélectionne des documents via cette interface utilisateur, le système émet des autorisations d’URI étroites accordées à l’application demandée.

<documents h3></h3>

Un document peut être un flux openable (avec un type MIME spécifique) ou un répertoire contenant des documents supplémentaires (avec le Document#MIME_TYPE_DIR type MIME). Chaque répertoire représente le haut d’une sous-arborescence contenant zéro ou plusieurs documents, qui peuvent contenir de manière récursive encore plus de documents et de répertoires.

Chaque document peut avoir des fonctionnalités différentes, comme décrit par Document#COLUMN_FLAGS. Par exemple, si un document peut être représenté en tant que miniature, votre fournisseur peut définir Document#FLAG_SUPPORTS_THUMBNAIL et implémenter #openDocumentThumbnail(String, Point, CancellationSignal) pour renvoyer cette miniature.

Chaque document sous un fournisseur est référencé de manière unique par son Document#COLUMN_DOCUMENT_IDdocument, qui ne doit pas changer une fois retourné. Un seul document peut être inclus dans plusieurs répertoires lors de la réponse à #queryChildDocuments(String, String[], String). Par exemple, un fournisseur peut exposer une seule photo à plusieurs emplacements : une fois dans un répertoire d’emplacements géographiques, puis à nouveau dans un répertoire de dates.

<h3>Racines</h3>

Tous les documents sont exposés à travers une ou plusieurs « racines ». Chaque racine représente le haut d’une arborescence de documents qu’un utilisateur peut naviguer. Par exemple, une racine peut représenter un compte ou un appareil de stockage physique. Comme pour les documents, chaque racine peut avoir des fonctionnalités exprimées par Root#COLUMN_FLAGS.

Java documentation pour android.provider.DocumentsProvider.

Les parties de cette page sont des modifications basées sur le travail créé et partagé par Android Open Source et utilisées en fonction des termes décrits dans la Creative Commons 2.5 Attribution License.

Constructeurs

Nom Description
DocumentsProvider()
DocumentsProvider(IntPtr, JniHandleOwnership)

Constructeur utilisé lors de la création de représentations managées d’objets JNI ; appelée par le runtime.

Propriétés

Nom Description
CallingAttributionSource

Obtient la source d’attribution de l’application appelante.

(Hérité de ContentProvider)
CallingAttributionTag

Retourne la balise d’attribution de l’appelant qui a lancé la requête en cours de traitement sur le thread actuel.

(Hérité de ContentProvider)
CallingPackage

Retourne le nom du package de l’appelant qui a lancé la requête en cours de traitement sur le thread actuel.

(Hérité de ContentProvider)
CallingPackageUnchecked

Retourne le nom du package de l’appelant qui a lancé la requête en cours de traitement sur le thread actuel.

(Hérité de ContentProvider)
Class

Retourne la classe runtime de ce Object.

(Hérité de Object)
Context

Récupère le contexte dans lequel ce fournisseur s’exécute.

(Hérité de ContentProvider)
Handle

Handle de l’instance Android sous-jacente.

(Hérité de Object)
IsTemporary

Retourne true si cette instance est un fournisseur de contenu temporaire.

(Hérité de ContentProvider)
JniIdentityHashCode

Obtient le code de hachage d’identité affecté à cet homologue Java par le runtime d’interopérabilité.

(Hérité de Object)
JniManagedPeerState

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
JniPeerMembers

Classe de base pour un fournisseur de documents.

PeerReference

Obtient la référence d’objet JNI pour cet homologue Java.

(Hérité de Object)
ReadPermission
Obsolète.

Retourne le nom de l’autorisation requise pour l’accès en lecture seule à ce fournisseur de contenu. -ou- Modifiez l’autorisation requise pour lire les données du fournisseur de contenu.

(Hérité de ContentProvider)
ThresholdClass

Cette API prend en charge l’infrastructure Mono pour Android et n’est pas destinée à être utilisée directement à partir de votre code.

ThresholdType

Cette API prend en charge l’infrastructure Mono pour Android et n’est pas destinée à être utilisée directement à partir de votre code.

WritePermission
Obsolète.

Retourne le nom de l’autorisation requise pour l’accès en lecture/écriture à ce fournisseur de contenu. -ou- Modifiez l’autorisation requise pour lire et écrire des données dans le fournisseur de contenu.

(Hérité de ContentProvider)

Méthodes

Nom Description
ApplyBatch(IList<ContentProviderOperation>)

Remplacez cette option pour gérer les demandes d’exécution d’un lot d’opérations, ou l’implémentation par défaut effectue une itération sur les opérations et appelle ContentProviderOperation#apply chacune d’elles.

(Hérité de ContentProvider)
ApplyBatch(String, IList<ContentProviderOperation>)

Remplacez cette option pour gérer les demandes d’exécution d’un lot d’opérations, ou l’implémentation par défaut effectue une itération sur les opérations et appelle ContentProviderOperation#apply chacune d’elles.

(Hérité de ContentProvider)
AttachInfo(Context, ProviderInfo)

Après avoir été instancié, il est appelé pour indiquer au fournisseur de contenu lui-même.

(Hérité de ContentProvider)
BulkInsert(Uri, ContentValues[])

Remplacez cette option pour gérer les demandes d’insertion d’un ensemble de nouvelles lignes, ou l’implémentation par défaut effectue une itération sur les valeurs et appelle #insert chacune d’elles.

(Hérité de ContentProvider)
Call(String, String, Bundle)

Appelez une méthode définie par un fournisseur.

(Hérité de ContentProvider)
Call(String, String, String, Bundle)

Appelez une méthode définie par un fournisseur.

(Hérité de ContentProvider)
Canonicalize(Uri)

Implémentez ceci pour prendre en charge la canonisation des URI qui font référence à votre fournisseur de contenu.

(Hérité de ContentProvider)
ClearCallingIdentity()

Réinitialisez l’identité de l’IPC entrant sur le thread actuel.

(Hérité de ContentProvider)
Clone()

Crée et retourne une copie de cet objet.

(Hérité de Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
CopyDocument(String, String)

Copiez le document demandé ou une arborescence de documents.

CreateDocument(String, String, String)

Créez un document et retournez son nouveau document généré Document#COLUMN_DOCUMENT_ID.

CreateWebLinkIntent(String, Bundle)

Crée un expéditeur d’intention pour un lien web, si le document est accessible en lien web.

Delete(Uri, Bundle)

Implémentez cette opération pour gérer les demandes de suppression d’une ou plusieurs lignes.

(Hérité de ContentProvider)
Delete(Uri, String, String[])

L’implémentation est fournie par la classe parente.

DeleteDocument(String)

Supprimez le document demandé.

Dispose()

Libère les ressources détenues par cet homologue Java.

(Hérité de Object)
Dispose(Boolean)

Libère les ressources détenues par cet homologue Java.

(Hérité de Object)
DisposeUnlessReferenced()

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
Dump(FileDescriptor, PrintWriter, String[])

Imprimez l’état du fournisseur dans le flux donné.

(Hérité de ContentProvider)
DumpAsync(FileDescriptor, PrintWriter, String[])

Imprimez l’état du fournisseur dans le flux donné. Cela est appelé si vous exécutez « adb shell dumpsys activity provider <provider_component_name> ».

(Hérité de ContentProvider)
EjectRoot(String)

Éjecte la racine.

Equals(Object)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
Equals(Object)

Indique si un autre objet est « égal à » celui-ci.

(Hérité de Object)
FindDocumentPath(String, String)

Recherche le chemin canonique du document demandé.

GetDocumentMetadata(String)

Retourne les métadonnées associées au document.

GetDocumentStreamTypes(String, String)

Retourne une liste de types MIME streamables correspondant au filtre, qui peut être transmis à #openTypedDocument(String, String, Bundle, CancellationSignal).

GetDocumentType(String)

Retournez le type MIME concret du document demandé.

GetHashCode()

Retourne une valeur de code de hachage pour l’objet.

(Hérité de Object)
GetPathPermissions()

Retournez les autorisations basées sur le chemin requises pour l’accès en lecture et/ou en écriture à ce fournisseur de contenu.

(Hérité de ContentProvider)
GetStreamTypes(Uri, String)

Appelé par un client pour déterminer les types de flux de données pris en charge par ce fournisseur de contenu pour l’URI donné.

(Hérité de ContentProvider)
GetType(Uri)

L’implémentation est fournie par la classe parente.

GetTypeAnonymous(Uri)

Version illimitée de getType, qui ne révèle pas d’informations sensibles

Insert(Uri, ContentValues, Bundle)

Implémentez ceci pour gérer les demandes d’insertion d’une nouvelle ligne.

(Hérité de ContentProvider)
Insert(Uri, ContentValues)

L’implémentation est fournie par la classe parente.

IsChildDocument(String, String)

Testez si un document est descendant (enfant, petit-enfant, etc.) du parent donné.

JavaFinalize()

Appelé par le garbage collector sur un objet lorsque le garbage collection détermine qu’il n’y a plus de références à l’objet.

(Hérité de Object)
MoveDocument(String, String, String)

Déplacez le document demandé ou une arborescence de documents.

Notify()

Réveille un thread unique qui attend le moniteur de cet objet.

(Hérité de Object)
NotifyAll()

Réveille tous les threads qui attendent le moniteur de cet objet.

(Hérité de Object)
OnCallingPackageChanged()

Appelé chaque fois que la valeur des #getCallingPackage() modifications est modifiée, ce qui permet au fournisseur d’invalider toute mise en cache liée à la sécurité qu’il peut effectuer.

(Hérité de ContentProvider)
OnConfigurationChanged(Configuration)

Appelé par le système lorsque la configuration de l’appareil change pendant l’exécution de votre composant. Notez que, contrairement aux activités, d’autres composants ne sont jamais redémarrés lorsqu’une configuration change : elles doivent toujours traiter les résultats de la modification, par exemple en récupérant à nouveau les ressources. Au moment où cette fonction a été appelée, votre objet Resources a été mis à jour pour retourner les valeurs de ressource correspondant à la nouvelle configuration. Pour plus d’informations, consultez Gestion des modifications du runtime . Cette méthode est toujours appelée sur le thread principal de l’application et ne doit pas effectuer de longues opérations. L’implémentation du fournisseur de contenu par défaut ne fait rien. Remplacez cette méthode pour prendre les mesures appropriées. (Les fournisseurs de contenu ne se soucient généralement pas des éléments tels que l’orientation de l’écran, mais peuvent vouloir connaître les modifications de paramètres régionaux.) Paramètres newConfig Configuration : nouvelle configuration de l’appareil. Cette valeur ne peut pas être null.

(Hérité de ContentProvider)
OnCreate()

Implémentez cette opération pour initialiser votre fournisseur de contenu au démarrage.

(Hérité de ContentProvider)
OnLowMemory()

Cela est appelé lorsque le système global est en cours d’exécution faible en mémoire et que les processus en cours d’exécution doivent réduire leur utilisation de la mémoire. Bien que le point exact auquel cela sera appelé n’est pas défini, il se produit généralement lorsque tous les processus en arrière-plan ont été tués. Autrement dit, avant d’atteindre le point de tuer les processus d’hébergement du service d’hébergement et de l’interface utilisateur de premier plan que nous aimerions éviter de tuer. Cette méthode est toujours appelée sur le thread principal de l’application et ne doit pas effectuer de longues opérations. L’implémentation du fournisseur de contenu par défaut ne fait rien. Les sous-classes peuvent remplacer cette méthode pour prendre les mesures appropriées.

(Hérité de ContentProvider)
OnTrimMemory(TrimMemory)

Appelé lorsque le système d’exploitation a déterminé qu’il est judicieux qu’un processus supprime la mémoire inutile de son processus.

(Hérité de ContentProvider)
OpenAssetFile(Uri, String, CancellationSignal)

L’implémentation est fournie par la classe parente.

OpenAssetFile(Uri, String)

L’implémentation est fournie par la classe parente.

OpenDocument(String, String, CancellationSignal)

Ouvrez et retournez le document demandé.

OpenDocumentThumbnail(String, Point, CancellationSignal)

Ouvrez et retournez une miniature du document demandé.

OpenFile(Uri, String, CancellationSignal)

L’implémentation est fournie par la classe parente.

OpenFile(Uri, String)

L’implémentation est fournie par la classe parente.

OpenFileHelper(Uri, String)

Commodité pour les sous-classes qui souhaitent implémenter #openFile en recherchant une colonne nommée « _data » au niveau de l’URI donné.

(Hérité de ContentProvider)
OpenPipeHelper(Uri, String, Bundle, Object, ContentProvider+IPipeDataWriter)

Fonction d’assistance pour l’implémentation #openTypedAssetFile, pour la création d’un canal de données et d’un thread d’arrière-plan vous permettant de diffuser en continu des données générées vers le client.

(Hérité de ContentProvider)
OpenTypedAssetFile(Uri, String, Bundle, CancellationSignal)

L’implémentation est fournie par la classe parente.

OpenTypedAssetFile(Uri, String, Bundle)

L’implémentation est fournie par la classe parente.

OpenTypedDocument(String, String, Bundle, CancellationSignal)

Ouvrez et retournez le document dans un format correspondant au filtre de type MIME spécifié.

Query(Uri, String[], Bundle, CancellationSignal)

L’implémentation est fournie par la classe parente.

Query(Uri, String[], String, String[], String, CancellationSignal)

Implémentez cette opération pour gérer les requêtes des clients avec prise en charge de l’annulation.

(Hérité de ContentProvider)
Query(Uri, String[], String, String[], String)

L’implémentation est fournie par la classe parente.

QueryChildDocuments(String, String[], Bundle)

Remplacez cette méthode pour renvoyer les documents enfants contenus dans le répertoire demandé.

QueryChildDocuments(String, String[], String)

Retournez les documents enfants contenus dans le répertoire demandé.

QueryDocument(String, String[])

Retourne les métadonnées pour le document demandé unique.

QueryRecentDocuments(String, String[], Bundle, CancellationSignal)

Retournez des documents récemment modifiés sous la racine demandée.

QueryRecentDocuments(String, String[])

Retournez des documents récemment modifiés sous la racine demandée.

QueryRoots(String[])

Retournez toutes les racines actuellement fournies.

QuerySearchDocuments(String, String, String[])

Retourne des documents qui correspondent à la requête donnée sous la racine demandée.

QuerySearchDocuments(String, String[], Bundle)

Retourne des documents qui correspondent à la requête donnée sous la racine demandée.

Refresh(Uri, Bundle, CancellationSignal)

Implémentez cela pour prendre en charge l’actualisation du contenu identifié par uri.

(Hérité de ContentProvider)
RemoveDocument(String, String)

Supprime le document demandé ou une arborescence de documents.

RenameDocument(String, String)

Renommez un document existant.

RequireContext()

Récupère un contexte non Nullable dans lequel ce fournisseur s’exécute, il est destiné à être appelé après #onCreate.

(Hérité de ContentProvider)
RestoreCallingIdentity(ContentProvider+CallingIdentity)

Restaurez l’identité de l’IPC entrant sur le thread actuel vers une identité précédemment retournée par #clearCallingIdentity.

(Hérité de ContentProvider)
RevokeDocumentPermission(String)

Révoquez les octrois d’autorisations actifs pour le document donné Document#COLUMN_DOCUMENT_ID, généralement appelé lorsqu’un document devient non valide.

SetHandle(IntPtr, JniHandleOwnership)

Définit la propriété Handle.

(Hérité de Object)
SetPathPermissions(PathPermission[])

Modifiez l’autorisation basée sur le chemin nécessaire pour lire et/ou écrire des données dans le fournisseur de contenu.

(Hérité de ContentProvider)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
SetReadPermission(String)

Modifiez l’autorisation requise pour lire les données du fournisseur de contenu. Cela est normalement défini pour vous à partir de ses informations de manifeste lors de la création du fournisseur.

(Hérité de ContentProvider)
SetWritePermission(String)

Modifiez l’autorisation requise pour écrire des données dans le fournisseur de contenu. Cela est normalement défini pour vous à partir de ses informations de manifeste lors de la création du fournisseur.

(Hérité de ContentProvider)
Shutdown()

Implémentez cette opération pour arrêter l’instance ContentProvider.

(Hérité de ContentProvider)
ToArray<T>()

Crée un tableau managé à partir de ce wrapper de tableau Java.

(Hérité de Object)
ToString()

Retourne une représentation sous forme de chaîne de l’objet.

(Hérité de Object)
Uncanonicalize(Uri)

Supprimez la canonisation des URI canoniques précédemment retournés par #canonicalize.

(Hérité de ContentProvider)
UnregisterFromRuntime()

Annule l’inscription de cet homologue Java à partir du runtime d’interopérabilité.

(Hérité de Object)
Update(Uri, ContentValues, Bundle)

Implémentez ceci pour gérer les demandes de mise à jour d’une ou plusieurs lignes.

(Hérité de ContentProvider)
Update(Uri, ContentValues, String, String[])

L’implémentation est fournie par la classe parente.

Wait()

Provoque l’attente du thread actuel jusqu’à ce qu’il soit réveillé, généralement en étant <averti par em ou><em>interrompu</em>.<>

(Hérité de Object)
Wait(Int64, Int32)

Provoque l’attente du thread actuel jusqu’à ce qu’il soit réveillé, généralement en étant <averti> par< em>ou <em>interrompu/em<,> ou jusqu’à ce qu’une certaine quantité de temps réel s’est écoulée.

(Hérité de Object)
Wait(Int64)

Provoque l’attente du thread actuel jusqu’à ce qu’il soit réveillé, généralement en étant <averti> par< em>ou <em>interrompu/em<,> ou jusqu’à ce qu’une certaine quantité de temps réel s’est écoulée.

(Hérité de Object)

Implémentations d’interfaces explicites

Nom Description
IJavaPeerable.Disposed()

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.Finalized()

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Classe de base pour un fournisseur de documents.

(Hérité de JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Classe de base pour un fournisseur de documents.

(Hérité de ContentProvider)

Méthodes d’extension

Nom Description
GetJniTypeName(IJavaPeerable)

Obtient le nom JNI du type de l’instance self.

JavaAs<TResult>(IJavaPeerable)

Essayez de forcer self le typeTResult, en vérifiant que le forçage est valide côté Java.

JavaCast<TResult>(IJavaObject)

Effectue une conversion de type vérifiée par le runtime Android.

JavaCast<TResult>(IJavaObject)

Classe de base pour un fournisseur de documents.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Essayez de forcer self le typeTResult, en vérifiant que le forçage est valide côté Java.

S’applique à