Stay organized with collections
Save and categorize content based on your preferences.
CorrelationData
class
CorrelationData
Direct use of CorrelationData
is not supported.
Tracks identifiers and their lifespans so that identifiers expire after a period of time.
Summary
Get the DeviceAnalyticsInfo contained in this instance.
Get the currently valid identifiers from this correlation data.
Creates a brand new instance with new CID and EDIDs.
Public methods
getAnalyticsInfo
fun
getAnalyticsInfo
(
)
:
AnalyticsInfo
Get the DeviceAnalyticsInfo contained in this instance.
getIdentifiers
fun
getIdentifiers
(
)
:
Identifiers
Get the currently valid identifiers from this correlation data.
Companion functions
createNew
fun
createNew
(
)
:
CorrelationData
Creates a brand new instance with new CID and EDIDs.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 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 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eCorrelationData\u003c/code\u003e manages identifiers and their lifespans, ensuring expiration after a set time.\u003c/p\u003e\n"],["\u003cp\u003eIt's used internally and direct usage isn't supported by the library.\u003c/p\u003e\n"],["\u003cp\u003eProvides methods to access and create CorrelationData instances with varying identifier sets.\u003c/p\u003e\n"],["\u003cp\u003eSupports the creation of \u003ccode\u003eCorrelationData\u003c/code\u003e instances from existing data and child instances.\u003c/p\u003e\n"],["\u003cp\u003eIncludes functions to retrieve analytics information and valid identifiers.\u003c/p\u003e\n"]]],["`CorrelationData` tracks identifiers and their lifespans, managing identifier expiration. It provides access to `AnalyticsInfo` and currently valid `Identifiers`. The class offers functions to create instances: `createFromAnalyticsInfo` restores a serialized instance, `createNew` generates a fresh instance with new identifiers, and `createParentFromChild` recreates a parent from a child instance. `getAnalyticsInfo` retrieves device analytics, while `getIdentifiers` fetches valid identifiers. Direct use of this is not supported.\n"],null,["# CorrelationData\n===============\n\n```\nclass CorrelationData\n```\n\n|---|------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [com.google.android.gms.dtdi.analytics.CorrelationData](#) |\n\nDirect use of `CorrelationData` is not supported.\n\nTracks identifiers and their lifespans so that identifiers expire after a period of time.\n\nSummary\n-------\n\n| ### Public methods ||\n|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|\n| [AnalyticsInfo](../core/AnalyticsInfo.html#) | [getAnalyticsInfo](#getAnalyticsInfo())`()` Get the DeviceAnalyticsInfo contained in this instance. |\n| [Identifiers](/android/reference/com/google/android/gms/dtdi/analytics/Identifiers) | [getIdentifiers](#getIdentifiers())`()` Get the currently valid identifiers from this correlation data. |\n\n| ### Companion functions ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CorrelationData](#) | [createFromAnalyticsInfo](#Companion.createFromAnalyticsInfo(com.google.android.gms.dtdi.core.AnalyticsInfo))`(`analyticsInfo:` `[AnalyticsInfo](../core/AnalyticsInfo.html#)`)` Restores an instance of [CorrelationData](#) from its serialized form. |\n| [CorrelationData](#) | [createNew](#Companion.createNew())`()` Creates a brand new instance with new CID and EDIDs. |\n| [CorrelationData](#) | [createParentFromChild](#Companion.createParentFromChild(com.google.android.gms.dtdi.analytics.CorrelationData))`(`childCorrelationData:` `[CorrelationData](#)`)` Recreates a parent [CorrelationData](#) from a child [CorrelationData](#). |\n\nPublic methods\n--------------\n\n### getAnalyticsInfo\n\n```\nfun getAnalyticsInfo(): AnalyticsInfo\n```\n\nGet the DeviceAnalyticsInfo contained in this instance. \n\n### getIdentifiers\n\n```\nfun getIdentifiers(): Identifiers\n```\n\nGet the currently valid identifiers from this correlation data.\n\nCompanion functions\n-------------------\n\n### createFromAnalyticsInfo\n\n```\nfun createFromAnalyticsInfo(analyticsInfo: AnalyticsInfo): CorrelationData\n```\n\nRestores an instance of [CorrelationData](#) from its serialized form. \n\n### createNew\n\n```\nfun createNew(): CorrelationData\n```\n\nCreates a brand new instance with new CID and EDIDs. \n\n### createParentFromChild\n\n```\nfun createParentFromChild(childCorrelationData: CorrelationData): CorrelationData\n```\n\nRecreates a parent [CorrelationData](#) from a child [CorrelationData](#)."]]
