User (sdk-java 20.11.0 API)

java.lang.Object
- ly.count.sdk.java.User

Direct Known Subclasses:

UserImpl
```
public abstract class User
extends java.lang.Object
```
User Profile object: stores profile and exposes stored data. Doesn't download profile from the server, so data is available only after setting it by using edit() and UserEditor.commit().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class User.Gender

Nested Classes
Modifier and Type	Class and Description
`static class`	`User.Gender`

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract java.lang.Integer`	`birthyear()` Current user year of birth
`abstract java.lang.String`	`city()` Current user city: "SOME CITY NAME" if set "" if set to do not record, that is user opt out from location services {code null} if not specified, geoip is used on the server
`abstract java.util.Set<java.lang.String>`	`cohorts()` Current user cohorts set
`abstract java.lang.String`	`country()` Current user country: "ISO_CODE" of the country if set "" if set to do not record, that is user opt out from location services {code null} if not specified, geoip is used on the server
`abstract java.util.Map<java.lang.String,java.lang.Object>`	`custom()` Current user custom data map
`abstract UserEditor`	`edit()` Edit this user.
`abstract java.lang.String`	`email()` Current user email
`abstract User.Gender`	`gender()` Current user gender
`abstract java.lang.String`	`id()` Current device id
`abstract java.lang.String`	`locale()` Current user locale in "lang_COUNTRY", like en_US or de_DE if default device locale is overridden.
`abstract java.lang.String`	`location()` Current user location (string of "LAT,LON" format): "LAT,LON" if set "" if set to do not record, that is user opt out from location services {code null} if not specified, geoip is used on the server
`abstract java.lang.String`	`name()` Current user name
`abstract java.lang.String`	`org()` Current user organization
`abstract java.lang.String`	`phone()` Current user phone
`abstract byte[]`	`picture()` Current user picture
`abstract java.lang.String`	`picturePath()` Current user picture path
`abstract java.lang.String`	`username()` Current username

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - id
```
public abstract java.lang.String id()
```
    Current device id
    
    Returns:
    
    id string if device id available, null otherwise
  - name
```
public abstract java.lang.String name()
```
    Current user name
    
    Returns:
    
    name string if it was set previously, null otherwise
  - username
```
public abstract java.lang.String username()
```
    Current username
    
    Returns:
    
    username string if it was set previously, null otherwise
  - email
```
public abstract java.lang.String email()
```
    Current user email
    
    Returns:
    
    email string if it was set previously, null otherwise
  - org
```
public abstract java.lang.String org()
```
    Current user organization
    
    Returns:
    
    organization string if it was set previously, null otherwise
  - phone
```
public abstract java.lang.String phone()
```
    Current user phone
    
    Returns:
    
    phone string if it was set previously, null otherwise
  - picture
```
public abstract byte[] picture()
```
    Current user picture
    
    Returns:
    
    picture bytes if it was set previously, null otherwise
  - picturePath
```
public abstract java.lang.String picturePath()
```
    Current user picture path
    
    Returns:
    
    picture path string if it was set previously, null otherwise
  - gender
```
public abstract User.Gender gender()
```
    Current user gender
    
    Returns:
    
    gender if it was set previously, null otherwise
  - birthyear
```
public abstract java.lang.Integer birthyear()
```
    Current user year of birth
    
    Returns:
    
    year of birth if it was set previously, null otherwise
  - locale
```
public abstract java.lang.String locale()
```
    Current user locale in "lang_COUNTRY", like en_US or de_DE if default device locale is overridden. If not set, Countly will use DeviceCore.getLocale().
    
    Returns:
    
    current user locale
  - country
```
public abstract java.lang.String country()
```
    Current user country:
    - "ISO_CODE" of the country if set
    - "" if set to do not record, that is user opt out from location services
    - {code null} if not specified, geoip is used on the server
    Returns:
    
    current user country
  - city
```
public abstract java.lang.String city()
```
    Current user city:
    - "SOME CITY NAME" if set
    - "" if set to do not record, that is user opt out from location services
    - {code null} if not specified, geoip is used on the server
    Returns:
    
    current user city
  - location
```
public abstract java.lang.String location()
```
    Current user location (string of "LAT,LON" format):
    - "LAT,LON" if set
    - "" if set to do not record, that is user opt out from location services
    - {code null} if not specified, geoip is used on the server
    Returns:
    
    current user location
  - cohorts
```
public abstract java.util.Set<java.lang.String> cohorts()
```
    Current user cohorts set
    
    Returns:
    
    cohorts if it was set previously, null otherwise
  - custom
```
public abstract java.util.Map<java.lang.String,java.lang.Object> custom()
```
    Current user custom data map
    
    Returns:
    
    custom data if it was set previously, empty map otherwise
  - edit
```
public abstract UserEditor edit()
```
    Edit this user. Changes only applied after UserEditor.commit() call.
    
    Returns:
    
    new UserEditor object

Class User

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

id

name

username

email

org

phone

picture

picturePath

gender

birthyear

locale

country

city

location

cohorts

custom

edit