Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W 

A

add(byte[]) - Method in class com.segment.analytics.QueueFile
Adds an element to the end of the queue.
add(byte[], int, int) - Method in class com.segment.analytics.QueueFile
Adds an element to the end of the queue.
address() - Method in class com.segment.analytics.Traits
 
Address() - Constructor for class com.segment.analytics.Traits.Address
 
Address(Map<String, Object>) - Constructor for class com.segment.analytics.Traits.Address
 
age() - Method in class com.segment.analytics.Traits
 
alias(String) - Method in class com.segment.analytics.Analytics
 
alias(String, Options) - Method in class com.segment.analytics.Analytics
The alias method is used to merge two user identities, effectively connecting two sets of user data as one.
alias(AliasPayload) - Method in class com.segment.analytics.integrations.Integration
 
AliasPayload - Class in com.segment.analytics.integrations
 
AliasPayload.Builder - Class in com.segment.analytics.integrations
Fluent API for creating AliasPayload instances.
ALL_INTEGRATIONS_KEY - Static variable in class com.segment.analytics.Options
A special key, whose value which is respected for all integrations, a "default" value, unless explicitly overridden.
Analytics - Class in com.segment.analytics
The entry point into the Segment for Android SDK.
Analytics.Builder - Class in com.segment.analytics
Fluent API for creating Analytics instances.
Analytics.BundledIntegration - Enum in com.segment.analytics
Deprecated. 
Analytics.Callback<T> - Interface in com.segment.analytics
A callback interface that is invoked when the Analytics client initializes bundled integrations.
Analytics.LogLevel - Enum in com.segment.analytics
Controls the level of logging.
AnalyticsContext - Class in com.segment.analytics
Context is a dictionary of free-form information about the state of the device.
AnalyticsContext.Campaign - Class in com.segment.analytics
Information about the campaign that resulted in the API call, containing name, source, medium, term and content.
AnalyticsContext.Device - Class in com.segment.analytics
Information about the device.
AnalyticsContext.Location - Class in com.segment.analytics
Information about the location of the device.
AnalyticsContext.Referrer - Class in com.segment.analytics
Information about the referrer that resulted in the API call.
AnalyticsNetworkExecutorService() - Constructor for class com.segment.analytics.internal.Utils.AnalyticsNetworkExecutorService
 
AnalyticsThreadFactory() - Constructor for class com.segment.analytics.internal.Utils.AnalyticsThreadFactory
 
anonymousId() - Method in class com.segment.analytics.integrations.BasePayload
The anonymous ID is an identifier that uniquely (or close enough) identifies the user, but isn't from your database.
anonymousId(String) - Method in class com.segment.analytics.integrations.BasePayload.Builder
The Anonymous ID is a pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier.
anonymousId() - Method in class com.segment.analytics.Traits
 
assertNotNull(T, String) - Static method in class com.segment.analytics.internal.Utils
Throws a NullPointerException if the given object is null.
assertNotNullOrEmpty(String, String) - Static method in class com.segment.analytics.internal.Utils
Throws a NullPointerException if the given text is null or empty.
assertNotNullOrEmpty(Map<K, V>, String) - Static method in class com.segment.analytics.internal.Utils
Throws a NullPointerException if the given map is null or empty.
attribution(String) - Method in class com.segment.analytics.ConnectionFactory
Return a HttpURLConnection that writes gets attribution information from https://mobile-service.segment.com/attribution.
avatar() - Method in class com.segment.analytics.Traits
 

B

BasePayload - Class in com.segment.analytics.integrations
A payload object that will be sent to the server.
BasePayload.Builder<P extends BasePayload,B extends BasePayload.Builder> - Class in com.segment.analytics.integrations
 
BasePayload.Channel - Enum in com.segment.analytics.integrations
The channel where the request originated from: server, browser or mobile.
BasePayload.Type - Enum in com.segment.analytics.integrations
 
birthday() - Method in class com.segment.analytics.Traits
 
BooleanPreference - Class in com.segment.analytics
 
BooleanPreference(SharedPreferences, String, boolean) - Constructor for class com.segment.analytics.BooleanPreference
 
buffer(InputStream) - Static method in class com.segment.analytics.internal.Utils
Buffers the given InputStream.
build() - Method in class com.segment.analytics.Analytics.Builder
Create a Analytics client.
build() - Method in class com.segment.analytics.Cartographer.Builder
 
build() - Method in class com.segment.analytics.integrations.BasePayload.Builder
Create a BasePayload instance.
Builder(Context, String) - Constructor for class com.segment.analytics.Analytics.Builder
Start building a new Analytics instance.
Builder() - Constructor for class com.segment.analytics.Cartographer.Builder
 
Builder() - Constructor for class com.segment.analytics.integrations.AliasPayload.Builder
 
Builder() - Constructor for class com.segment.analytics.integrations.GroupPayload.Builder
 
Builder() - Constructor for class com.segment.analytics.integrations.IdentifyPayload.Builder
 
Builder() - Constructor for class com.segment.analytics.integrations.ScreenPayload.Builder
 
Builder() - Constructor for class com.segment.analytics.integrations.TrackPayload.Builder
 

C

campaign() - Method in class com.segment.analytics.AnalyticsContext
 
Campaign() - Constructor for class com.segment.analytics.AnalyticsContext.Campaign
 
Cartographer - Class in com.segment.analytics
Cartographer creates Map objects from JSON encoded streams and decodes Map objects into JSON streams.
Cartographer.Builder - Class in com.segment.analytics
Fluent API to construct instances of Cartographer.
category(String) - Method in class com.segment.analytics.integrations.ScreenPayload.Builder
Deprecated.
category() - Method in class com.segment.analytics.integrations.ScreenPayload
Deprecated.
category() - Method in class com.segment.analytics.Properties
 
