.. This file was automatically generated by RstDoclet. Do not touch.

.. _ProfilePropertiesEditor:

ProfilePropertiesEditor
=======================

Profile properties are user properties that are attached to all events you track.
This class allows you to set some common user properties as well as define your own custom ones.

**Example**

Updates the gender and Facebook ID super properties:

.. code-block:: java

    Analytics analytics = Analytics.getInstance();
    ProfilePropertiesEditor profileEditor = analytics.getProfilePropertiesEditor();
    profileEditor.setGender(Gender.FEMALE);
    profileEditor.setFacebookId("314159265358979323846");

Public methods
--------------

setAge(int age)
^^^^^^^^^^^^^^^

Updates the age of the current user. Use zero to remove this.


----------

setGender(Gender gender)
^^^^^^^^^^^^^^^^^^^^^^^^

Updates the gender of the current user. Use ``null`` to remove this property.


----------

setUserId(String userId)
^^^^^^^^^^^^^^^^^^^^^^^^

Updates the game ID of the current user. Use ``null`` to remove this property.


----------

setFacebookId(String facebookId)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Updates the Facebook ID of the current user. Use ``null`` to remove this property.


----------

setPushEnabled(boolean pushEnabled)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Updates the state of the push settings for the current user.


----------

setPushToken(String pushToken)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Updates the Push token of the current user. Use ``null`` to remove this property.


----------

setStore(String store)
^^^^^^^^^^^^^^^^^^^^^^

Updates the store used current user. Use ``null`` to remove this property.


----------

setLat(Double lat)
^^^^^^^^^^^^^^^^^^

Updates the latitude used current user. Use ``null`` to remove this property.


----------

setLng(Double lng)
^^^^^^^^^^^^^^^^^^

Updates the longitude used current user. Use ``null`` to remove this property.


----------

setCustomProperty(String key, String value)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Set a custom property for this user. ``key`` cannot be null. Use ``null`` value to remove
this property.