com.twitter.sdk.android.core.internal.scribe

Class ScribeClient

Object

com.twitter.sdk.android.core.internal.scribe.ScribeClient

Direct Known Subclasses:

DefaultScribeClient

public class ScribeClient
extends Object

ScribeClient for executing scribe requests, on a best effort basis. If the application crashes while a scribe request is being processed, the scribe event may be lost. To scribe an event, call scribe(ScribeEvent, long). This records the event to local storage for uploading sometime in the near future. Scribe settings will determine when the actual upload occurs. For example, scribe events may be uploaded every 60 seconds, or every 100 KB of events. Upon successful upload, scribe events are removed from local storage. To scribe an event and have it uploaded immediately, call scribeAndFlush(ScribeEvent, long).

Constructor Summary

Constructors

Constructor and Description
ScribeClient(Context context, ScheduledExecutorService executor, ScribeConfig scribeConfig, ScribeEvent.Transform transform, TwitterAuthConfig authConfig, SessionManager<? extends Session<TwitterAuthToken>> sessionManager, GuestSessionProvider guestSessionProvider, IdManager idManager) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	scribe(ScribeEvent event, long ownerId) Scribes an event.
boolean	scribeAndFlush(ScribeEvent event, long ownerId) Scribes an event and immediately flushes the event.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScribeClient

public ScribeClient(Context context,
                    ScheduledExecutorService executor,
                    ScribeConfig scribeConfig,
                    ScribeEvent.Transform transform,
                    TwitterAuthConfig authConfig,
                    SessionManager<? extends Session<TwitterAuthToken>> sessionManager,
                    GuestSessionProvider guestSessionProvider,
                    IdManager idManager)

Constructor.

Parameters:

context - the context

executor - scheduled executor service for executing scribe requests on background thread

scribeConfig - the scribe configuration

transform - the scribe event transform for serializing and deserializing scribe events flush of all queued events as long as a network connection is available.

authConfig - the auth configuration

sessionManager - the session manager

idManager - the id manager used to provide the device id

Method Detail

scribe

public boolean scribe(ScribeEvent event,
                      long ownerId)

Scribes an event.

scribeAndFlush

public boolean scribeAndFlush(ScribeEvent event,
                              long ownerId)

Scribes an event and immediately flushes the event.