com.captainup.android.core.model

Interface IntegrationUser

All Superinterfaces:

CaptainUpObject

All Known Subinterfaces:

SignedIntegrationUser

public interface IntegrationUser
extends CaptainUpObject

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getCustomData() You can add any other field that you want to the user data, provided it’s not a nested field, and that it contains a boolean, String or numeric value.
java.lang.String	getDisplayName() The user's display name.
java.lang.String	getEmail() The user's email address.
java.lang.String	getFirstName() The user's first name
java.lang.String	getID() Required.
java.lang.String	getImageURL() A full URL to the user's profile image
java.lang.String	getLastName() The user's last name
java.lang.String	getName() The user's full name.
java.lang.String	getURL() The URL to the uesr's page of your app, or the user's website.

Method Detail

getID

java.lang.String getID()

Required. Your own unique ID for the user.

Returns:

the user's unique ID

getName

java.lang.String getName()

The user's full name.

Returns:

the user's full name

getDisplayName

java.lang.String getDisplayName()

The user's display name.

Returns:

the user's display name.

getFirstName

java.lang.String getFirstName()

The user's first name

Returns:

the user's first name

getLastName

java.lang.String getLastName()

The user's last name

Returns:

the user's last name

getImageURL

java.lang.String getImageURL()

A full URL to the user's profile image

Returns:

the URL to the uers's profile image

getEmail

java.lang.String getEmail()

The user's email address.

Returns:

the user's email address

getURL

java.lang.String getURL()

The URL to the uesr's page of your app, or the user's website.

Returns:

the user's associated URL.

getCustomData

java.util.Map<java.lang.String,java.lang.Object> getCustomData()

You can add any other field that you want to the user data, provided it’s not a nested field, and that it contains a boolean, String or numeric value. You can use this data later to segment your users, create badge conditions or see reports and analyze your actions and users.

Returns:

a map of additional parameters for the user.