CloudConnectorPreferencesManager

java.lang.Object
- com.digi.android.cloudconnector.CloudConnectorPreferencesManager

```
public class CloudConnectorPreferencesManager
extends java.lang.Object
```
This manager handles all the Cloud Connector service preferences that can be read and set by the user.
Use the CloudConnectorManager.getPreferencesManager() to retrieve an instance of this object.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CONTACT_MAXIMUM_LENGTH`	Device contact information maximum length (in characters).
`static boolean`	`DEFAULT_ENABLE_AUTO_CONNECT`	Default value for enabling auto connect: .
`static boolean`	`DEFAULT_ENABLE_COMPRESSION`	Default value for enabling compression: .
`static boolean`	`DEFAULT_ENABLE_RECONNECT`	Default value for enabling reconnect: .
`static boolean`	`DEFAULT_ENABLE_SECURE_CONNECTION`	Default value for enabling secure connection: .
`static int`	`DEFAULT_RECONNECT_TIME`	Default value for reconnect time: seconds.
`static int`	`DESCRIPTION_MAXIMUM_LENGTH`	Device description maximum length (in characters).
`static int`	`DEVICE_NAME_MAXIMUM_LENGTH`	Device name maximum length (in characters).
`static int`	`MAXIMUM_SAMPLES_BUFFER_SIZE`	The maximum size of the samples buffer.
`static int`	`MAXIMUM_UPLOAD_SAMPLES_SIZE`	System monitor maximum upload samples size.
`static int`	`MINIMUM_SAMPLE_RATE`	System monitor minimum sample rate in seconds.
`static int`	`RECONNECT_TIME_MAXIMUM_VALUE`	Reconnect time maximum value (in seconds).
`static int`	`RECONNECT_TIME_MINIMUM_VALUE`	Reconnect time minimum value (in seconds).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`enableSystemMonitor(boolean enable)`	Sets the new value of the enable system monitor setting.
`void`	`enableSystemMonitorCPULoadSampling(boolean enable)`	Sets the new value of the enable system monitor CPU load sampling.
`void`	`enableSystemMonitorCPUTemperatureSampling(boolean enable)`	Sets the new value of the enable system monitor CPU temperature sampling.
`void`	`enableSystemMonitorMemorySampling(boolean enable)`	Sets the new value of the enable system monitor memory sampling.
`java.lang.String`	`getAppUpdateDirectory()`	Returns the directory used to hold applications and updates.
`java.lang.String`	`getDeviceContactInformation()`	Returns the configured device contact information preference.
`java.lang.String`	`getDeviceDescription()`	Returns the configured device description preference.
`java.lang.String`	`getDeviceID()`	Returns the Device ID.
`java.lang.String`	`getDeviceName()`	Returns the configured device name preference.
`int`	`getReconnectTime()`	Returns the configured reconnect time delay setting in seconds.
`int`	`getSystemMonitorSampleRate()`	Returns the system monitor sample rate.
`int`	`getSystemMonitorSamplesBufferSize()`	Returns the system monitor samples buffer size.
`int`	`getSystemMonitorUploadSamplesSize()`	Returns the system monitor number of samples to store for each channel before uploading to Device Cloud.
`java.lang.String`	`getURL()`	Returns the configured Cloud Connector URL preference.
`java.lang.String`	`getVendorID()`	Returns the device vendor ID.
`boolean`	`isAutoConnectEnabled()`	Returns whether auto-connect setting is enabled.
`boolean`	`isCompressionEnabled()`	Returns whether messages compression is enabled.
`boolean`	`isReconnectEnabled()`	Returns whether reconnect setting is enabled.
`boolean`	`isSecureConnectionEnabled()`	Returns whether secure connection is enabled.
`boolean`	`isSystemMonitorCPULoadSamplingEnabled()`	Returns whether the system monitor CPU load sampling is enabled.
`boolean`	`isSystemMonitorCPUTemperatureSamplingEnabled()`	Returns whether the system monitor CPU temperature sampling is enabled.
`boolean`	`isSystemMonitorEnabled()`	Returns the current state of the system monitor.
`boolean`	`isSystemMonitorMemorySamplingEnabled()`	Returns whether the system monitor memory sampling is enabled.
`void`	`setAppUpdateDirectory(java.lang.String appsDir)`	Sets the directory used to hold applications and updates.
`void`	`setAutoConnectEnabled(boolean enabled)`	Sets the new value of the auto-connect setting.
`void`	`setCompressionEnabled(boolean enabled)`	Sets the new value of the compress messages setting.
`void`	`setDeviceContactInformation(java.lang.String contactInformation)`	Sets the device contact information preference.
`void`	`setDeviceDescription(java.lang.String deviceDescription)`	Sets the device description preference.
`void`	`setDeviceName(java.lang.String deviceName)`	Sets the device name preference.
`void`	`setReconnectEnabled(boolean enabled)`	Sets the new value of the reconnect setting.
`void`	`setReconnectTime(int time)`	Sets the new value for the reconnect time setting in seconds.
`void`	`setSecureConnectionEnabled(boolean enabled)`	Sets the new value for the use secure connection setting.
`void`	`setSystemMonitorSampleRate(int sampleRate)`	Sets the system monitor sample rate.
`void`	`setSystemMonitorSamplesBufferSize(int size)`	Sets the system monitor samples buffer size.
`void`	`setSystemMonitorUploadSamplesSize(int size)`	Sets the system monitor number of samples to store for each channel before uploading to Device Cloud.
`void`	`setURL(java.lang.String url)`	Sets the Cloud Connector URL preference.
`void`	`setVendorID(java.lang.String vendorID)`	Sets the Cloud Connector Vendor ID setting.

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

- Field Detail
  - RECONNECT_TIME_MINIMUM_VALUE
```
public static final int RECONNECT_TIME_MINIMUM_VALUE
```
    Reconnect time minimum value (in seconds).
    The value of this constant is seconds.
    
    See Also:
    
    RECONNECT_TIME_MAXIMUM_VALUE, Constant Field Values
  - RECONNECT_TIME_MAXIMUM_VALUE
```
public static final int RECONNECT_TIME_MAXIMUM_VALUE
```
    Reconnect time maximum value (in seconds).
    The value of this constant is seconds.
    
    See Also:
    
    RECONNECT_TIME_MINIMUM_VALUE, Constant Field Values
  - DEVICE_NAME_MAXIMUM_LENGTH
```
public static final int DEVICE_NAME_MAXIMUM_LENGTH
```
    Device name maximum length (in characters).
    The value of this constant is characters.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION_MAXIMUM_LENGTH
```
public static final int DESCRIPTION_MAXIMUM_LENGTH
```
    Device description maximum length (in characters).
    The value of this constant is characters.
    
    See Also:
    
    Constant Field Values
  - CONTACT_MAXIMUM_LENGTH
```
public static final int CONTACT_MAXIMUM_LENGTH
```
    Device contact information maximum length (in characters).
    The value of this constant is characters.
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_UPLOAD_SAMPLES_SIZE
```
public static final int MAXIMUM_UPLOAD_SAMPLES_SIZE
```
    System monitor maximum upload samples size.
    The value of this constant is .
    
    See Also:
    
    Constant Field Values
  - MINIMUM_SAMPLE_RATE
```
public static final int MINIMUM_SAMPLE_RATE
```
    System monitor minimum sample rate in seconds.
    The value of this constant is .
    
    See Also:
    
    Constant Field Values
  - MAXIMUM_SAMPLES_BUFFER_SIZE
```
public static final int MAXIMUM_SAMPLES_BUFFER_SIZE
```
    The maximum size of the samples buffer.
    The value of this constant is .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_AUTO_CONNECT
```
public static final boolean DEFAULT_ENABLE_AUTO_CONNECT
```
    Default value for enabling auto connect: .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_RECONNECT
```
public static final boolean DEFAULT_ENABLE_RECONNECT
```
    Default value for enabling reconnect: .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_TIME
```
public static final int DEFAULT_RECONNECT_TIME
```
    Default value for reconnect time: seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_SECURE_CONNECTION
```
public static final boolean DEFAULT_ENABLE_SECURE_CONNECTION
```
    Default value for enabling secure connection: .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_COMPRESSION
```
public static final boolean DEFAULT_ENABLE_COMPRESSION
```
    Default value for enabling compression: .
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isAutoConnectEnabled
```
public boolean isAutoConnectEnabled()
```
    Returns whether auto-connect setting is enabled.
    Auto-connect setting determines whether Cloud Connector service should connect as soon as device boots or there is internet connectivity available.
    
    Returns:
    
    true if auto-connect is enabled, false otherwise.
    
    See Also:
    
    setAutoConnectEnabled(boolean)
  - setAutoConnectEnabled
```
public void setAutoConnectEnabled(boolean enabled)
```
    Sets the new value of the auto-connect setting.
    Auto-connect setting determines whether Cloud Connector service should connect as soon as device boots or there is internet connectivity available.
    
    Parameters:
    
    enabled - true to enable auto-connect, false otherwise.
    
    See Also:
    
    isAutoConnectEnabled()
  - isReconnectEnabled
```
public boolean isReconnectEnabled()
```
    Returns whether reconnect setting is enabled.
    Reconnect setting determines whether Cloud Connector should attempt a reconnect after connection is lost due to error.
    
    Returns:
    
    true if reconnect is enabled, false otherwise.
    
    See Also:
    
    getReconnectTime(), setReconnectEnabled(boolean), setReconnectTime(int)
  - setReconnectEnabled
```
public void setReconnectEnabled(boolean enabled)
```
    Sets the new value of the reconnect setting.
    
    Parameters:
    
    enabled - true to enable reconnect, false otherwise.
    
    See Also:
    
    isReconnectEnabled(), getReconnectTime(), setReconnectTime(int)
  - getReconnectTime
```
public int getReconnectTime()
```
    Returns the configured reconnect time delay setting in seconds.
    
    Returns:
    
    Reconnect time delay setting value.
    
    See Also:
    
    isReconnectEnabled(), setReconnectTime(int), setReconnectEnabled(boolean)
  - setReconnectTime
```
public void setReconnectTime(int time)
```
    Sets the new value for the reconnect time setting in seconds.
    The value should be:
    - time > RECONNECT_TIME_MINIMUM_VALUE ( seconds)
    - time < RECONNECT_TIME_MAXIMUM_VALUE ( seconds)
    Parameters:
    
    time - New value for the reconnect time setting.
    
    Throws:
    
    java.lang.IllegalArgumentException - If time < RECONNECT_TIME_MINIMUM_VALUE or if time > RECONNECT_TIME_MAXIMUM_VALUE.
    
    See Also:
    
    RECONNECT_TIME_MAXIMUM_VALUE, RECONNECT_TIME_MINIMUM_VALUE, getReconnectTime(), isReconnectEnabled(), setReconnectEnabled(boolean)
  - isSecureConnectionEnabled
```
public boolean isSecureConnectionEnabled()
```
    Returns whether secure connection is enabled.
    
    Returns:
    
    true if secure connection is enabled, false otherwise.
    
    See Also:
    
    setSecureConnectionEnabled(boolean)
  - setSecureConnectionEnabled
```
public void setSecureConnectionEnabled(boolean enabled)
```
    Sets the new value for the use secure connection setting.
    
    Parameters:
    
    enabled - true to enable secure connection, false otherwise.
    
    See Also:
    
    isSecureConnectionEnabled()
  - isCompressionEnabled
```
public boolean isCompressionEnabled()
```
    Returns whether messages compression is enabled.
    
    Returns:
    
    true if messages compression is enabled, false otherwise.
    
    See Also:
    
    setCompressionEnabled(boolean)
  - setCompressionEnabled
```
public void setCompressionEnabled(boolean enabled)
```
    Sets the new value of the compress messages setting.
    
    Parameters:
    
    enabled - true to compress messages, false otherwise.
    
    See Also:
    
    isCompressionEnabled()
  - getVendorID
```
public java.lang.String getVendorID()
```
    Returns the device vendor ID.
    Vendor ID follows this format: '0x01234567'
    
    Returns:
    
    The device vendor ID, null if not configured.
    
    See Also:
    
    setVendorID(String)
  - setVendorID
```
public void setVendorID(java.lang.String vendorID)
```
    Sets the Cloud Connector Vendor ID setting.
    Vendor ID follows this format: '0x01234567'
    
    Parameters:
    
    vendorID - The Cloud Connector VendorID setting.
    
    Throws:
    
    java.lang.IllegalArgumentException - If vendorID is invalid.
    
    java.lang.NullPointerException - If vendorID is null.
    
    See Also:
    
    getVendorID()
  - getURL
```
public java.lang.String getURL()
```
    Returns the configured Cloud Connector URL preference.
    
    Returns:
    
    Cloud Connector URL setting value, null if not configured.
    
    See Also:
    
    setURL(String)
  - setURL
```
public void setURL(java.lang.String url)
```
    Sets the Cloud Connector URL preference.
    
    Parameters:
    
    url - The new Cloud Connector URL.
    
    Throws:
    
    java.lang.NullPointerException - If url is null.
    
    See Also:
    
    getURL()
  - getDeviceID
```
public java.lang.String getDeviceID()
```
    Returns the Device ID.
    
    Returns:
    
    The device ID.
  - getDeviceName
```
public java.lang.String getDeviceName()
```
    Returns the configured device name preference.
    
    Returns:
    
    Device name setting value, null if not configured.
    
    See Also:
    
    setDeviceName(String)
  - setDeviceName
```
public void setDeviceName(java.lang.String deviceName)
```
    Sets the device name preference.
    
    Parameters:
    
    deviceName - The new device name value.
    
    Throws:
    
    java.lang.IllegalArgumentException - If deviceName is invalid.
    
    java.lang.NullPointerException - If deviceName is null.
    
    See Also:
    
    DEVICE_NAME_MAXIMUM_LENGTH, getDeviceName()
  - getDeviceDescription
```
public java.lang.String getDeviceDescription()
```
    Returns the configured device description preference.
    
    Returns:
    
    Device description setting value, null if not configured.
    
    See Also:
    
    setDeviceDescription(String)
  - setDeviceDescription
```
public void setDeviceDescription(java.lang.String deviceDescription)
```
    Sets the device description preference.
    
    Parameters:
    
    deviceDescription - The new device description value.
    
    Throws:
    
    java.lang.IllegalArgumentException - If deviceDescription is invalid.
    
    java.lang.NullPointerException - If deviceDescription is null.
    
    See Also:
    
    DESCRIPTION_MAXIMUM_LENGTH, getDeviceDescription()
  - getDeviceContactInformation
```
public java.lang.String getDeviceContactInformation()
```
    Returns the configured device contact information preference.
    
    Returns:
    
    Device contact information setting value, null if not configured.
    
    See Also:
    
    setDeviceContactInformation(String)
  - setDeviceContactInformation
```
public void setDeviceContactInformation(java.lang.String contactInformation)
```
    Sets the device contact information preference.
    
    Parameters:
    
    contactInformation - The new device contact information value.
    
    Throws:
    
    java.lang.IllegalArgumentException - If contactInformation is invalid.
    
    java.lang.NullPointerException - If contactInformation is null.
    
    See Also:
    
    CONTACT_MAXIMUM_LENGTH, getDeviceContactInformation()
  - enableSystemMonitor
```
public void enableSystemMonitor(boolean enable)
```
    Sets the new value of the enable system monitor setting.
    
    Parameters:
    
    enable - true to enable the system monitor, false to disable it.
    
    See Also:
    
    isSystemMonitorEnabled()
  - isSystemMonitorEnabled
```
public boolean isSystemMonitorEnabled()
```
    Returns the current state of the system monitor.
    
    Returns:
    
    true if the system monitor is enabled, false otherwise.
    
    See Also:
    
    enableSystemMonitor(boolean)
  - setSystemMonitorSampleRate
```
public void setSystemMonitorSampleRate(int sampleRate)
```
    Sets the system monitor sample rate.
    
    Parameters:
    
    sampleRate - The new system monitor sample rate (in seconds).
    
    Throws:
    
    java.lang.IllegalArgumentException - If sampleRate < MINIMUM_SAMPLE_RATE ( seconds).
    
    See Also:
    
    MINIMUM_SAMPLE_RATE, getSystemMonitorSampleRate()
  - getSystemMonitorSampleRate
```
public int getSystemMonitorSampleRate()
```
    Returns the system monitor sample rate.
    
    Returns:
    
    The system monitor sample rate. (in seconds)
    
    See Also:
    
    setSystemMonitorSampleRate(int)
  - setSystemMonitorUploadSamplesSize
```
public void setSystemMonitorUploadSamplesSize(int size)
```
    Sets the system monitor number of samples to store for each channel before uploading to Device Cloud.
    
    Parameters:
    
    size - The system monitor number of samples to store in the buffer for each channel before uploading to Device Cloud.
    
    Throws:
    
    java.lang.IllegalArgumentException - If size < 1 or if size > MAXIMUM_UPLOAD_SAMPLES_SIZE ( seconds).
    
    See Also:
    
    MAXIMUM_UPLOAD_SAMPLES_SIZE, getSystemMonitorUploadSamplesSize()
  - getSystemMonitorUploadSamplesSize
```
public int getSystemMonitorUploadSamplesSize()
```
    Returns the system monitor number of samples to store for each channel before uploading to Device Cloud.
    
    Returns:
    
    The system monitor number of samples to store in the buffer for each channel before uploading to Device Cloud.
    
    See Also:
    
    setSystemMonitorUploadSamplesSize(int)
  - setSystemMonitorSamplesBufferSize
```
public void setSystemMonitorSamplesBufferSize(int size)
```
    Sets the system monitor samples buffer size.
    
    Parameters:
    
    size - The system monitor samples buffer size.
    
    Throws:
    
    java.lang.IllegalArgumentException - if size < 1 or if size >
    
    See Also:
    
    MAXIMUM_SAMPLES_BUFFER_SIZE
  - getSystemMonitorSamplesBufferSize
```
public int getSystemMonitorSamplesBufferSize()
```
    Returns the system monitor samples buffer size.
    
    Returns:
    
    The system monitor samples buffer size.
  - enableSystemMonitorMemorySampling
```
public void enableSystemMonitorMemorySampling(boolean enable)
```
    Sets the new value of the enable system monitor memory sampling.
    
    Parameters:
    
    enable - true to enable the system monitor memory sampling, false to disable it.
    
    See Also:
    
    isSystemMonitorMemorySamplingEnabled()
  - isSystemMonitorMemorySamplingEnabled
```
public boolean isSystemMonitorMemorySamplingEnabled()
```
    Returns whether the system monitor memory sampling is enabled.
    
    Returns:
    
    true if the system monitor memory sampling is enabled, false otherwise.
    
    See Also:
    
    enableSystemMonitorMemorySampling(boolean)
  - enableSystemMonitorCPULoadSampling
```
public void enableSystemMonitorCPULoadSampling(boolean enable)
```
    Sets the new value of the enable system monitor CPU load sampling.
    
    Parameters:
    
    enable - true to enable the system monitor CPU load sampling, false to disable it.
    
    See Also:
    
    isSystemMonitorCPULoadSamplingEnabled()
  - isSystemMonitorCPULoadSamplingEnabled
```
public boolean isSystemMonitorCPULoadSamplingEnabled()
```
    Returns whether the system monitor CPU load sampling is enabled.
    
    Returns:
    
    true if the system monitor CPU load sampling is enabled, false otherwise.
    
    See Also:
    
    enableSystemMonitorCPULoadSampling(boolean)
  - enableSystemMonitorCPUTemperatureSampling
```
public void enableSystemMonitorCPUTemperatureSampling(boolean enable)
```
    Sets the new value of the enable system monitor CPU temperature sampling.
    
    Parameters:
    
    enable - true to enable the system monitor CPU temperature sampling, false to disable it.
    
    See Also:
    
    isSystemMonitorCPUTemperatureSamplingEnabled()
  - isSystemMonitorCPUTemperatureSamplingEnabled
```
public boolean isSystemMonitorCPUTemperatureSamplingEnabled()
```
    Returns whether the system monitor CPU temperature sampling is enabled.
    
    Returns:
    
    true if the system monitor CPU temperature sampling is enabled, false otherwise.
    
    See Also:
    
    enableSystemMonitorCPUTemperatureSampling(boolean)
  - setAppUpdateDirectory
```
public void setAppUpdateDirectory(java.lang.String appsDir)
```
    Sets the directory used to hold applications and updates.
    
    Parameters:
    
    appsDir - The directory Cloud Connector will use to look for applications and updates.
    
    Throws:
    
    java.lang.NullPointerException - If appsDir is null.
    
    See Also:
    
    getAppUpdateDirectory()
  - getAppUpdateDirectory
```
public java.lang.String getAppUpdateDirectory()
```
    Returns the directory used to hold applications and updates.
    
    Returns:
    
    The directory used to hold applications and updates.
    
    See Also:
    
    setAppUpdateDirectory(String)

Class CloudConnectorPreferencesManager

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RECONNECT_TIME_MINIMUM_VALUE

RECONNECT_TIME_MAXIMUM_VALUE

DEVICE_NAME_MAXIMUM_LENGTH

DESCRIPTION_MAXIMUM_LENGTH

CONTACT_MAXIMUM_LENGTH

MAXIMUM_UPLOAD_SAMPLES_SIZE

MINIMUM_SAMPLE_RATE

MAXIMUM_SAMPLES_BUFFER_SIZE

DEFAULT_ENABLE_AUTO_CONNECT

DEFAULT_ENABLE_RECONNECT

DEFAULT_RECONNECT_TIME

DEFAULT_ENABLE_SECURE_CONNECTION

DEFAULT_ENABLE_COMPRESSION

Method Detail

isAutoConnectEnabled

setAutoConnectEnabled

isReconnectEnabled

setReconnectEnabled

getReconnectTime

setReconnectTime

isSecureConnectionEnabled

setSecureConnectionEnabled

isCompressionEnabled

setCompressionEnabled

getVendorID

setVendorID

getURL

setURL

getDeviceID

getDeviceName

setDeviceName

getDeviceDescription

setDeviceDescription

getDeviceContactInformation

setDeviceContactInformation

enableSystemMonitor

isSystemMonitorEnabled

setSystemMonitorSampleRate

getSystemMonitorSampleRate

setSystemMonitorUploadSamplesSize

getSystemMonitorUploadSamplesSize

setSystemMonitorSamplesBufferSize

getSystemMonitorSamplesBufferSize

enableSystemMonitorMemorySampling

isSystemMonitorMemorySamplingEnabled

enableSystemMonitorCPULoadSampling

isSystemMonitorCPULoadSamplingEnabled

enableSystemMonitorCPUTemperatureSampling

isSystemMonitorCPUTemperatureSamplingEnabled

setAppUpdateDirectory

getAppUpdateDirectory