TailDMP (tail-mobile-sdk API)

java.lang.Object
- digital.tail.sdk.tail_mobile_sdk.TailDMP

public class TailDMP
extends java.lang.Object

Created by babadopulos on 08/02/17.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`clientData`
`TailDMP_Config`	`config`
`android.content.Context`	`context`
`TailDMPDeviceMapping`	`deviceMapping`
`TailDMPValues`	`dmpValues`
`static int`	`JOB_ID`
`static int`	`JOB_ID_SENDALLURL`
`static int`	`JOB_ID_SENDURL`
`android.content.SharedPreferences`	`preferences`
`static java.lang.String`	`TAG`
`TailDMP_Config`	`tailDMP_config`
`TailDMP_Crypto`	`tailDMPCrypto`
`TailDMPActivityTracker`	`tracker`
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Modifier Constructor and Description

protected TailDMP()
Exists only to prevent accidental instantiation

Constructors
Modifier	Constructor and Description
`protected`	`TailDMP()` Exists only to prevent accidental instantiation

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TailDMP`	`addTags(java.lang.String tag)`
`static java.lang.String`	`convertToSHA256(java.lang.String text)` Convert an input string to a respective lowercase SHA256 hash
`void`	`enableSandbox(boolean enable)` Set/unset sandbox endpoint for debug purposes
`void`	`generateUserHashFromCPF(java.lang.String cpfToHash)` Set user data to be encrypted
`void`	`generateUserHashFromEmail(java.lang.String emailToHash)` Set user data to be encrypted
`void`	`generateUserHashFromPhone(java.lang.String phoneToHash)` Set user data to be encrypted To generate a hash from a phone use only phone numbers of its full international form ex: 11 91234-5678 = 55 11 91234-5678.
`TAsyncGetClientData`	`getClientData()` Returns client data from our servers
`static TailDMP`	`getInstance()` Return TailDMP instance.
`static void`	`initialize(android.content.Context context)` Initialize TailDMP singleton.
`boolean`	`isEnabledSandbox()`
`boolean`	`isOptin()`
`boolean`	`isSendDataOnWifiOnly()`
`void`	`onProviderInstalled()`
`void`	`onProviderInstallFailed(int i, android.content.Intent intent)`
`TailDMP`	`sendData(java.lang.String tag)` Send the devicemapping data to server without a job scheduler
`TailDMP`	`setAdvertisingId(java.lang.String advertisingId)` Set advertising id for this user
`TailDMP`	`setIntervalToExecuteJob(int minutesToCollect, int minutesToSend)` Add period in minutes to service job execution minutesToCollect : Time interval to collect data of device minutesToSend : Time interval to send data to Tailtarget
`void`	`setOptin(boolean optin)`
`void`	`setSendDataOnWifiOnly(boolean sendDataOnWifiOnly)`
`TailDMP`	`startJob()` Starts a scheduler job that sends data to a webservice according to period defined dy setIntervalToExecuteJob()
`TailDMP`	`startJobWithID(int Jobid)`
`TailDMP`	`stopJob()` Stops the service that sends data to a webservice

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

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
  - config
```
public TailDMP_Config config
```
  - tailDMPCrypto
```
public TailDMP_Crypto tailDMPCrypto
```
  - preferences
```
public android.content.SharedPreferences preferences
```
  - context
```
public android.content.Context context
```
  - deviceMapping
```
public TailDMPDeviceMapping deviceMapping
```
  - tailDMP_config
```
public TailDMP_Config tailDMP_config
```
  - dmpValues
```
public TailDMPValues dmpValues
```
  - clientData
```
public java.lang.String clientData
```
  - tracker
```
public TailDMPActivityTracker tracker
```
  - JOB_ID
```
public static final int JOB_ID
```
    See Also:
    
    Constant Field Values
  - JOB_ID_SENDURL
```
public static final int JOB_ID_SENDURL
```
    See Also:
    
    Constant Field Values
  - JOB_ID_SENDALLURL
```
public static final int JOB_ID_SENDALLURL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TailDMP
```
protected TailDMP()
```
    Exists only to prevent accidental instantiation
- Method Detail
  - getInstance
```
public static TailDMP getInstance()
                           throws TailDMPException
```
    Return TailDMP instance.
    
    Returns:
    
    TailDMP instance
    
    Throws:
    
    TailDMPException
  - initialize
