com.yandex.metrica.profile

Class StringAttribute

java.lang.Object

com.yandex.metrica.profile.StringAttribute

Direct Known Subclasses:

NameAttribute

public class StringAttribute
extends java.lang.Object

The string attribute class. It enables creating custom string attribute for the user profile.

EXAMPLE:

      UserProfile userProfile = new UserProfile.Builder()
                     .apply(Attribute.customString("favorite_country").withValue("Russia"))
                     .build();
 

Method Summary

Modifier and Type	Method and Description
UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher>	withValue(java.lang.String value) Updates the string attribute with the specified value.
UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher>	withValueIfUndefined(java.lang.String value) Updates the attribute with the specified value only if the attribute value is undefined.
UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher>	withValueReset() Resets the attribute value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withValue

@NonNull
public UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher> withValue(@NonNull
                                                                                                                java.lang.String value)

Updates the string attribute with the specified value.

Parameters:

value - String value

Returns:

The UserProfileUpdate object

withValueIfUndefined

@NonNull
public UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher> withValueIfUndefined(@NonNull
                                                                                                                           java.lang.String value)

Updates the attribute with the specified value only if the attribute value is undefined. The method doesn't affect the value if it has been set earlier.

Parameters:

value - String value

Returns:

The UserProfileUpdate object

withValueReset

@NonNull
public UserProfileUpdate<? extends com.yandex.metrica.impl.profile.UserProfileUpdatePatcher> withValueReset()

Resets the attribute value.

Returns:

The UserProfileUpdate object