SalesforceAnalyticsManager

java.lang.Object
- com.salesforce.androidsdk.analytics.SalesforceAnalyticsManager

```
public class SalesforceAnalyticsManager
extends java.lang.Object
```
This class contains APIs that can be used to interact with the SalesforceAnalytics library.

Author:

bhariharan

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType
The available Salesforce analytics publishing types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType` The available Salesforce analytics publishing types.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRemotePublisher(java.lang.Class<? extends Transform> transformer, java.lang.Class<? extends AnalyticsPublisher> publisher)` Adds a remote publisher to publish events to.
`static SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType`	`analyticsPublishingType()` The enabled Salesforce analytics publishing type.
`void`	`enableLogging(boolean enabled)` Disables or enables logging of events.
`AnalyticsManager`	`getAnalyticsManager()` Returns an instance of analytics manager.
`static DeviceAppAttributes`	`getDeviceAppAttributes()` Returns the device app attributes associated with this device.
`EventStoreManager`	`getEventStoreManager()` Returns an instance of event store manager.
`static SalesforceAnalyticsManager`	`getInstance(UserAccount account)` Returns the instance of this class associated with this user account.
`static SalesforceAnalyticsManager`	`getInstance(UserAccount account, java.lang.String communityId)` Returns the instance of this class associated with this user and community.
`static int`	`getPublishFrequencyInHours()` Deprecated. Planned for removal 13.0. Use `getPublishPeriodicallyFrequencyHours()` )}.
`static int`	`getPublishPeriodicallyFrequencyHours()` Returns the publish frequency currently set, in hours.
`static SalesforceAnalyticsManager`	`getUnauthenticatedInstance()` Returns the instance of this class associated with an unauthenticated user context.
`boolean`	`isLoggingEnabled()` Returns whether logging is enabled or disabled.
`void`	`publishAllEvents()` Publishes all stored events to all registered network endpoints after applying the required event format transforms.
`void`	`publishEvent(InstrumentationEvent event)` Publishes an event to all registered network endpoints after applying the required event format transforms.
`void`	`publishEvents(java.lang.Iterable<InstrumentationEvent> events)` Publishes a list of events to all registered network endpoints after applying the required event format transforms.
`static void`	`reset(UserAccount account)` Resets the instance of this class associated with this user account.
`static void`	`reset(UserAccount account, java.lang.String communityId)` Resets the instance of this class associated with this user and community.
`static void`	`resetUnauthenticatedInstance()` Resets the instance of this class associated with an unauthenticated user context.
`static void`	`setAnalyticsPublishingType(SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType value)` Sets the enabled Salesforce analytics publishing type.
`static void`	`setEventPublishBatchSize(int batchSize)` Set the batch size for publishing instrumentation events.
`static void`	`setPublishFrequencyInHours(int periodicBackgroundPublishingHoursInterval)` Deprecated. Planned for removal 13.0. Use `setPublishPeriodicallyFrequencyHours(int)` )}.
`static void`	`setPublishPeriodicallyFrequencyHours(int periodicBackgroundPublishingHoursInterval)` Sets the interval for periodic background publishing in hours.
`void`	`updateLoggingPrefs()` Updates the preferences of this library.

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

- Method Detail
  - getUnauthenticatedInstance
```
public static SalesforceAnalyticsManager getUnauthenticatedInstance()
```
    Returns the instance of this class associated with an unauthenticated user context.
    
    Returns:
    
    Instance of this class.
  - getInstance
```
public static SalesforceAnalyticsManager getInstance(UserAccount account)
```
    Returns the instance of this class associated with this user account.
    
    Parameters:
    
    account - User account.
    
    Returns:
    
    Instance of this class.
  - getInstance
```
public static SalesforceAnalyticsManager getInstance(UserAccount account,
                                                     java.lang.String communityId)
```
    Returns the instance of this class associated with this user and community.
    
    Parameters:
    
    account - User account.
    
    communityId - Community ID.
    
    Returns:
    
    Instance of this class.
  - resetUnauthenticatedInstance
```
public static void resetUnauthenticatedInstance()
```
    Resets the instance of this class associated with an unauthenticated user context.
  - reset
```
public static void reset(UserAccount account)
```
    Resets the instance of this class associated with this user account.
    
    Parameters:
    
    account - User account.
  - reset
```
public static void reset(UserAccount account,
                         java.lang.String communityId)
```
    Resets the instance of this class associated with this user and community.
    
    Parameters:
    
    account - User account.
    
    communityId - Community ID.
  - setPublishPeriodicallyFrequencyHours
