File Search

File search provider plugins need to extend the FileProvider class:

class MyFileSearchPlugin : FileProvider(
    QueryPluginConfig()
)

In the super constructor call, pass a QueryPluginConfig object.

Plugin config

Search plugins have the following configuration properties:

• storageStrategy: Describes how the launcher should store a search result in its internal database. This is relevant when a user pins a search result to favorites, or when they assign a tag or custom label. In these situations, the launcher needs to be able to restore the search result from its database. There are two different strategies:
  • StorageStrategy.StoreCopy (default): The launcher stores all relevant information about this search result in its own internal database. The result can be restored without querying the plugin again. The launcher will try refresh the search result at its own discretion (e.g. when a user long-presses a restored search result to view its details). This strategy is the default and should be used whenever the plugin can't restore a search result immediately. It is best suited for online search plugins.
  • StorageStrategy.StoreReference: The launcher only stores the ID of the search result, and the plugin that created it. To restore a result, the plugin is queried again. This allows the plugin to update key fields (i.e. the label) immediately. However, plugins that use this strategy must guarantee, that they can restore a search result at any time, in a timely manner. In particular, the plugin must be able to restore a search result without any network requests. This strategy is best suited for on-device search plugins.

Search files

To implement file search, override

suspend fun search(query: String, params: SearchParams): List<File>

• query is the search term

• params provides additional parameters for the search:

  • allowNetwork is a flag that indicates whether the user has enabled online search for this query. Plugins are generally advised to respect this request. This flag exists mainly for privacy reasons: the majority of searches target offline results (like apps, or contacts). Sending every single search request to external servers is overkill and can be a privacy issue. (Besides, it's not very nice to overload servers with unnecessary requests.) To reduce the amount of data that is sent to external servers, users can control, whether a search should include online results or not.
  • lang is the current language of the launcher. This can differ from the system language, as the user can set a different language per app. This value should be used for any localization in the search results.

search returns a list of Files. The list can be empty if no results were found.

The File object

A File has the following properties:

• id: A unique and stable identifier for this file. This is used to track usage stats so if two files are identical, they must have the same ID, and if they are different, they need to have different IDs.
• uri: A URI that is used to open the file.
• displayName: The name that is shown to the user
• mimeType: The MIME type of the file. This is only used for informational purposes, i.e. to determine the icon.
• size: The file size in bytes.
• path: The file path. This is shown for informational purposes. It is not used to read or open the file.
• isDirectory: Whether the file is a folder. If true, a folder icon is shown.
• thumbnailUri: An optional URI to a file thumbnail. Supported schemes are: content, file, android.resource, http, and https. If this is a content URI, make sure that the launcher has the permissions to access it.
• owner: The name of the owner of the file. This is mainly relevant for files that are stored in a cloud drive and are not owned by the user themselves, but shared with them.
• metadata: Additional file metadata.

Refresh a file

If you have set config.storageStrategy to StorageStrategy.StoreCopy, the launcher will periodically try to refresh the stored copy. This happens for example when a user long-presses a file to view its details. To update the file, you can override

suspend fun refresh(item: File, params: RefreshParams): File?

The stored file will be replaced with the return value of this method. If the file is no longer available, it should return null. In this case, the launcher will remove it from its database. If the file is temporarily unavailable, an exception should be thrown.

• item is the version that the launcher has currently stored

• params provides additional parameters:

  • lang is the current language of the launcher. This can differ from the system language, as the user can set a different language per app. This value should be used to localize the result.
  • lastUpdated the timestamp (in milliseconds) when item was last updated. This should be used to determine if the item needs to be refreshed again. If you decide not to refresh the item, you should return the original item parameter.

The default implementation returns item without any changes.

Get a file

If you have set config.storageStrategy to StorageStrategy.StoreReference, you must override

suspend fun get(id: String, params: GetParams): File?

This method is used to lookup a file by its id. If the file is no longer available, it should return null. In this case, the launcher will remove it from its database.

• id is the ID of the file that is being requested

• params provides additional parameters:

  • lang is the current language of the launcher. This can differ from the system language, as the user can set a different language per app. This value should be used to localize the result.

Plugin state

Some plugins need to be configured before they can be used. For example, users might need to connect an account, or provide an API key.

If your plugin has such requirements, you can override

suspend fun getPluginState(): PluginState

This method can either return PluginState.Ready, or PluginState.SetupRequired.

• PluginState.Ready can have a status text to describe what the plugin does in its current configuration. For example "Search {username}'s files on {service}". This overrides the plugin's description.
• PluginState.SetupRequired needs to have a setupActivity Intent that starts the setup. You can also provide a message to describe what kind of setup needs to be performed. For example "Sign in with {service} to search files on {service}"

IMPORTANT

This method is only meant to provide hints to the launcher's user interface. You should not rely on it as a safeguard for your other plugin methods. There is still a chance that your other plugin methods are called regardless of the return value of this method. Make sure to check your requirements in the other plugin methods as well.

Examples

• OneDrive plugin