public class Traits extends ValueMap
Traits can be anything you want, but some of them have semantic meaning and we treat them in special ways. For example, whenever we see an email trait, we expect it to be the user's email address. And we'll send this on to integrations that need an email, like Mailchimp. For that reason, you should only use special traits for their intended purpose.
Traits are persisted to disk, and will be remembered between application and system reboots.
Modifier and Type | Class and Description |
---|---|
static class |
Traits.Address
Represents information about the address of a user or group.
|
Modifier and Type | Method and Description |
---|---|
Traits.Address |
address() |
int |
age() |
java.lang.String |
anonymousId() |
java.lang.String |
avatar() |
java.util.Date |
birthday() |
java.lang.String |
createdAt() |
java.lang.String |
currentId()
Returns the currentId the user is identified with.
|
java.lang.String |
description() |
java.lang.String |
email() |
long |
employees() |
java.lang.String |
fax() |
java.lang.String |
firstName() |
java.lang.String |
gender() |
java.lang.String |
industry() |
java.lang.String |
lastName() |
java.lang.String |
name() |
java.lang.String |
phone() |
Traits |
putAddress(Traits.Address address)
Set an address for the user or group.
|
Traits |
putAge(int age)
Set the age of a user.
|
Traits |
putAvatar(java.lang.String avatar)
Set a URL to an avatar image for the user or group.
|
Traits |
putBirthday(java.util.Date birthday)
Set the user's birthday.
|
Traits |
putCreatedAt(java.lang.String createdAt)
Set the date the user’s or group’s account was first created.
|
Traits |
putDescription(java.lang.String description)
Set a description of the user or group, like a personal bio.
|
Traits |
putEmail(java.lang.String email)
Set the email address of a user or group.
|
Traits |
putEmployees(long employees)
Set the number of employees of a group, typically used for companies.
|
Traits |
putFax(java.lang.String fax)
Set the fax number of a user or group.
|
Traits |
putFirstName(java.lang.String firstName)
Set the first name of a user.
|
Traits |
putGender(java.lang.String gender)
Set the gender of a user.
|
Traits |
putIndustry(java.lang.String industry)
Set the industry the user works in, or a group is part of.
|
Traits |
putLastName(java.lang.String lastName)
Set the last name of a user.
|
Traits |
putName(java.lang.String name)
Set the name of a user or group.
|
Traits |
putPhone(java.lang.String phone)
Set the phone number of a user or group.
|
Traits |
putTitle(java.lang.String title)
Set the title of a user, usually related to their position at a specific company, for example
"VP of Engineering"
|
Traits |
putUsername(java.lang.String username)
Set the user’s username.
|
Traits |
putValue(java.lang.String key,
java.lang.Object value)
Helper method to be able to chain put methods.
|
Traits |
putWebsite(java.lang.String website)
Set the website of a user or group.
|
java.lang.String |
title() |
Traits |
unmodifiableCopy() |
java.lang.String |
userId() |
java.lang.String |
username() |
java.lang.String |
website() |
clear, containsKey, containsValue, entrySet, equals, get, getBoolean, getChar, getDouble, getEnum, getFloat, getInt, getList, getLong, getString, getValueMap, getValueMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toJsonObject, toString, toStringMap, values
public Traits unmodifiableCopy()
public java.lang.String userId()
public java.lang.String anonymousId()
public java.lang.String currentId()
public Traits putAddress(Traits.Address address)
public Traits.Address address()
public Traits putAge(int age)
public int age()
public Traits putAvatar(java.lang.String avatar)
public java.lang.String avatar()
public Traits putBirthday(java.util.Date birthday)
public java.util.Date birthday()
public Traits putCreatedAt(java.lang.String createdAt)
public java.lang.String createdAt()
public Traits putDescription(java.lang.String description)
public java.lang.String description()
public Traits putEmail(java.lang.String email)
public java.lang.String email()
public Traits putEmployees(long employees)
public long employees()
public Traits putFax(java.lang.String fax)
public java.lang.String fax()
public Traits putFirstName(java.lang.String firstName)
public java.lang.String firstName()
public Traits putGender(java.lang.String gender)
public java.lang.String gender()
public Traits putIndustry(java.lang.String industry)
public java.lang.String industry()
public Traits putLastName(java.lang.String lastName)
public java.lang.String lastName()
public Traits putName(java.lang.String name)
public java.lang.String name()
public Traits putPhone(java.lang.String phone)
public java.lang.String phone()
public Traits putTitle(java.lang.String title)
public java.lang.String title()
public Traits putUsername(java.lang.String username)
public java.lang.String username()
public Traits putWebsite(java.lang.String website)
public java.lang.String website()