city() - Method in class com.segment.analytics.Traits.Address
 
clear() - Method in class com.segment.analytics.QueueFile
Clears this queue.
clear() - Method in class com.segment.analytics.ValueMap
 
close() - Method in class com.segment.analytics.QueueFile
Closes the underlying file.
closeQuietly(Closeable) - Static method in class com.segment.analytics.internal.Utils
Close the given Closeable.
coerceToFloat(Object, float) - Static method in class com.segment.analytics.internal.Utils
Returns the float representation at value if it exists and is a float or can be coerced to a float.
collectDeviceId(boolean) - Method in class com.segment.analytics.Analytics.Builder
Enable or disable collection of Settings.Secure.ANDROID_ID, Build.SERIAL or the Telephony Identifier retrieved via TelephonyManager as available.
com.segment.analytics - package com.segment.analytics
 
com.segment.analytics.integrations - package com.segment.analytics.integrations
 
com.segment.analytics.internal - package com.segment.analytics.internal
 
connectionFactory(ConnectionFactory) - Method in class com.segment.analytics.Analytics.Builder
Specify the connection factory for customizing how connections are created.
ConnectionFactory - Class in com.segment.analytics
Abstraction to customize how connections are created.
ConnectionFactory() - Constructor for class com.segment.analytics.ConnectionFactory
 
containsKey(Object) - Method in class com.segment.analytics.ValueMap
 
containsValue(Object) - Method in class com.segment.analytics.ValueMap
 
content() - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
context(Map<String, ?>) - Method in class com.segment.analytics.integrations.BasePayload.Builder
Set a map of information about the state of the device.
context() - Method in class com.segment.analytics.integrations.BasePayload
The context is a dictionary of extra information that provides useful context about a message, for example ip address or locale.
context() - Method in class com.segment.analytics.Options
Returns a copy of the context.
copySharedPreferences(SharedPreferences, SharedPreferences) - Static method in class com.segment.analytics.internal.Utils
Copies all the values from src to target.
country() - Method in class com.segment.analytics.Traits.Address
 
coupon() - Method in class com.segment.analytics.Properties
 
create(ValueMap, Analytics) - Method in interface com.segment.analytics.integrations.Integration.Factory
Attempts to create an adapter for with settings.
createdAt() - Method in class com.segment.analytics.Traits
 
createDirectory(File) - Static method in class com.segment.analytics.internal.Utils
Ensures that a directory is created in the given location, throws an IOException otherwise.
createMap() - Static method in class com.segment.analytics.internal.Utils
 
crypto(Crypto) - Method in class com.segment.analytics.Analytics.Builder
Specify the crypto interface for customizing how data is stored at rest.
Crypto - Class in com.segment.analytics
 
Crypto() - Constructor for class com.segment.analytics.Crypto
 
currency() - Method in class com.segment.analytics.Properties
 
currentId() - Method in class com.segment.analytics.Traits
Returns the currentId the user is identified with.

D

debug(String, Object...) - Method in class com.segment.analytics.integrations.Logger
Log a debug message.
decrypt(InputStream) - Method in class com.segment.analytics.Crypto
 
DEFAULT_COLLECT_DEVICE_ID - Static variable in class com.segment.analytics.internal.Utils
 
DEFAULT_FLUSH_INTERVAL - Static variable in class com.segment.analytics.internal.Utils
 
DEFAULT_FLUSH_QUEUE_SIZE - Static variable in class com.segment.analytics.internal.Utils
 
defaultOptions(Options) - Method in class com.segment.analytics.Analytics.Builder
Set some default options for all calls.
description() - Method in class com.segment.analytics.Traits
 
device() - Method in class com.segment.analytics.AnalyticsContext
 
disableBundledIntegrations() - Method in class com.segment.analytics.Analytics.Builder
Deprecated.
As of 3.0.1, this method does nothing.
discount() - Method in class com.segment.analytics.Properties
 

E

email() - Method in class com.segment.analytics.Traits
 
employees() - Method in class com.segment.analytics.Traits
 
encrypt(OutputStream) - Method in class com.segment.analytics.Crypto
 
entrySet() - Method in class com.segment.analytics.ValueMap
 
equals(Object) - Method in class com.segment.analytics.ValueMap
 
error(Throwable, String, Object...) - Method in class com.segment.analytics.integrations.Logger
Log an error message.
event() - Method in class com.segment.analytics.integrations.ScreenPayload
Either the name or category of the screen payload.
event(String) - Method in class com.segment.analytics.integrations.TrackPayload.Builder
 
event() - Method in class com.segment.analytics.integrations.TrackPayload
The name of the event.

F

fax() - Method in class com.segment.analytics.Traits
 
firstName() - Method in class com.segment.analytics.Traits
 
flush() - Method in class com.segment.analytics.Analytics
Asynchronously flushes all messages in the queue to the server, and tells bundled integrations to do the same.
flush() - Method in class com.segment.analytics.integrations.Integration
 
flushCount - Variable in class com.segment.analytics.StatsSnapshot
Number of times we've flushed events to our servers.
flushEventCount - Variable in class com.segment.analytics.StatsSnapshot
Number of events we've flushed to our servers.
flushInterval(long, TimeUnit) - Method in class com.segment.analytics.Analytics.Builder
Set the interval at which the client should flush events.
flushQueueSize(int) - Method in class com.segment.analytics.Analytics.Builder
Set the queue size at which the client should flush events.
forEach(PayloadQueue.ElementVisitor) - Method in class com.segment.analytics.QueueFile
Invokes the given reader once for each element in the queue, from eldest to most recently added.
fromJson(String) - Method in class com.segment.analytics.Cartographer
Deserializes the specified json into a Map.
fromJson(Reader) - Method in class com.segment.analytics.Cartographer
Deserializes the json read from the specified Reader into a Map.

