Stay organized with collections
Save and categorize content based on your preferences.
BundleSession
class BundleSession : AutoCloseable
An instances of this class represents a session with data stored in a bundle.
Summary
| Constants |
| static String |
A key describing the statsd atom into which to place this bundle's other contents.
|
Constants
KEY_STATSD_ATOM
static val KEY_STATSD_ATOM: String
A key describing the statsd atom into which to place this bundle's other contents. The associated value is an integer.
Value: "bundlesession-statsd-atom"
Public methods
close
fun close(): Unit
| Exceptions |
java.lang.Exception |
if this resource cannot be closed |
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x, x.equals(x) should return true.
- It is symmetric: for any non-null reference values
x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
- It is transitive: for any non-null reference values
x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
- It is consistent: for any non-null reference values
x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
- For any non-null reference value
x, x.equals(null) should return false.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters |
obj |
the reference object with which to compare. |
o |
This value may be null. |
| Return |
Boolean |
true if this object is the same as the obj argument; false otherwise. |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
reportBundleMetrics
fun reportBundleMetrics(metrics: PersistableBundle): Unit
Reports metrics via bundle. The key KEY_STATSD_ATOM references an integer value that indicates the statsd atom for the data in this bundle. Other keys and their types are defined on a per-atom basis.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# BundleSession\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nBundleSession\n=============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/media/metrics/BundleSession \"View this page in Java\") \n\n```\nclass BundleSession : AutoCloseable\n```\n\n|---|------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.media.metrics.BundleSession](#) |\n\nAn instances of this class represents a session with data stored in a bundle.\n\nSummary\n-------\n\n| Constants ||\n|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [KEY_STATSD_ATOM](#KEY_STATSD_ATOM:kotlin.String) A key describing the statsd atom into which to place this bundle's other contents. |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [close](#close())`()` \u003cbr /\u003e |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [LogSessionId](/reference/kotlin/android/media/metrics/LogSessionId) | [getSessionId](#getSessionId())`()` \u003cbr /\u003e |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` \u003cbr /\u003e |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [reportBundleMetrics](#reportBundleMetrics(android.os.PersistableBundle))`(`metrics:` `[PersistableBundle](../../os/PersistableBundle.html#)`)` Reports metrics via bundle. |\n\nConstants\n---------\n\n### KEY_STATSD_ATOM\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val KEY_STATSD_ATOM: String\n```\n\nA key describing the statsd atom into which to place this bundle's other contents. The associated value is an integer. \n\n Value: \"bundlesession-statsd-atom\"\n\n**See Also**\n\n- [#reportBundleMetrics](#reportBundleMetrics(android.os.PersistableBundle))\n\nPublic methods\n--------------\n\n### close\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun close(): Unit\n```\n\n| Exceptions ||\n|-----------------------|-----------------------------------|\n| `java.lang.Exception` | if this resource cannot be closed |\n\n### equals\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\nThe `equals` method implements an equivalence relation on non-null object references:\n\n- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.\n- It is *symmetric* : for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.\n- It is *transitive* : for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.\n- It is *consistent* : for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.\n- For any non-null reference value `x`, `x.equals(null)` should return `false`.\n\nAn equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `o` | This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### getSessionId\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun getSessionId(): LogSessionId\n```\n\n| Return ||\n|----------------------------------------------------------------------|------------------------------|\n| [LogSessionId](/reference/kotlin/android/media/metrics/LogSessionId) | This value cannot be `null`. |\n\n### hashCode\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |\n\n### reportBundleMetrics\n\nAdded in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun reportBundleMetrics(metrics: PersistableBundle): Unit\n```\n\nReports metrics via bundle. The key [KEY_STATSD_ATOM](#KEY_STATSD_ATOM:kotlin.String) references an integer value that indicates the statsd atom for the data in this bundle. Other keys and their types are defined on a per-atom basis.\n\n| Parameters ||\n|-----------|-------------------------------------------------------------------------------------|\n| `metrics` | [PersistableBundle](../../os/PersistableBundle.html#): This value cannot be `null`. |"]]
