# Package com.codename1.documents

package com.codename1.documents

Exposes an app's documents to the system file browser -- the Files app on iOS and the storage picker on Android -- so its content is browsable, and openable by other apps, without the app being launched.

Start at `DocumentProvider`. Build a tree of `DocumentNode`s, point each file either at bytes under `DocumentProvider.getSharedDirectory()` or at a key your HTTPS endpoint understands, and publish it. `DocumentIndexSerializer` is the on-disk format the platform readers consume, and is public so tests and tooling can read what was published.

See the Document Provider chapter of the developer guide for the build hints, the endpoint contract and the signing setup, which the Certificate Wizard can perform for you.

- Related Packages
  Package
  Description
  com.codename1.documents.spi
  The platform seam of the document provider framework.
- Classes
  Class
  Description
  DocumentIndexSerializer
  Converts a published document tree to and from the `index.json` the platform readers consume.
  DocumentNode
  One entry in the tree an app publishes through `DocumentProvider`: a folder or a file, as the system file browser will show it.
  DocumentProvider
  The static entry point for exposing your app's documents to the system file browser: the Files app on iOS, the storage picker on Android.