FHSyncConfig (Feedhenry Android SDK Library 3.1.0 API)

java.lang.Object
- com.feedhenry.sdk.sync.FHSyncConfig

```
public class FHSyncConfig
extends Object
```
Configuration options for the sync framework.

Constructor Summary

Constructors
Constructor and Description

FHSyncConfig()

Constructors
Constructor and Description
`FHSyncConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`FHSyncConfig`	`clone()`
`static FHSyncConfig`	`fromJSON(JSONObject pObj)` Creates a new configuration object from JSON.
`int`	`getCrashCountWait()` Gets the maximum crash count.
`JSONObject`	`getJSON()` Gets a JSON representation of the configuration object.
`int`	`getSyncFrequency()` Gets the current sync interval.
`boolean`	`isAutoSyncLocalUpdates()` Gets whether the sync client automatically updates on local changes.
`boolean`	`isNotifyClientStorageFailed()` Gets whether the sync client notifies on a client storage failed event.
`boolean`	`isNotifyDeltaReceived()` Gets whether the sync client notifies on a delta received event.
`boolean`	`isNotifyLocalUpdateApplied()` Gets whether the sync client notifies on a local updates applied event.
`boolean`	`isNotifyOfflineUpdate()` Gets whether the sync client notifies on an offline update event.
`boolean`	`isNotifyRemoteUpdateApplied()` Gets whether the sync client notifies on a remote update applied event.
`boolean`	`isNotifySyncCollisions()` Gets whether the sync client notifies on a sync collision event.
`boolean`	`isNotifySyncComplete()` Gets whether the sync client notifies on a sync complete event.
`boolean`	`isNotifySyncFailed()` Gets whether the sync client notifies on a sync failed event.
`boolean`	`isNotifySyncStarted()` Gets whether the sync client notifies on a sync start event.
`boolean`	`isNotifyUpdateFailed()` Gets whether the sync client notifies on an update failed event.
`boolean`	`isResendCrashedUpdates()` Gets whether changes should be re-submitted or abandoned when the crash limit is reached.
`void`	`setAutoSyncLocalUpdates(boolean mAutoSyncLocalUpdates)` Sets if the sync client should automatically update on local changes.
`void`	`setCrashCountWait(int mCrashCountWait)` Sets the maximum crash count number.
`void`	`setNotifyClientStorageFailed(boolean pNotifyClientStorageFailed)` Sets if the sync client should notify on a client storage failed event.
`void`	`setNotifyDeltaReceived(boolean pNotifyDeltaReceived)` Sets if the sync client should notify on a delta received event.
`void`	`setNotifyLocalUpdateApplied(boolean pNotifyLocalUpdateApplied)` Sets if the sync client should notify on a local updates applied event.
`void`	`setNotifyOfflineUpdate(boolean pNotifyOfflineUpdate)` Sets if the sync client should notify on an offline update event.
`void`	`setNotifyRemoteUpdateApplied(boolean pNotifyRemoteUpdateApplied)` Sets if the sync client should notify on a remote updates applied event.
`void`	`setNotifySyncCollisions(boolean pNotifySyncCollsion)` Sets if the sync client should notify on a sync collision event.
`void`	`setNotifySyncComplete(boolean pNotifySyncComplete)` Sets if the sync client should notify on a sync complete event.
`void`	`setNotifySyncFailed(boolean pNotifySyncFailed)` Sets if the sync client should notify on a sync failed event.
`void`	`setNotifySyncStarted(boolean pNotifySyncStarted)` Sets if the sync client should notify on a sync start event.
`void`	`setNotifyUpdateFailed(boolean pNotifyUpdateFailed)` Sets if the sync client should notify on an update failed event.
`void`	`setResendCrashedUpdates(boolean mResendCrashedUpdates)` Sets whether changes should be re-submitted once the crash limit is reached.
`void`	`setSyncFrequency(int pFrequencySeconds)` Sets the sync interval in seconds.
`void`	`setUseCustomSync(boolean mUseCustomSync)` Set if legacy mode is used
`boolean`	`useCustomSync()` Check if legacy mode is enabled

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

- Constructor Detail
  - FHSyncConfig
```
public FHSyncConfig()
```
- Method Detail
  - setSyncFrequency
```
public void setSyncFrequency(int pFrequencySeconds)
```
    Sets the sync interval in seconds.
    
    Parameters:
    pFrequencySeconds - the new sync interval
  - getSyncFrequency
```
public int getSyncFrequency()
```
    Gets the current sync interval.
    
    Returns:
    the current sync interval.
  - isNotifySyncStarted
```
public boolean isNotifySyncStarted()
```
    Gets whether the sync client notifies on a sync start event.
    
    Returns:
    whether a sync start event will trigger a notification
  - setNotifySyncStarted
```
public void setNotifySyncStarted(boolean pNotifySyncStarted)
```
    Sets if the sync client should notify on a sync start event.
    
    Parameters:
    pNotifySyncStarted - whether to notify on sync start
  - isNotifySyncComplete
```
public boolean isNotifySyncComplete()
```
    Gets whether the sync client notifies on a sync complete event.
    
    Returns:
    whether a sync complete event will trigger a notification
  - setNotifySyncComplete
```
public void setNotifySyncComplete(boolean pNotifySyncComplete)
```
    Sets if the sync client should notify on a sync complete event.
    
    Parameters:
    pNotifySyncComplete - whether to notify on sync complete
  - isNotifySyncCollisions
```
public boolean isNotifySyncCollisions()
```
    Gets whether the sync client notifies on a sync collision event.
    
    Returns:
    whether a sync collision event will trigger a notification
  - setNotifySyncCollisions
```
public void setNotifySyncCollisions(boolean pNotifySyncCollsion)
```
    Sets if the sync client should notify on a sync collision event.
    
    Parameters:
    pNotifySyncCollsion - whether to notify on sync collision
  - isNotifyOfflineUpdate
```
public boolean isNotifyOfflineUpdate()
```
    Gets whether the sync client notifies on an offline update event.
    
    Returns:
    whether an offline update event will trigger a notification
  - setNotifyOfflineUpdate
```
public void setNotifyOfflineUpdate(boolean pNotifyOfflineUpdate)
```
    Sets if the sync client should notify on an offline update event.
    
    Parameters:
    pNotifyOfflineUpdate - whether to notify on offline update
  - isNotifyUpdateFailed
```
public boolean isNotifyUpdateFailed()
```
    Gets whether the sync client notifies on an update failed event.
    
    Returns:
    whether an update failed event will trigger a notification
  - setNotifyUpdateFailed
```
public void setNotifyUpdateFailed(boolean pNotifyUpdateFailed)
```
    Sets if the sync client should notify on an update failed event.
    
    Parameters:
    pNotifyUpdateFailed - whether to notify on update failed
  - isNotifyRemoteUpdateApplied
```
public boolean isNotifyRemoteUpdateApplied()
```
    Gets whether the sync client notifies on a remote update applied event.
    
    Returns:
    whether a remote update applied event will trigger a notification
  - setNotifyRemoteUpdateApplied
```
public void setNotifyRemoteUpdateApplied(boolean pNotifyRemoteUpdateApplied)
```
    Sets if the sync client should notify on a remote updates applied event.
    
    Parameters:
    pNotifyRemoteUpdateApplied - whether to notify on remote updates applied
  - isNotifyLocalUpdateApplied
```
public boolean isNotifyLocalUpdateApplied()
```
    Gets whether the sync client notifies on a local updates applied event.
    
    Returns:
    whether a local updates applied event will trigger a notification
  - setNotifyLocalUpdateApplied
```
public void setNotifyLocalUpdateApplied(boolean pNotifyLocalUpdateApplied)
```
    Sets if the sync client should notify on a local updates applied event.
    
    Parameters:
    pNotifyLocalUpdateApplied - whether to notify on local updates applied
  - isNotifyDeltaReceived
```
public boolean isNotifyDeltaReceived()
```
    Gets whether the sync client notifies on a delta received event.
    
    Returns:
    whether a delta received event will trigger a notification
  - setNotifyDeltaReceived
```
public void setNotifyDeltaReceived(boolean pNotifyDeltaReceived)
```
    Sets if the sync client should notify on a delta received event.
    
    Parameters:
    pNotifyDeltaReceived - whether to notify on delta received
  - isNotifySyncFailed
```
public boolean isNotifySyncFailed()
```
    Gets whether the sync client notifies on a sync failed event.
    
    Returns:
    whether a sync failed event will trigger a notification
  - setNotifySyncFailed
```
public void setNotifySyncFailed(boolean pNotifySyncFailed)
```
    Sets if the sync client should notify on a sync failed event.
    
    Parameters:
    pNotifySyncFailed - whether to notify on sync failed
  - setNotifyClientStorageFailed
```
public void setNotifyClientStorageFailed(boolean pNotifyClientStorageFailed)
```
    Sets if the sync client should notify on a client storage failed event.
    
    Parameters:
    pNotifyClientStorageFailed - whether to notify on client storage failed
  - isNotifyClientStorageFailed
```
public boolean isNotifyClientStorageFailed()
```
    Gets whether the sync client notifies on a client storage failed event.
    
    Returns:
    whether a client storage failed event will trigger a notification
  - isAutoSyncLocalUpdates
```
public boolean isAutoSyncLocalUpdates()
```
    Gets whether the sync client automatically updates on local changes.
    
    Returns:
    whether local changes are automatically synced
  - setAutoSyncLocalUpdates
```
public void setAutoSyncLocalUpdates(boolean mAutoSyncLocalUpdates)
```
    Sets if the sync client should automatically update on local changes.
    
    Parameters:
    mAutoSyncLocalUpdates - whether local changes should automatically sync
  - getCrashCountWait
```
public int getCrashCountWait()
```
    Gets the maximum crash count.
    
    Returns:
    the maximum crash count number
  - setCrashCountWait
```
public void setCrashCountWait(int mCrashCountWait)
```
    Sets the maximum crash count number. Changes may fail to be applied (crash) due to various reasons (e.g., network issues). If the crash count reaches this limit, the changes will be either re-submitted or abandoned.
    
    Parameters:
    mCrashCountWait - the crash limit
  - isResendCrashedUpdates
```
public boolean isResendCrashedUpdates()
```
    Gets whether changes should be re-submitted or abandoned when the crash limit is reached.
    
    Returns:
    true or false
  - setResendCrashedUpdates
```
public void setResendCrashedUpdates(boolean mResendCrashedUpdates)
```
    Sets whether changes should be re-submitted once the crash limit is reached. If false, changes will be discarded.
    
    Parameters:
    mResendCrashedUpdates - true or false.
  - setUseCustomSync
```
public void setUseCustomSync(boolean mUseCustomSync)
```
    Set if legacy mode is used
    
    Parameters:
    mUseCustomSync -
  - useCustomSync
```
public boolean useCustomSync()
```
    Check if legacy mode is enabled
    
    Returns:
  - getJSON
```
public JSONObject getJSON()
```
    Gets a JSON representation of the configuration object.
    
    Returns:
    The JSON object
  - fromJSON
```
public static FHSyncConfig fromJSON(JSONObject pObj)
```
    Creates a new configuration object from JSON.
    
    Parameters:
    pObj - the sync config JSON
    
    Returns:
    the new sync config object
  - clone
```
public FHSyncConfig clone()
```
    Overrides:
    
    clone in class Object

Class FHSyncConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FHSyncConfig

Method Detail

setSyncFrequency

getSyncFrequency

isNotifySyncStarted

setNotifySyncStarted

isNotifySyncComplete

setNotifySyncComplete

isNotifySyncCollisions

setNotifySyncCollisions

isNotifyOfflineUpdate

setNotifyOfflineUpdate

isNotifyUpdateFailed

setNotifyUpdateFailed

isNotifyRemoteUpdateApplied

setNotifyRemoteUpdateApplied

isNotifyLocalUpdateApplied

setNotifyLocalUpdateApplied

isNotifyDeltaReceived

setNotifyDeltaReceived

isNotifySyncFailed

setNotifySyncFailed

setNotifyClientStorageFailed

isNotifyClientStorageFailed

isAutoSyncLocalUpdates

setAutoSyncLocalUpdates

getCrashCountWait

setCrashCountWait

isResendCrashedUpdates

setResendCrashedUpdates

setUseCustomSync

useCustomSync

getJSON

fromJSON

clone