```
public static void setPublishPeriodicallyFrequencyHours(int periodicBackgroundPublishingHoursInterval)
```
    Sets the interval for periodic background publishing in hours.
    
    Parameters:
    
    periodicBackgroundPublishingHoursInterval - The interval for periodic background publishing in hours. It is recommended to keep this value under seven days
    
    See Also:
    
    setAnalyticsPublishingType(SalesforceAnalyticsPublishingType)
  - setPublishFrequencyInHours
```
@Deprecated
public static void setPublishFrequencyInHours(int periodicBackgroundPublishingHoursInterval)
```
    Deprecated. Planned for removal 13.0. Use setPublishPeriodicallyFrequencyHours(int) )}.
    
    Sets the interval for periodic background publishing in hours.
  - analyticsPublishingType
```
public static SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType analyticsPublishingType()
```
    The enabled Salesforce analytics publishing type.
    
    Returns:
    
    The enabled Salesforce analytics publishing type
  - setAnalyticsPublishingType
```
public static void setAnalyticsPublishingType(SalesforceAnalyticsManager.SalesforceAnalyticsPublishingType value)
```
    Sets the enabled Salesforce analytics publishing type.
    
    Parameters:
    
    value - The Salesforce analytics publishing type
  - setEventPublishBatchSize
```
public static void setEventPublishBatchSize(int batchSize)
```
    Set the batch size for publishing instrumentation events. Will limit the number of events sent in a single network request to the specified batch size. Will silently return if batch size is less than or equal to zero.
    
    Parameters:
    
    batchSize - Event batch size
  - getPublishPeriodicallyFrequencyHours
```
public static int getPublishPeriodicallyFrequencyHours()
```
    Returns the publish frequency currently set, in hours.
    
    Returns:
    
    Publish frequency, in hours.
  - getPublishFrequencyInHours
```
@Deprecated
public static int getPublishFrequencyInHours()
```
    Deprecated. Planned for removal 13.0. Use getPublishPeriodicallyFrequencyHours() )}.
    
    Returns the publish frequency currently set, in hours.
    
    Returns:
    
    Publish frequency, in hours.
  - getEventStoreManager
```
public EventStoreManager getEventStoreManager()
```
    Returns an instance of event store manager.
    
    Returns:
    
    Event store manager.
  - getAnalyticsManager
```
public AnalyticsManager getAnalyticsManager()
```
    Returns an instance of analytics manager.
    
    Returns:
    
    Analytics manager.
  - enableLogging
```
public void enableLogging(boolean enabled)
```
    Disables or enables logging of events. If logging is disabled, no events will be stored. However, publishing of events is still possible.
    
    Parameters:
    
    enabled - True - if logging should be enabled, False - otherwise.
  - updateLoggingPrefs
```
public void updateLoggingPrefs()
```
    Updates the preferences of this library.
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    Returns whether logging is enabled or disabled.
    
    Returns:
    
    True - if logging is enabled, False - otherwise.
  - publishAllEvents
```
public void publishAllEvents()
```
    Publishes all stored events to all registered network endpoints after applying the required event format transforms. Stored events will be deleted if publishing was successful for all registered endpoints. This method should NOT be called from the main thread.
  - publishEvents
```
public void publishEvents(java.lang.Iterable<InstrumentationEvent> events)
```
    Publishes a list of events to all registered network endpoints after applying the required event format transforms. Stored events will be deleted if publishing was successful for all registered endpoints. This method should NOT be called from the main thread.
    
    Parameters:
    
    events - Iterable of events.
  - publishEvent
```
public void publishEvent(InstrumentationEvent event)
```
    Publishes an event to all registered network endpoints after applying the required event format transforms. Stored event will be deleted if publishing was successful for all registered endpoints. This method should NOT be called from the main thread.
    
    Parameters:
    
    event - Event.
  - addRemotePublisher
```
public void addRemotePublisher(java.lang.Class<? extends Transform> transformer,
                               java.lang.Class<? extends AnalyticsPublisher> publisher)
```
    Adds a remote publisher to publish events to.
    
    Parameters:
    
    transformer - Transformer class.
    
    publisher - Publisher class.
  - getDeviceAppAttributes
```
public static DeviceAppAttributes getDeviceAppAttributes()
```
    Returns the device app attributes associated with this device.
    
    Returns:
    
    Device app attributes.

Class SalesforceAnalyticsManager

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUnauthenticatedInstance

getInstance

getInstance

resetUnauthenticatedInstance

reset

reset

setPublishPeriodicallyFrequencyHours

setPublishFrequencyInHours

analyticsPublishingType

setAnalyticsPublishingType

setEventPublishBatchSize

getPublishPeriodicallyFrequencyHours

getPublishFrequencyInHours

getEventStoreManager

getAnalyticsManager

enableLogging

updateLoggingPrefs

isLoggingEnabled

publishAllEvents

publishEvents

publishEvent

addRemotePublisher

getDeviceAppAttributes