io.supportkit.core

Class User

java.lang.Object

io.supportkit.core.User

public final class User
extends java.lang.Object

Object representing the current user.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Adds custom properties to the user.
static User	getCurrentUser() Returns the object representing the current user.
void	setEmail(java.lang.String email) The user's email, to be used to display a gravatar.
void	setFirstName(java.lang.String firstName) The user's first name, to be used as part of the display name when sending messages.
void	setLastName(java.lang.String lastName) The user's last name, to be used as part of the display name when sending messages.
void	setSignedUpAt(java.util.Date signedUpAt) The date the user started using your service.

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentUser

public static User getCurrentUser()

Returns the object representing the current user.

Returns:

The current user

setEmail

public void setEmail(java.lang.String email)

The user's email, to be used to display a gravatar.

Parameters:

email - The email

setFirstName

public void setFirstName(java.lang.String firstName)

The user's first name, to be used as part of the display name when sending messages.

Parameters:

firstName - The first name

setLastName

public void setLastName(java.lang.String lastName)

The user's last name, to be used as part of the display name when sending messages.

Parameters:

lastName - The last name

setSignedUpAt

public void setSignedUpAt(java.util.Date signedUpAt)

The date the user started using your service. This can be used to create Whispers for user onboarding.

Parameters:

signedUpAt - The sign up date

addProperties

public void addProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Adds custom properties to the user. This info is used to provide more context around who a user is.

Values must be of type String, Integer, Long, Float, Double, or Date; any other type will be converted to String using the toString() method.

Changes to user properties are uploaded in batches every 60 seconds, or when the app is sent to the background. This API is additive, and subsequent calls will override values for the provided keys.

Parameters:

properties - Map of properties