G

gender() - Method in class com.segment.analytics.Traits
 
get() - Method in class com.segment.analytics.BooleanPreference
 
get(Object) - Method in class com.segment.analytics.ValueMap
 
getAnalyticsContext() - Method in class com.segment.analytics.Analytics
Get the AnalyticsContext used by this instance.
getApplication() - Method in class com.segment.analytics.Analytics
Return the Application used to create this instance.
getBoolean(String, boolean) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a boolean or can be coerced to a boolean.
getChar(String, char) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a char or can be coerced to a char.
getDeviceId(Context) - Static method in class com.segment.analytics.internal.Utils
Creates a unique device id.
getDouble(String, double) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a double or can be coerced to a double.
getEnum(Class<T>, String) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a enum or can be coerced to an enum.
getFloat(String, float) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a float or can be coerced to a float.
getInputStream(HttpURLConnection) - Static method in class com.segment.analytics.internal.Utils
 
getInt(String, int) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a integer or can be coerced to a integer.
getList(Object, Class<T>) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a List of T.
getLogger() - Method in class com.segment.analytics.Analytics
Deprecated.
This will be removed in a future release.
getLogLevel() - Method in class com.segment.analytics.Analytics
Deprecated.
This will be removed in a future release.
getLong(String, long) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a long or can be coerced to a long.
getResourceString(Context, String) - Static method in class com.segment.analytics.internal.Utils
Get the string resource for the given key.
getSegmentSharedPreferences(Context, String) - Static method in class com.segment.analytics.internal.Utils
Returns a shared preferences for storing any library preferences.
getSnapshot() - Method in class com.segment.analytics.Analytics
Creates a StatsSnapshot of the current stats for this instance.
getString(String) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a string or can be coerced to a string.
getSystemService(Context, String) - Static method in class com.segment.analytics.internal.Utils
Returns the system service for the given string.
getUnderlyingInstance() - Method in class com.segment.analytics.integrations.Integration
The underlying instance for this provider - used for integration specific actions.
getValueMap(Object) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and is a ValueMap.
getValueMap(String, Class<T>) - Method in class com.segment.analytics.ValueMap
Returns the value mapped by key if it exists and if it can be coerced to the given type.
group(String) - Method in class com.segment.analytics.Analytics
 
group(String, Traits) - Method in class com.segment.analytics.Analytics
 
group(String, Traits, Options) - Method in class com.segment.analytics.Analytics
The group method lets you associate a user with a group.
group(GroupPayload) - Method in class com.segment.analytics.integrations.Integration
 
groupId(String) - Method in class com.segment.analytics.integrations.GroupPayload.Builder
 
groupId() - Method in class com.segment.analytics.integrations.GroupPayload
A unique identifier that refers to the group in your database.
GroupPayload - Class in com.segment.analytics.integrations
 
GroupPayload(String, Date, Map<String, Object>, Map<String, Object>, String, String, String, Map<String, Object>) - Constructor for class com.segment.analytics.integrations.GroupPayload
 
GroupPayload.Builder - Class in com.segment.analytics.integrations
Fluent API for creating GroupPayload instances.

H

hasFeature(Context, String) - Static method in class com.segment.analytics.internal.Utils
Returns true if the application has the given feature.
hashCode() - Method in class com.segment.analytics.ValueMap
 
hasPermission(Context, String) - Static method in class com.segment.analytics.internal.Utils
Returns true if the application has the given permission.

I

id() - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
id() - Method in class com.segment.analytics.Properties.Product
 
identify(String) - Method in class com.segment.analytics.Analytics
 
identify(Traits) - Method in class com.segment.analytics.Analytics
 
identify(String, Traits, Options) - Method in class com.segment.analytics.Analytics
Identify lets you tie one of your users and their actions to a recognizable userId.
identify(IdentifyPayload) - Method in class com.segment.analytics.integrations.Integration
 
IdentifyPayload - Class in com.segment.analytics.integrations
 
IdentifyPayload.Builder - Class in com.segment.analytics.integrations
Fluent API for creating IdentifyPayload instances.
immutableCopyOf(Map<K, V>) - Static method in class com.segment.analytics.internal.Utils
Returns an immutable copy of the provided map.
immutableCopyOf(List<T>) - Static method in class com.segment.analytics.internal.Utils
Returns an immutable copy of the provided list.
industry() - Method in class com.segment.analytics.Traits
 
info(String, Object...) - Method in class com.segment.analytics.integrations.Logger
Log an info message.
integration(String, boolean) - Method in class com.segment.analytics.integrations.BasePayload.Builder
Set whether this message is sent to the specified integration or not.
integration(String, Map<String, Object>) - Method in class com.segment.analytics.integrations.BasePayload.Builder
Pass in some options that will only be used by the target integration.
Integration<T> - Class in com.segment.analytics.integrations
Converts Segment messages to a format a bundled integration understands, and calls those methods.
Integration() - Constructor for class com.segment.analytics.integrations.Integration
 
Integration.Factory - Interface in com.segment.analytics.integrations
 
