public static abstract class

AssociatedIdentifiers.Editor

extends Object
java.lang.Object
   ↳ com.urbanairship.analytics.AssociatedIdentifiers.Editor

Class Overview

Interface use to modify identifiers in the AssociatedIdentifiers object. All changes you make in the editor are batched, and not saved until you call apply().

Summary

Public Constructors
Editor()
Public Methods
AssociatedIdentifiers.Editor addIdentifier(String key, String value)
Adds an identifier.
void apply()
Applies the identifiers changes.
AssociatedIdentifiers.Editor clear()
Clears all the identifiers.
AssociatedIdentifiers.Editor removeAdvertisingId()
Removes both the Android advertising ID and the limit ad tracking enabled value.
AssociatedIdentifiers.Editor removeIdentifier(String key)
Removes the identifier.
AssociatedIdentifiers.Editor setAdvertisingId(String adId, boolean limitAdTrackingEnabled)
Sets the Android advertising ID and the limit ad tracking enabled value.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Editor ()

Public Methods

public AssociatedIdentifiers.Editor addIdentifier (String key, String value)

Adds an identifier.

Parameters
key The custom ID's key.
value The custom ID's value.
Returns
  • The editor object.

public void apply ()

Applies the identifiers changes.

public AssociatedIdentifiers.Editor clear ()

Clears all the identifiers.

Identifiers will be cleared first during apply, then the other operations will be applied.

Returns
  • The editor object.

public AssociatedIdentifiers.Editor removeAdvertisingId ()

Removes both the Android advertising ID and the limit ad tracking enabled value.

Returns
  • The editor object.

public AssociatedIdentifiers.Editor removeIdentifier (String key)

Removes the identifier.

Parameters
key The custom ID's key.
Returns
  • The editor object.

public AssociatedIdentifiers.Editor setAdvertisingId (String adId, boolean limitAdTrackingEnabled)

Sets the Android advertising ID and the limit ad tracking enabled value.

Parameters
adId The Android advertising ID.
limitAdTrackingEnabled A boolean indicating whether the user has limit ad tracking enabled or not.
Returns
  • The editor object.