Amplitude (main 1.12.0 API)

java.lang.Object
- com.amplitude.Amplitude

public class Amplitude
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventMiddleware(Middleware middleware)` Add middleware to the middleware runner
`void`	`flushEvents()` Forces events currently in the event buffer to be sent to Amplitude API endpoint.
`static Amplitude`	`getInstance()` Return the default class instance of Amplitude that is associated with "" or no string (null).
`static Amplitude`	`getInstance(java.lang.String instanceName)` Return the class instance of Amplitude that is associated with this name
`void`	`init(java.lang.String key)` Set the API key for this instance of Amplitude.
`void`	`logEvent(Event event)` Log an event to the Amplitude HTTP V2 API through the Java SDK
`void`	`logEvent(Event event, AmplitudeCallbacks callbacks)` Log an event and set a callback for this event.
`void`	`logEvent(Event event, AmplitudeCallbacks callbacks, MiddlewareExtra extra)` Log an event and set a callback for this event.
`void`	`logEvent(Event event, MiddlewareExtra extra)` Log an event to the Amplitude HTTP V2 API through the Java SDK
`void`	`setCallbacks(AmplitudeCallbacks callbacks)` Set event callback which are triggered after event sent
`Amplitude`	`setEventUploadPeriodMillis(int eventUploadPeriodMillis)` Sets event upload period millis.
`Amplitude`	`setEventUploadThreshold(int eventUploadThreshold)` Sets event upload threshold.
`Amplitude`	`setFlushTimeout(long timeout)` Set flush events threads execution timeout in milliseconds
`Amplitude`	`setIngestionMetadata(IngestionMetadata ingestionMetadata)` Set ingestion metadata information.
`Amplitude`	`setLogger(AmplitudeLog logger)` Set custom logger instance for amplitude client
`void`	`setLogMode(AmplitudeLog.LogMode logMode)` Set the level at which to filter out debug messages from the Java SDK.
`void`	`setOptions(Options options)`
`Amplitude`	`setPlan(Plan plan)` Set tracking plan information.
`Amplitude`	`setProxy(java.net.Proxy proxy)` Set custom proxy for https requests
`void`	`setRecordThrottledId(boolean record)` Config whether the client record the recent throttled userId/deviceId and make suggestion base on it.
`void`	`setServerUrl(java.lang.String url)` Sends events to a different URL other than Constants.API_URL or Constants.BATCH_API_URL.
`boolean`	`shouldWait(Event event)` Check the status of the client, return true if any of the following situation: 1.
`void`	`shutdown()` Release resource by: Shutdown threadspool for executing flush events task.
`void`	`useBatchMode(java.lang.Boolean isBatchMode)` Set the Event Upload Mode.

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

- Method Detail
  - getInstance
```
public static Amplitude getInstance()
```
    Return the default class instance of Amplitude that is associated with "" or no string (null).
    
    Returns:
    
    the Amplitude instance that should be used for instrumentation
  - getInstance
```
public static Amplitude getInstance(java.lang.String instanceName)
```
    Return the class instance of Amplitude that is associated with this name
    
    Parameters:
    
    instanceName - The key (unique identifier) that matches to the Amplitude instance
    
    Returns:
    
    the Amplitude instance that should be used for instrumentation
  - init
```
public void init(java.lang.String key)
```
    Set the API key for this instance of Amplitude. API key is necessary to authorize and route events to the current Amplitude project.
    
    Parameters:
    
    key - the API key from Amplitude website
  - setServerUrl
```
public void setServerUrl(java.lang.String url)
```
    Sends events to a different URL other than Constants.API_URL or Constants.BATCH_API_URL. Used for proxy server.
    
    Parameters:
    
    url - the server URL for sending event
  - setOptions
```
public void setOptions(Options options)
```
  - useBatchMode
```
public void useBatchMode(java.lang.Boolean isBatchMode)
```
    Set the Event Upload Mode. If isBatchMode is true, the events will log through the Amplitude HTTP V2 Batch API.
    
    Parameters:
    
    isBatchMode - if using batch upload or not;
  - setLogMode
```
public void setLogMode(AmplitudeLog.LogMode logMode)
```
    Set the level at which to filter out debug messages from the Java SDK.
    
    Parameters:
    
    logMode - Messages at this level and higher (more urgent) will be logged in the console.
  - setEventUploadThreshold
```
public Amplitude setEventUploadThreshold(int eventUploadThreshold)
```
    Sets event upload threshold. The SDK will attempt to batch upload unsent events every eventUploadPeriodMillis milliseconds, or if the unsent event count exceeds the event upload threshold.
    
    Parameters:
    
    eventUploadThreshold - the event upload threshold
  - setEventUploadPeriodMillis
```
public Amplitude setEventUploadPeriodMillis(int eventUploadPeriodMillis)
```
    Sets event upload period millis. The SDK will attempt to batch upload unsent events * every eventUploadPeriodMillis milliseconds, or if the unsent event count exceeds the * event upload threshold.
    
    Parameters:
    
    eventUploadPeriodMillis - the event upload period millis
  - setCallbacks
```
public void setCallbacks(AmplitudeCallbacks callbacks)
```
    Set event callback which are triggered after event sent
    
    Parameters:
    
    callbacks - AmplitudeCallbacks or null to clean up.
  - setPlan
```
public Amplitude setPlan(Plan plan)
```
    Set tracking plan information.
    
    Parameters:
    
    plan - Plan object
  - setIngestionMetadata
```
public Amplitude setIngestionMetadata(IngestionMetadata ingestionMetadata)
```
    Set ingestion metadata information.
    
    Parameters:
    
    ingestionMetadata - IngestionMetadata object
  - setProxy
```
public Amplitude setProxy(java.net.Proxy proxy)
```
    Set custom proxy for https requests
    
    Parameters:
    
    proxy - Proxy object, default to Proxy.NO_PROXY for direct connection
  - setLogger
```
public Amplitude setLogger(AmplitudeLog logger)
```
    Set custom logger instance for amplitude client
    
    Parameters:
    
    logger - AmplitudeLog object
  - setFlushTimeout
```
public Amplitude setFlushTimeout(long timeout)
```
    Set flush events threads execution timeout in milliseconds
    
    Parameters:
    
    timeout - the flush events threads timeout millis
  - addEventMiddleware
```
public void addEventMiddleware(Middleware middleware)
```
    Add middleware to the middleware runner
  - logEvent
```
public void logEvent(Event event)
```
    Log an event to the Amplitude HTTP V2 API through the Java SDK
    
    Parameters:
    
    event - The event to be sent
  - logEvent
```
public void logEvent(Event event,
                     MiddlewareExtra extra)
```
    Log an event to the Amplitude HTTP V2 API through the Java SDK
    
    Parameters:
    
    event - The event to be sent
    
    extra - The extra unstructured data for middleware
  - logEvent
```
public void logEvent(Event event,
                     AmplitudeCallbacks callbacks)
```
    Log an event and set a callback for this event.
    
    Parameters:
    
    event - The event to be sent
    
    callbacks - The callback for the event, this will run in addition to client level callback
  - logEvent
```
public void logEvent(Event event,
                     AmplitudeCallbacks callbacks,
                     MiddlewareExtra extra)
```
    Log an event and set a callback for this event.
    
    Parameters:
    
    event - The event to be sent
    
    callbacks - The callback for the event, this will run in addition to client level callback
    
    extra - The extra unstructured data for middleware
  - flushEvents
```
public void flushEvents()
```
    Forces events currently in the event buffer to be sent to Amplitude API endpoint. Only one thread may flush at a time. Next flushes will happen immediately after.
  - shouldWait
```
public boolean shouldWait(Event event)
```
    Check the status of the client, return true if any of the following situation: 1. Events sit in memory waiting for flush are more than flush threshold 2. Events in retry buffer are more than 16,000 3. When setRecordThrottledId(true), the userId or deviceId of the input event was throttled and retry attempt for the userId/deviceId not finished. Can be called before logEvent(event) and add some wait time if return true.
    
    Parameters:
    
    event - The event to be sent.
    
    Returns:
    
    true if client is busy or event may be throttled.
  - setRecordThrottledId
```
public void setRecordThrottledId(boolean record)
```
    Config whether the client record the recent throttled userId/deviceId and make suggestion base on it.
    
    Parameters:
    
    record - true to record
  - shutdown
```
public void shutdown()
              throws java.lang.InterruptedException
```
    Release resource by: Shutdown threadspool for executing flush events task. All events hold by these threads will trigger callbacks if amplitude client have configured callbacks method. Shutdown client instance stop sending further events.
    
    Throws:
    
    java.lang.InterruptedException

Class Amplitude

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getInstance

init

setServerUrl

setOptions

useBatchMode

setLogMode

setEventUploadThreshold

setEventUploadPeriodMillis

setCallbacks

setPlan

setIngestionMetadata

setProxy

setLogger

setFlushTimeout

addEventMiddleware

logEvent

logEvent

logEvent

logEvent

flushEvents

shouldWait

setRecordThrottledId

shutdown