integrationOperationAverageDuration - Variable in class com.segment.analytics.StatsSnapshot
Average time to run operations on all bundled integrations, including lifecycle events and flushes.
integrationOperationCount - Variable in class com.segment.analytics.StatsSnapshot
Number of operations sent to all bundled integrations, including lifecycle events and flushes.
integrationOperationDuration - Variable in class com.segment.analytics.StatsSnapshot
Total time to run operations on all bundled integrations, including lifecycle events and flushes.
integrationOperationDurationByIntegration - Variable in class com.segment.analytics.StatsSnapshot
Total time to run operations, including lifecycle events and flushes, by integration.
integrations(Map<String, ?>) - Method in class com.segment.analytics.integrations.BasePayload.Builder
Specify a dictionary of options for integrations.
integrations() - Method in class com.segment.analytics.integrations.BasePayload
A dictionary of integration names that the message should be proxied to.
integrations() - Method in class com.segment.analytics.Options
Returns a copy of settings for integrations.
intercept(Middleware.Chain) - Method in interface com.segment.analytics.Middleware
Called for every message.
isConnected(Context) - Static method in class com.segment.analytics.internal.Utils
Returns true if the phone is connected to a network, or if we don't have the enough permissions.
isEmpty() - Method in class com.segment.analytics.QueueFile
Returns true if this queue contains no entries.
isEmpty() - Method in class com.segment.analytics.ValueMap
 
isNullOrEmpty(CharSequence) - Static method in class com.segment.analytics.internal.Utils
Returns true if the string is null, or empty (once trimmed).
isNullOrEmpty(Collection) - Static method in class com.segment.analytics.internal.Utils
Returns true if the collection is null or has a size of 0.
isNullOrEmpty(T[]) - Static method in class com.segment.analytics.internal.Utils
Returns true if the array is null or has a size of 0.
isNullOrEmpty(Map) - Static method in class com.segment.analytics.internal.Utils
Returns true if the map is null or empty, false otherwise.
isOnClassPath(String) - Static method in class com.segment.analytics.internal.Utils
Return true if a class with the given name is found.
isRepeatCustomer() - Method in class com.segment.analytics.Properties
 

K

key() - Method in interface com.segment.analytics.integrations.Integration.Factory
The key for which this factory can create an Integration.
keySet() - Method in class com.segment.analytics.ValueMap
 

L

lastName() - Method in class com.segment.analytics.Traits
 
latitude() - Method in class com.segment.analytics.AnalyticsContext.Location
 
lenient(boolean) - Method in class com.segment.analytics.Cartographer.Builder
Configure this parser to be be liberal in what it accepts.
link() - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
location() - Method in class com.segment.analytics.AnalyticsContext
 
Location() - Constructor for class com.segment.analytics.AnalyticsContext.Location
 
log() - Method in enum com.segment.analytics.Analytics.LogLevel
 
logger(String) - Method in class com.segment.analytics.Analytics
Return a new Logger with the given sub-tag.
Logger - Class in com.segment.analytics.integrations
An abstraction for logging messages.
Logger(String, Analytics.LogLevel) - Constructor for class com.segment.analytics.integrations.Logger
 
logLevel(Analytics.LogLevel) - Method in class com.segment.analytics.Analytics.Builder
Set a Analytics.LogLevel for this instance.
logLevel - Variable in class com.segment.analytics.integrations.Logger
 
logout() - Method in class com.segment.analytics.Analytics
Deprecated.
Use Analytics.reset() instead
longitude() - Method in class com.segment.analytics.AnalyticsContext.Location
 

M

medium() - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
messageId(String) - Method in class com.segment.analytics.integrations.BasePayload.Builder
The Message ID is a unique identifier for each message.
messageId() - Method in class com.segment.analytics.integrations.BasePayload
A randomly generated unique id for this message.
middleware(Middleware) - Method in class com.segment.analytics.Analytics.Builder
Add a Middleware for intercepting messages.
Middleware - Interface in com.segment.analytics
Middlewares run for every message after it is built to process it further.
Middleware.Chain - Interface in com.segment.analytics
 

N

name() - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
name() - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
name(String) - Method in class com.segment.analytics.integrations.ScreenPayload.Builder
 
name() - Method in class com.segment.analytics.integrations.ScreenPayload
The name of the page or screen.
name() - Method in class com.segment.analytics.Properties
 
name() - Method in class com.segment.analytics.Properties.Product
 
name() - Method in class com.segment.analytics.Traits
 
networkExecutor(ExecutorService) - Method in class com.segment.analytics.Analytics.Builder
Specify the executor service for making network calls in the background.
newSet(T...) - Static method in class com.segment.analytics.internal.Utils
Creates a mutable HashSet instance containing the given elements in unspecified order
newThread(Runnable) - Method in class com.segment.analytics.internal.Utils.AnalyticsThreadFactory
 
none() - Static method in class com.segment.analytics.Crypto
 
NullableConcurrentHashMap() - Constructor for class com.segment.analytics.internal.Utils.NullableConcurrentHashMap
 
NullableConcurrentHashMap(Map<? extends K, ? extends V>) - Constructor for class com.segment.analytics.internal.Utils.NullableConcurrentHashMap
 

O

onActivityCreated(Activity, Bundle) - Method in class com.segment.analytics.integrations.Integration
 
onActivityDestroyed(Activity) - Method in class com.segment.analytics.integrations.Integration
 
onActivityPaused(Activity) - Method in class com.segment.analytics.integrations.Integration
 
onActivityResumed(Activity) - Method in class com.segment.analytics.integrations.Integration
 
onActivitySaveInstanceState(Activity, Bundle) - Method in class com.segment.analytics.integrations.Integration
 
onActivityStarted(Activity) - Method in class com.segment.analytics.integrations.Integration
 
onActivityStopped(Activity) - Method in class com.segment.analytics.integrations.Integration
 
onIntegrationReady(String, Analytics.Callback<T>) - Method in class com.segment.analytics.Analytics
Register to be notified when a bundled integration is ready.
onIntegrationReady(Analytics.BundledIntegration, Analytics.Callback) - Method in class com.segment.analytics.Analytics
onReady(T) - Method in interface com.segment.analytics.Analytics.Callback
This method will be invoked once for each callback.
openConnection(String) - Method in class com.segment.analytics.ConnectionFactory
Options - Class in com.segment.analytics
Options let you control behaviour for a specific analytics action, including setting a custom timestamp and disabling integrations on demand.
Options() - Constructor for class com.segment.analytics.Options
 
optOut(boolean) - Method in class com.segment.analytics.Analytics
Set the opt-out status for the current device and analytics client combination.
orderId() - Method in class com.segment.analytics.Properties
 

P

parseISO8601Date(String) - Static method in class com.segment.analytics.internal.Utils
Parse a date from ISO-8601 formatted string.
path() - Method in class com.segment.analytics.Properties
 
payload() - Method in interface com.segment.analytics.Middleware.Chain
 
peek() - Method in class com.segment.analytics.QueueFile
Reads the eldest element.
phone() - Method in class com.segment.analytics.Traits
 
postalCode() - Method in class com.segment.analytics.Traits.Address
 
prettyPrint(boolean) - Method in class com.segment.analytics.Cartographer.Builder
Configures Cartographer to output Json that fits in a page for pretty printing.
previousId(String) - Method in class com.segment.analytics.integrations.AliasPayload.Builder
 
previousId() - Method in class com.segment.analytics.integrations.AliasPayload
The previous ID for the user that you want to alias from, that you previously called identify with as their user ID, or the anonymous ID if you haven't identified the user yet.
price() - Method in class com.segment.analytics.Properties
 
price() - Method in class com.segment.analytics.Properties.Product
 
Private - Annotation Type in com.segment.analytics.internal
Indicates that the given field or method has package visibility solely to prevent the creation of a synthetic method.
proceed(BasePayload) - Method in interface com.segment.analytics.Middleware.Chain
 
Product(String, String, double) - Constructor for class com.segment.analytics.Properties.Product
Create an e-commerce product with the given id, sku and price (in dollars).
productId() - Method in class com.segment.analytics.Properties
 
products(Properties.Product...) - Method in class com.segment.analytics.Properties
Deprecated.
products() - Method in class com.segment.analytics.Properties
 
projectSettings(String) - Method in class com.segment.analytics.ConnectionFactory
Return a HttpURLConnection that reads JSON formatted project settings.
properties(Map<String, ?>) - Method in class com.segment.analytics.integrations.ScreenPayload.Builder
 
properties() - Method in class com.segment.analytics.integrations.ScreenPayload
The page and screen methods also take a properties dictionary, just like track.
properties(Map<String, ?>) - Method in class com.segment.analytics.integrations.TrackPayload.Builder
 
properties() - Method in class com.segment.analytics.integrations.TrackPayload
A dictionary of properties that give more information about the event.
Properties - Class in com.segment.analytics
Properties are a dictionary of free-form information to attach to specific events.
Properties() - Constructor for class com.segment.analytics.Properties
 
Properties(int) - Constructor for class com.segment.analytics.Properties
 
Properties.Product - Class in com.segment.analytics
A representation of an e-commerce product.
put(K, V) - Method in class com.segment.analytics.internal.Utils.NullableConcurrentHashMap
 
put(String, Object) - Method in class com.segment.analytics.ValueMap
 
putAddress(Traits.Address) - Method in class com.segment.analytics.Traits
Set an address for the user or group.
putAge(int) - Method in class com.segment.analytics.Traits
Set the age of a user.
putAll(Map<? extends K, ? extends V>) - Method in class com.segment.analytics.internal.Utils.NullableConcurrentHashMap
 
putAll(Map<? extends String, ?>) - Method in class com.segment.analytics.ValueMap
 
putAvatar(String) - Method in class com.segment.analytics.Traits
Set a URL to an avatar image for the user or group.
putBirthday(Date) - Method in class com.segment.analytics.Traits
Set the user's birthday.
putCampaign(AnalyticsContext.Campaign) - Method in class com.segment.analytics.AnalyticsContext
Set information about the campaign that resulted in the API call.
putCategory(String) - Method in class com.segment.analytics.Properties
Set a category for this action.
putCity(String) - Method in class com.segment.analytics.Traits.Address
 
putContent(String) - Method in class com.segment.analytics.AnalyticsContext.Campaign
Set the UTM campaign content.
putContext(String, Object) - Method in class com.segment.analytics.Options
Attach some additional context information.
putCountry(String) - Method in class com.segment.analytics.Traits.Address
 
putCoupon(String) - Method in class com.segment.analytics.Properties
Set a coupon name for an order associated with an event.
putCreatedAt(String) - Method in class com.segment.analytics.Traits
Set the date the user's or group's account was first created.
putCurrency(String) - Method in class com.segment.analytics.Properties
The currency for the value set in Properties.putRevenue(double).
putDescription(String) - Method in class com.segment.analytics.Traits
Set a description of the user or group, like a personal bio.
putDeviceToken(String) - Method in class com.segment.analytics.AnalyticsContext.Device
Set a device token.
putDeviceToken(String) - Method in class com.segment.analytics.AnalyticsContext
Set a device token.
putDiscount(double) - Method in class com.segment.analytics.Properties
Set the discount amount (in dollars) for an order associated with an event.
putEmail(String) - Method in class com.segment.analytics.Traits
Set the email address of a user or group.
putEmployees(long) - Method in class com.segment.analytics.Traits
Set the number of employees of a group, typically used for companies.
putFax(String) - Method in class com.segment.analytics.Traits
Set the fax number of a user or group.
putFirstName(String) - Method in class com.segment.analytics.Traits
Set the first name of a user.
putGender(String) - Method in class com.segment.analytics.Traits
Set the gender of a user.
putId(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
Set the referrer ID.
putIndustry(String) - Method in class com.segment.analytics.Traits
Set the industry the user works in, or a group is part of.
putLastName(String) - Method in class com.segment.analytics.Traits
Set the last name of a user.
putLatitude(double) - Method in class com.segment.analytics.AnalyticsContext.Location
Set the latitude for the location of the device.
putLink(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
Set the referrer link.
putLocation(AnalyticsContext.Location) - Method in class com.segment.analytics.AnalyticsContext
Set location information about the device.
putLongitude(double) - Method in class com.segment.analytics.AnalyticsContext.Location
Set the longitude for the location of the device.
putMedium(String) - Method in class com.segment.analytics.AnalyticsContext.Campaign
Set the UTM campaign medium.
putName(String) - Method in class com.segment.analytics.AnalyticsContext.Campaign
Set the UTM campaign name.
putName(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
Set the referrer name.
putName(String) - Method in class com.segment.analytics.Properties.Product
Set an optional name for this product.
putName(String) - Method in class com.segment.analytics.Properties
Set the name of the product associated with an event.
putName(String) - Method in class com.segment.analytics.Traits
Set the name of a user or group.
putOrderId(String) - Method in class com.segment.analytics.Properties
Set the order ID associated with an event.
putPath(String) - Method in class com.segment.analytics.Properties
Set a path (usually the path of the URL) for the screen.
putPhone(String) - Method in class com.segment.analytics.Traits
Set the phone number of a user or group.
putPostalCode(String) - Method in class com.segment.analytics.Traits.Address
 
putPrice(double) - Method in class com.segment.analytics.Properties
Set a price (in dollars) for the product associated with an event.
putProductId(String) - Method in class com.segment.analytics.Properties
Set an ID for the product associated with an event.
putProducts(Properties.Product...) - Method in class com.segment.analytics.Properties
Set the individual products for an order associated with an event.
putReferrer(AnalyticsContext.Referrer) - Method in class com.segment.analytics.AnalyticsContext
Set the referrer for this session.
putReferrer(String) - Method in class com.segment.analytics.Properties
Set the referrer that led the user to the screen.
putRepeatCustomer(boolean) - Method in class com.segment.analytics.Properties
Set whether an order associated with an event is from a repeating customer.
putRevenue(double) - Method in class com.segment.analytics.Properties
Set the amount of revenue an event resulted in.
putShipping(double) - Method in class com.segment.analytics.Properties
Set the shipping amount (in dollars) for an order associated with an event.
putSku(String) - Method in class com.segment.analytics.Properties
Set a sku for the product associated with an event.
putSource(String) - Method in class com.segment.analytics.AnalyticsContext.Campaign
Set the UTM campaign source.
putSpeed(double) - Method in class com.segment.analytics.AnalyticsContext.Location
Set the speed of the device.
putState(String) - Method in class com.segment.analytics.Traits.Address
 
putStreet(String) - Method in class com.segment.analytics.Traits.Address
 
putSubtotal(double) - Method in class com.segment.analytics.Properties
Set the subtotal (in dollars) for an order associated with an event (excluding tax and shipping).
putSubtotal() - Method in class com.segment.analytics.Properties
Deprecated.
putTax(double) - Method in class com.segment.analytics.Properties
Set the tax amount (in dollars) for an order associated with an event.
putTerm(String) - Method in class com.segment.analytics.AnalyticsContext.Campaign
Set the UTM campaign term.
putTerm(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
putTitle(String) - Method in class com.segment.analytics.Properties
Set the title of the screen.
putTitle(String) - Method in class com.segment.analytics.Traits
Set the title of a user, usually related to their position at a specific company, for example "VP of Engineering"
putTotal(double) - Method in class com.segment.analytics.Properties
Set the total amount (in dollars) for an order associated with an event.
putType(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
Set the referrer type.
putUrl(String) - Method in class com.segment.analytics.AnalyticsContext.Referrer
Set the referrer url.
putUrl(String) - Method in class com.segment.analytics.Properties
Set a url for the screen.
putUsername(String) - Method in class com.segment.analytics.Traits
Set the user's username.
putValue(String, Object) - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
putValue(String, Object) - Method in class com.segment.analytics.AnalyticsContext.Device
 
putValue(String, Object) - Method in class com.segment.analytics.AnalyticsContext.Location
 
putValue(String, Object) - Method in class com.segment.analytics.AnalyticsContext
 
putValue(String, Object) - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
putValue(String, Object) - Method in class com.segment.analytics.integrations.BasePayload
 
putValue(String, Object) - Method in class com.segment.analytics.Properties.Product
 
putValue(String, Object) - Method in class com.segment.analytics.Properties
 
putValue(double) - Method in class com.segment.analytics.Properties
Set an abstract value to associate with an event.
putValue(String, Object) - Method in class com.segment.analytics.Traits.Address
 
putValue(String, Object) - Method in class com.segment.analytics.Traits
 
putValue(String, Object) - Method in class com.segment.analytics.ValueMap
Helper method to be able to chain put methods.
putWebsite(String) - Method in class com.segment.analytics.Traits
Set the website of a user or group.

Q

QueueFile - Class in com.segment.analytics
A reliable, efficient, file-based, FIFO queue.
QueueFile(File) - Constructor for class com.segment.analytics.QueueFile
Constructs a new queue backed by the given file.

R

readFully(InputStream) - Static method in class com.segment.analytics.internal.Utils
Reads the give InputStream into a String.
readFully(BufferedReader) - Static method in class com.segment.analytics.internal.Utils
Reads the give BufferedReader into a String.
realBuild(String, Date, Map<String, Object>, Map<String, Object>, String, String) - Method in class com.segment.analytics.integrations.AliasPayload.Builder
 
realBuild(String, Date, Map<String, Object>, Map<String, Object>, String, String) - Method in class com.segment.analytics.integrations.GroupPayload.Builder
 
realBuild(String, Date, Map<String, Object>, Map<String, Object>, String, String) - Method in class com.segment.analytics.integrations.ScreenPayload.Builder
 
realBuild(String, Date, Map<String, Object>, Map<String, Object>, String, String) - Method in class com.segment.analytics.integrations.TrackPayload.Builder
 
recordScreenViews() - Method in class com.segment.analytics.Analytics.Builder
Automatically record screen calls when activities are created.
Referrer() - Constructor for class com.segment.analytics.AnalyticsContext.Referrer
 
Referrer(Map<String, Object>) - Constructor for class com.segment.analytics.AnalyticsContext.Referrer
 
referrer() - Method in class com.segment.analytics.Properties
 
remove() - Method in class com.segment.analytics.QueueFile
Removes the eldest element.
remove(int) - Method in class com.segment.analytics.QueueFile
Removes the eldest n elements.
remove(Object) - Method in class com.segment.analytics.ValueMap
 
reset() - Method in class com.segment.analytics.Analytics
Resets the analytics client by clearing any stored information about the user.
reset() - Method in class com.segment.analytics.integrations.Integration
 
revenue() - Method in class com.segment.analytics.Properties
 

S

screen(String, String) - Method in class com.segment.analytics.Analytics
Deprecated.
screen(String, String, Properties) - Method in class com.segment.analytics.Analytics
Deprecated.
screen(String) - Method in class com.segment.analytics.Analytics
 
screen(String, Properties) - Method in class com.segment.analytics.Analytics
 
screen(String, String, Properties, Options) - Method in class com.segment.analytics.Analytics
The screen methods let your record whenever a user sees a screen of your mobile app, and attach a name, category or properties to the screen.
screen(ScreenPayload) - Method in class com.segment.analytics.integrations.Integration
 
ScreenPayload - Class in com.segment.analytics.integrations
 
ScreenPayload.Builder - Class in com.segment.analytics.integrations
Fluent API for creating ScreenPayload instances.
set(boolean) - Method in class com.segment.analytics.BooleanPreference
 
setIntegration(String, boolean) - Method in class com.segment.analytics.Options
Sets whether an action will be sent to the target integration.
setIntegration(Analytics.BundledIntegration, boolean) - Method in class com.segment.analytics.Options
Sets whether an action will be sent to the target integration.
setIntegrationOptions(String, Map<String, Object>) - Method in class com.segment.analytics.Options
Attach some integration specific options for this call.
setIntegrationOptions(Analytics.BundledIntegration, Map<String, Object>) - Method in class com.segment.analytics.Options
Attach some integration specific options for this call.
setSingletonInstance(Analytics) - Static method in class com.segment.analytics.Analytics
Set the global instance returned from Analytics.with(android.content.Context).
shipping() - Method in class com.segment.analytics.Properties
 
shutdown() - Method in class com.segment.analytics.Analytics
Stops this instance from accepting further requests.
size() - Method in class com.segment.analytics.QueueFile
Returns the number of elements in this queue.
size() - Method in class com.segment.analytics.ValueMap
 
sku() - Method in class com.segment.analytics.Properties.Product
 
sku() - Method in class com.segment.analytics.Properties
 
source() - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
speed() - Method in class com.segment.analytics.AnalyticsContext.Location
 
state() - Method in class com.segment.analytics.Traits.Address
 
StatsSnapshot - Class in com.segment.analytics
Represents all stats for a Analytics instance at a single point in time.
StatsSnapshot(long, long, long, long, long, Map<String, Long>) - Constructor for class com.segment.analytics.StatsSnapshot
 
street() - Method in class com.segment.analytics.Traits.Address
 
subLog(String) - Method in class com.segment.analytics.integrations.Logger
Returns a new Logger with the same level as this one and the given tag.
subtotal() - Method in class com.segment.analytics.Properties
 

T

tag(String) - Method in class com.segment.analytics.Analytics.Builder
Set a tag for this instance.
tax() - Method in class com.segment.analytics.Properties
 
term() - Method in class com.segment.analytics.AnalyticsContext.Campaign
 
tern() - Method in class com.segment.analytics.AnalyticsContext.Campaign
Deprecated.
THREAD_PREFIX - Static variable in class com.segment.analytics.internal.Utils
 
timestamp(Date) - Method in class com.segment.analytics.integrations.BasePayload.Builder
Set a timestamp for the event.
timestamp() - Method in class com.segment.analytics.integrations.BasePayload
Set a timestamp the event occurred.
timestamp - Variable in class com.segment.analytics.StatsSnapshot
The time at which the snapshot was created.
title() - Method in class com.segment.analytics.Properties
 
title() - Method in class com.segment.analytics.Traits
 
toBuilder() - Method in class com.segment.analytics.integrations.AliasPayload
 
toBuilder() - Method in class com.segment.analytics.integrations.BasePayload
 
toBuilder() - Method in class com.segment.analytics.integrations.GroupPayload
 
toBuilder() - Method in class com.segment.analytics.integrations.IdentifyPayload
 
toBuilder() - Method in class com.segment.analytics.integrations.ScreenPayload
 
toBuilder() - Method in class com.segment.analytics.integrations.TrackPayload
 
toISO8601Date(Date) - Static method in class com.segment.analytics.internal.Utils
Deprecated.
toISO8601Date(String) - Static method in class com.segment.analytics.internal.Utils
toISO8601String(Date) - Static method in class com.segment.analytics.internal.Utils
Returns date formatted as yyyy-MM-ddThh:mm:ss.sssZ
toJson(Map<?, ?>) - Method in class com.segment.analytics.Cartographer
Serializes the map into it's json representation and returns it as a String.
toJson(Map<?, ?>, Writer) - Method in class com.segment.analytics.Cartographer
Serializes the map into it's json representation into the provided Writer.
toJsonObject(Map<String, ?>) - Static method in class com.segment.analytics.internal.Utils
Return a copy of the contents of the given map as a JSONObject.
toJsonObject() - Method in class com.segment.analytics.ValueMap
Return a copy of the contents of this map as a JSONObject.
toString() - Method in class com.segment.analytics.integrations.AliasPayload
 
toString() - Method in class com.segment.analytics.integrations.GroupPayload
 
toString() - Method in class com.segment.analytics.integrations.IdentifyPayload
 
toString() - Method in class com.segment.analytics.integrations.ScreenPayload
 
toString() - Method in class com.segment.analytics.integrations.TrackPayload
 
toString() - Method in class com.segment.analytics.QueueFile
 
toString() - Method in class com.segment.analytics.StatsSnapshot
 
toString() - Method in class com.segment.analytics.ValueMap
 
toStringMap() - Method in class com.segment.analytics.ValueMap
Return a copy of the contents of this map as a Map<String, String>.
total() - Method in class com.segment.analytics.Properties
 
track(String) - Method in class com.segment.analytics.Analytics
 
track(String, Properties) - Method in class com.segment.analytics.Analytics
 
track(String, Properties, Options) - Method in class com.segment.analytics.Analytics
The track method is how you record any actions your users perform.
track(TrackPayload) - Method in class com.segment.analytics.integrations.Integration
 
trackApplicationLifecycleEvents() - Method in class com.segment.analytics.Analytics.Builder
Automatically track application lifecycle events, including "Application Installed", "Application Updated" and "Application Opened".
trackAttributionInformation() - Method in class com.segment.analytics.Analytics.Builder
Automatically track attribution information from enabled providers.
trackDeepLinks() - Method in class com.segment.analytics.Analytics.Builder
Automatically track deep links as part of the screen call.
TrackPayload - Class in com.segment.analytics.integrations
 
TrackPayload.Builder - Class in com.segment.analytics.integrations
Fluent API for creating TrackPayload instances.
traits() - Method in class com.segment.analytics.AnalyticsContext
Note: Not for public use.
traits(Map<String, ?>) - Method in class com.segment.analytics.integrations.GroupPayload.Builder
 
traits() - Method in class com.segment.analytics.integrations.GroupPayload
The group method also takes a traits dictionary, just like identify.
traits(Map<String, ?>) - Method in class com.segment.analytics.integrations.IdentifyPayload.Builder
 
traits() - Method in class com.segment.analytics.integrations.IdentifyPayload
A dictionary of traits you know about a user, for example email or name.
Traits - Class in com.segment.analytics
A class representing information about a user.
Traits() - Constructor for class com.segment.analytics.Traits
 
Traits(int) - Constructor for class com.segment.analytics.Traits
 
Traits.Address - Class in com.segment.analytics
Represents information about the address of a user or group.
transform(Map<String, T>, Map<String, String>) - Static method in class com.segment.analytics.internal.Utils
Transforms the given map by replacing the keys mapped by mapper.
type() - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
type() - Method in class com.segment.analytics.integrations.BasePayload
The type of message.

U

unmodifiableCopy() - Method in class com.segment.analytics.AnalyticsContext
Returns an unmodifiable shallow copy of the values in this map.
unmodifiableCopy() - Method in class com.segment.analytics.Traits
 
upload(String) - Method in class com.segment.analytics.ConnectionFactory
Return a HttpURLConnection that writes batched payloads to https://api.segment.io/v1/import.
url() - Method in class com.segment.analytics.AnalyticsContext.Referrer
 
url() - Method in class com.segment.analytics.Properties
 
use(Integration.Factory) - Method in class com.segment.analytics.Analytics.Builder
TODO: docs
userId(String) - Method in class com.segment.analytics.integrations.BasePayload.Builder
The User ID is a persistent unique identifier for a user (such as a database ID).
userId() - Method in class com.segment.analytics.integrations.BasePayload
The user ID is an identifier that unique identifies the user in your database.
userId() - Method in class com.segment.analytics.Traits
 
username() - Method in class com.segment.analytics.Traits
 
Utils - Class in com.segment.analytics.internal
 
Utils.AnalyticsNetworkExecutorService - Class in com.segment.analytics.internal
A ThreadPoolExecutor implementation by Analytics instances.
Utils.AnalyticsThreadFactory - Class in com.segment.analytics.internal
 
Utils.NullableConcurrentHashMap<K,V> - Class in com.segment.analytics.internal
A ConcurrentHashMap that rejects null keys and values instead of failing.

V

value() - Method in class com.segment.analytics.Properties
 
ValueMap - Class in com.segment.analytics
A class that wraps an existing Map to expose value type functionality.
ValueMap() - Constructor for class com.segment.analytics.ValueMap
 
ValueMap(int) - Constructor for class com.segment.analytics.ValueMap
 
ValueMap(Map<String, Object>) - Constructor for class com.segment.analytics.ValueMap
 
valueOf(String) - Static method in enum com.segment.analytics.Analytics.BundledIntegration
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.segment.analytics.Analytics.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.segment.analytics.integrations.BasePayload.Channel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.segment.analytics.integrations.BasePayload.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.segment.analytics.Analytics.BundledIntegration
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.segment.analytics.Analytics.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.segment.analytics.integrations.BasePayload.Channel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.segment.analytics.integrations.BasePayload.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.segment.analytics.ValueMap
 
verbose(String, Object...) - Method in class com.segment.analytics.integrations.Logger
Log a verbose message.

W

website() - Method in class com.segment.analytics.Traits
 
with(Context) - Static method in class com.segment.analytics.Analytics
Return a reference to the global default Analytics instance.
with(Analytics.LogLevel) - Static method in class com.segment.analytics.integrations.Logger
Returns a new Logger with the give level.
A B C D E F G H I K L M N O P Q R S T U V W 
Skip navigation links