```
public static void initialize(android.content.Context context)
                       throws TailDMPException
```
    Initialize TailDMP singleton. Call it only once during application start up.
    
    Parameters:
    
    context -
    
    Throws:
    
    TailDMPException
  - onProviderInstalled
```
public void onProviderInstalled()
```
  - onProviderInstallFailed
```
public void onProviderInstallFailed(int i,
                                    android.content.Intent intent)
```
  - addTags
```
public TailDMP addTags(java.lang.String tag)
```
  - sendData
```
public TailDMP sendData(java.lang.String tag)
```
    Send the devicemapping data to server without a job scheduler
    
    Returns:
  - setIntervalToExecuteJob
```
public TailDMP setIntervalToExecuteJob(int minutesToCollect,
                                       int minutesToSend)
```
    Add period in minutes to service job execution minutesToCollect : Time interval to collect data of device minutesToSend : Time interval to send data to Tailtarget
    
    Parameters:
    
    minutesToCollect -
    
    minutesToSend -
    
    Returns:
  - startJob
```
public TailDMP startJob()
```
    Starts a scheduler job that sends data to a webservice according to period defined dy setIntervalToExecuteJob()
    
    Returns:
  - startJobWithID
```
public TailDMP startJobWithID(int Jobid)
```
  - stopJob
```
public TailDMP stopJob()
```
    Stops the service that sends data to a webservice
    
    Returns:
  - getClientData
```
public TAsyncGetClientData getClientData()
```
    Returns client data from our servers
    
    Returns:
  - enableSandbox
```
public void enableSandbox(boolean enable)
```
    Set/unset sandbox endpoint for debug purposes
  - isEnabledSandbox
```
public boolean isEnabledSandbox()
```
  - generateUserHashFromEmail
```
public void generateUserHashFromEmail(java.lang.String emailToHash)
```
    Set user data to be encrypted
    
    Parameters:
    
    emailToHash -
  - generateUserHashFromCPF
```
public void generateUserHashFromCPF(java.lang.String cpfToHash)
```
    Set user data to be encrypted
    
    Parameters:
    
    cpfToHash -
  - generateUserHashFromPhone
```
public void generateUserHashFromPhone(java.lang.String phoneToHash)
```
    Set user data to be encrypted To generate a hash from a phone use only phone numbers of its full international form ex: 11 91234-5678 = 55 11 91234-5678. Note that should be no international carrier codes in the phone's shape . For more information access: https://dashboard.tailtarget.com/dmp/#/docs/a10
    
    Parameters:
    
    phoneToHash -
  - setAdvertisingId
```
public TailDMP setAdvertisingId(java.lang.String advertisingId)
                         throws TailDMPException
```
    Set advertising id for this user
    
    Parameters:
    
    advertisingId -
    
    Returns:
    
    Throws:
    
    TailDMPException
  - convertToSHA256
```
public static java.lang.String convertToSHA256(java.lang.String text)
```
    Convert an input string to a respective lowercase SHA256 hash
    
    Parameters:
    
    text - input string
    
    Returns:
    
    SHA256(text)
  - isOptin
```
public boolean isOptin()
```
  - setOptin
```
public void setOptin(boolean optin)
```
  - isSendDataOnWifiOnly
```
public boolean isSendDataOnWifiOnly()
```
  - setSendDataOnWifiOnly
```
public void setSendDataOnWifiOnly(boolean sendDataOnWifiOnly)
```

Class TailDMP

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

VERSION

config

tailDMPCrypto

preferences

context

deviceMapping

tailDMP_config

dmpValues

clientData

tracker

JOB_ID

JOB_ID_SENDURL

JOB_ID_SENDALLURL

Constructor Detail

TailDMP

Method Detail

getInstance

initialize

onProviderInstalled

onProviderInstallFailed

addTags

sendData

setIntervalToExecuteJob

startJob

startJobWithID

stopJob

getClientData

enableSandbox

isEnabledSandbox

generateUserHashFromEmail

generateUserHashFromCPF

generateUserHashFromPhone

setAdvertisingId

convertToSHA256

isOptin

setOptin

isSendDataOnWifiOnly

setSendDataOnWifiOnly