Added in API level 1
ContentUris
open class ContentUris
| kotlin.Any | |
| ↳ | android.content.ContentUris |
Utility methods useful for working with android.net.Uri objects that use the "content" (content://) scheme.
Content URIs have the syntax
content://authority/path/id
-
content: - The scheme portion of the URI. This is always set to
ContentResolver.SCHEME_CONTENT(valuecontent://). - authority
- A string that identifies the entire content provider. All the content URIs for the provider start with this string. To guarantee a unique authority, providers should consider using an authority that is the same as the provider class' package identifier.
- path
- Zero or more segments, separated by a forward slash (
/), that identify some subset of the provider's data. Most providers use the path part to identify individual tables. Individual segments in the path are often called "directories" although they do not refer to file directories. The right-most segment in a path is often called a "twig" - id
- A unique numeric identifier for a single row in the subset of data identified by the preceding path part. Most providers recognize content URIs that contain an id part and give them special handling. A table that contains a column named
_IDoften expects the id part to be a particular value for that column.
Summary
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| open static Uri.Builder |
appendId(builder: Uri.Builder, id: Long)Appends the given ID to the end of the path. |
| open static Long |
Converts the last path segment to a long. |
| open static Uri |
Removes any ID from the end of the path. |
| open static Uri |
withAppendedId(contentUri: Uri, id: Long)Appends the given ID to the end of the path. |
Public constructors
ContentUris
ContentUris()
Public methods
appendId
Added in API level 1
open static fun appendId(
builder: Uri.Builder,
id: Long
): Uri.Builder
Appends the given ID to the end of the path.
| Parameters | |
|---|---|
builder |
Uri.Builder: to append the ID to This value cannot be null. |
id |
Long: to append |
| Return | |
|---|---|
Uri.Builder |
the given builder This value cannot be null. |
parseId
Added in API level 1
open static fun parseId(contentUri: Uri): Long
Converts the last path segment to a long.
This supports a common convention for content URIs where an ID is stored in the last segment.
| Parameters | |
|---|---|
contentUri |
Uri: This value cannot be null. |
| Return | |
|---|---|
Long |
the long conversion of the last segment or -1 if the path is empty |
| Exceptions | |
|---|---|
java.lang.UnsupportedOperationException |
if this isn't a hierarchical URI |
java.lang.NumberFormatException |
if the last segment isn't a number |
removeId
Added in API level 29
open static fun removeId(contentUri: Uri): Uri
Removes any ID from the end of the path.
| Parameters | |
|---|---|
contentUri |
Uri: that ends with an ID This value cannot be null. |
| Return | |
|---|---|
Uri |
a new URI with the ID removed from the end of the path This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
when the given URI has no ID to remove from the end of the path |
withAppendedId
Added in API level 1
open static fun withAppendedId(
contentUri: Uri,
id: Long
): Uri
Appends the given ID to the end of the path.
| Parameters | |
|---|---|
contentUri |
Uri: to start with This value cannot be null. |
id |
Long: to append |
| Return | |
|---|---|
Uri |
a new URI with the given ID appended to the end of the path This value cannot be null. |