AI2 Component  (Version nb184)
Public Member Functions | List of all members
com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement Interface Reference

Public Member Functions

String path () default ""
 
String pathPrefix () default ""
 
String pathPattern () default ""
 
String permission () default ""
 
String readPermission () default ""
 
String writePermission () default ""
 

Detailed Description

Defines the path and required permissions for a specific subset of data within a <provider>. This element can be specified multiple times to supply multiple paths.

Note: Most of this documentation is adapted from the Android framework specification linked below. That documentation is licensed under the ahref="https://creativecommons.org/licenses/by/2.5/">CreativeCommonsAttributionlicensev2.5</a>.See@link<ahref="https://developer.android.com/guide/topics/manifest/path-permission-element">https://developer.android.com/guide/topics/manifest/path-permission-element</a>.@authorhttps://github.com/ShreyashSaitwal(ShreyashSaitwal)

Definition at line 32 of file PathPermissionElement.java.

Member Function Documentation

◆ path()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.path ( )

A complete URI path for a subset of content provider data. Permission can be granted only to the particular data identified by this path. When used to provide search suggestion content, it must be appended with "/search_suggest_query".

Returns
the path permission path attribute

◆ pathPattern()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.pathPattern ( )

A complete URI path for a subset of content provider data, but one that can use the following wildcards:

  • An asterisk ('*'). This matches a sequence of 0 to many occurrences of the immediately preceding character.
  • A period followed by an asterisk (".*"). This matches any sequence of 0 or more characters.

Because '\' is used as an escape character when the string is read from XML (before it is parsed as a pattern), you will need to double-escape. For example, a literal '*' would be written as "\\*" and a literal '\' would be written as "\\". This is basically the same as what you would need to write if constructing the string in Java code.

Returns
the path permission pathPattern attribute

◆ pathPrefix()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.pathPrefix ( )

The initial part of a URI path for a subset of content provider data. Permission can be granted to all data subsets with paths that share this initial part.

Returns
the path permission pathPrefix attribute

◆ permission()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.permission ( )

The name of a permission that clients must have in order to read or write the content provider's data. This attribute is a convenient way of setting a single permission for both reading and writing. However, the readPermission() and writePermission() attributes take precedence over this one.

Returns
the path permission permission attribute

◆ readPermission()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.readPermission ( )

A permission that clients must have in order to query the content provider.

Returns
the path permission readPermission attribute

◆ writePermission()

String com.google.appinventor.components.annotations.androidmanifest.PathPermissionElement.writePermission ( )

A permission that clients must have in order to make changes to the data controlled by the content provider.

Returns
the path permission writePermission attribute
The documentation for this interface was generated from the following file: