TealiumCollect

java.lang.Object
- com.tealium.collect.TealiumCollect

```
public final class TealiumCollect
extends java.lang.Object
```
Main class for this TealiumCollect library.
enable(TealiumCollect.Config) must be called before using any of the other methods.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TealiumCollect.Config` Required to enable the TealiumCollect library.
`static interface`	`TealiumCollect.OnAudienceUpdateListener` Implementers of this class can subscribe to Audience updates by adding the listener to `getEventListeners()`.
`static interface`	`TealiumCollect.OnBadgeUpdateListener` Implementers of this class can subscribe to Badge updates by adding the listener to `getEventListeners()`
`static interface`	`TealiumCollect.OnDateUpdateListener` Implementers of this class can subscribe to Date updates by adding the listener to `getEventListeners()`
`static interface`	`TealiumCollect.OnFlagUpdateListener` Implementers of this class can subscribe to Flag updates by adding the listener to `getEventListeners()`
`static interface`	`TealiumCollect.OnMetricUpdateListener` Implementers of this class can subscribe to Metric updates by adding the listener to `getEventListeners()`
`static interface`	`TealiumCollect.OnProfileUpdatedListener` Implementers of this class can subscribe to Profile updates by adding the listener to `getEventListeners()`
`static interface`	`TealiumCollect.OnPropertyUpdateListener` Implementers of this class can subscribe to Property (AKA Trait) updates by adding the listener to `getEventListeners()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`disable()` Disable the initialized library.
`static void`	`enable(TealiumCollect.Config config)` Initialize the library with the desired configuration.
`static VisitorProfile`	`getCachedVisitorProfile()`
`static java.util.Collection<java.util.EventListener>`	`getEventListeners()` Add an `EventListener` to receive profile update events.
`static java.lang.String`	`getVisitorId()`
`static boolean`	`isEnabled()`
`static void`	`joinTrace(java.lang.String traceId)` Join an AudienceStream Trace with the given trace id.
`static void`	`leaveTrace()` Leave an active AudienceStream Trace if one is running.
`static void`	`send(java.util.Map<java.lang.String,?> data)` Send a custom dispatch to TealiumCollect.
`static void`	`sendEvent(java.util.Map<java.lang.String,?> data)` Send an event dispatch to Tealium Collect.
`static void`	`sendView(java.util.Map<java.lang.String,?> data)` Send a view dispatch to Tealium Collect.

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

- Method Detail
  - getEventListeners
```
public static java.util.Collection<java.util.EventListener> getEventListeners()
```
    Add an EventListener to receive profile update events.
    The EventListeners that receive events are:
  - isEnabled
```
public static boolean isEnabled()
```
    Returns:
    Whether the Tealium Collect library is enabled (enable(Config) has been called).
  - enable
```
public static void enable(TealiumCollect.Config config)
```
    Initialize the library with the desired configuration.
    
    Parameters:
    config - a Config instance. If null or the library is already initialized, a warning will be logged in LogCat and the call will have no effect.
  - disable
```
public static void disable()
```
    Disable the initialized library. If the library was not initialized this call has no effect.
  - sendEvent
```
public static void sendEvent(java.util.Map<java.lang.String,?> data)
```
    Send an event dispatch to Tealium Collect. This method calls send(String, Map) with the first argument as "link" along with the given data.
    
    Parameters:
    data - the data tied to this event. The values provided by the map are copied into Strings, org.json.JSONArrays, and org.json.JSONObjects depending on their original type.
  - sendView
```
public static void sendView(java.util.Map<java.lang.String,?> data)
```
    Send a view dispatch to Tealium Collect. This method calls send(String, Map) with the first argument as "view" along with the
    
    Parameters:
    data - the data tied to this event. The values provided by the map are copied into Strings, org.json.JSONArrays, and org.json.JSONObjects depending on their original type.
  - send
```
public static void send(java.util.Map<java.lang.String,?> data)
```
    Send a custom dispatch to TealiumCollect.
    
    Parameters:
    data - the data tied to this event. The values provided by the map are copied into Strings, org.json.JSONArrays, and org.json.JSONObjects depending on their original type.
    See Also:
    TealiumCollect#sendEvent(java.util.Map)}., TealiumCollect#sendView(java.util.Map)}.
  - joinTrace
```
public static void joinTrace(java.lang.String traceId)
```
    Join an AudienceStream Trace with the given trace id.
    
    Parameters:
    traceId - Given trace id, typically a 5-digit numerical string.
  - leaveTrace
```
public static void leaveTrace()
```
    Leave an active AudienceStream Trace if one is running.
  - getCachedVisitorProfile
```
public static VisitorProfile getCachedVisitorProfile()
```
    Returns:
    the last fetched profile, it may be null.
  - getVisitorId
```
public static java.lang.String getVisitorId()
```
    Returns:
    the visitor id tied to this installation.

Class TealiumCollect

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getEventListeners

isEnabled

enable

disable

sendEvent

sendView

send

joinTrace

leaveTrace

getCachedVisitorProfile

getVisitorId