AylaNetworks

java.lang.Object
- com.aylanetworks.aylasdk.AylaNetworks

```
public class AylaNetworks
extends java.lang.Object
```
The AylaNetworks is the main object used to configure the Ayla SDK. Applications need to initialize the CoreManager before any other SDK functionality is used. The CoreManager is initilalized via a call to initialize(AylaSystemSettings), where the application needs to provide the SDK with information about the system. This information includes the app ID, app secret and an object that can assist the SDK by providing specifics about devices and properties known to the application.
Once the SDK has been initialized, the CoreManager can be accessed globally via a call to the sharedInstance() static method.
After initialization, the CoreManager provides an AylaLoginManager, which can be used to sign in and obtain an AylaSessionManager. The AylaSessionManager maintains the session, updating the authorization as needed, and provides the AylaDeviceManager, which takes care of maintaining the set of devices registered to the user's account.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PLUGIN_ID_DEVICE_CLASS
Device Class plugin identifier.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PLUGIN_ID_DEVICE_CLASS` Device Class plugin identifier.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`closeSessions()`
`AylaConnectivity`	`getConnectivity()` Returns the AylaConnectivity instance that can be used to register for network state change notifications.
`android.content.Context`	`getContext()` Helper method to retrieve the context from the system settings
`com.google.gson.Gson`	`getGson()` Returns the Gson object used for object deserialization from JSON data.
`AylaLoginManager`	`getLoginManager()`
`AylaMetricsManager`	`getMetricsManager()` Returns the AylaMetricsManager instance used to upload logs to Ayla Log Service.
`AylaPlugin`	`getPlugin(java.lang.String pluginId)` Returns an installed plug-in, if present
`java.lang.String`	`getServiceUrl(ServiceUrls.CloudService cloudService, java.lang.String path)` Returns the service URL of the specified cloud service type, optionally appending the specified path.
`AylaSessionManager`	`getSessionManager(java.lang.String sessionName)` Returns the `AylaSessionManager` with the given name, or null if the session with that name was not found.
`static java.lang.String`	`getSupportEmail()` Returns the SDK support email address.
`AylaSystemSettings`	`getSystemSettings()` Returns a copy of the `AylaSystemSettings` object used to initialize the AylaNetworks.
`AylaUserDataGrant`	`getUserDataGrants()`
`com.android.volley.RequestQueue`	`getUserServiceRequestQueue()`
`static java.lang.String`	`getVersion()` Returns the current version of the SDK
`static AylaNetworks`	`initialize(AylaSystemSettings systemSettings)` Initializes the Ayla library with the provided AylaSystemSettings.
`void`	`installPlugin(java.lang.String pluginId, AylaPlugin plugin)` Installs a plug-in into the Ayla SDK.
`static boolean`	`isShutDown()`
`void`	`onPause()` Applications should call this method when the app is about to enter the background.
`void`	`onResume()` Applications should call this method when the app is resuming from the background
`AylaAPIRequest`	`sendUserServiceRequest(AylaAPIRequest<?> request)` Enqueues the provided request to the Ayla Cloud User Service.
`void`	`setUserDataGrants(int userDataGrants)` Set user's preferences for data usage.
`static AylaNetworks`	`sharedInstance()` Returns the global shared instance of the AylaNetworks.
`static void`	`shutDown()` Called when the application is about to exit.
`void`	`updateContext(android.content.Context context)` Updates the context used by the library.

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

- Field Detail
  - PLUGIN_ID_DEVICE_CLASS
```
public static final java.lang.String PLUGIN_ID_DEVICE_CLASS
```
    Device Class plugin identifier. Device class plugins implement the DeviceClassPlugin interface.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUserDataGrants
```
public AylaUserDataGrant getUserDataGrants()
```
  - setUserDataGrants
```
public void setUserDataGrants(int userDataGrants)
```
    Set user's preferences for data usage. To enable data uploads, use either one or combination of AYLA_USER_DATA_GRANT_METRICS_SERVICE and AYLA_USER_DATA_GRANT_UNCAUGHTEXCEPTION. To disable all data uploads set AYLA_USER_DATA_GRANT_NONE eg: To allow uploading of anonymous usage statistics and crash logs, use setUserDataGrants(AylaUserDataGrantMetricsService | AylaUserDataGrantUncaughtException)
    
    Parameters:
    
    userDataGrants -
  - initialize
```
public static AylaNetworks initialize(AylaSystemSettings systemSettings)
```
    Initializes the Ayla library with the provided AylaSystemSettings. This method must be called before any other Ayla library methods.
    
    Parameters:
    
    systemSettings - AylaSystemSettings object used to initialize the library.
    
    Returns:
    
    the newly created AylaNetworks object
  - shutDown
```
public static void shutDown()
```
    Called when the application is about to exit. This method removes the shared cored manager, removing any references to the application it might contain.
  - isShutDown
```
public static boolean isShutDown()
```
  - getVersion
```
public static java.lang.String getVersion()
```
    Returns the current version of the SDK
    
    Returns:
    
    the current version of the SDK, e.g. "5.0".
  - getSupportEmail
```
public static java.lang.String getSupportEmail()
```
    Returns the SDK support email address. Email this address with support issues related to the Ayla Mobile SDK
    
    Returns:
    
    the email address for SDK support
  - sharedInstance
```
public static AylaNetworks sharedInstance()
```
    Returns the global shared instance of the AylaNetworks. This will be null until initialize(AylaSystemSettings) is called.
    
    Returns:
    
    The shared AylaNetworks instance, or null if the instance has not been initialized
  - getSessionManager
```
public AylaSessionManager getSessionManager(java.lang.String sessionName)
```
    Returns the AylaSessionManager with the given name, or null if the session with that name was not found.
    
    Parameters:
    
    sessionName - Name of the session to return
    
    Returns:
    
    The AylaSessionManager created with the given sessionName, or null if no session manager with that name was found
  - getLoginManager
```
public AylaLoginManager getLoginManager()
```
  - getSystemSettings
```
public AylaSystemSettings getSystemSettings()
```
    Returns a copy of the AylaSystemSettings object used to initialize the AylaNetworks.
    
    Returns:
    
    A copy of the system settings object
  - getUserServiceRequestQueue
```
public com.android.volley.RequestQueue getUserServiceRequestQueue()
```
  - updateContext
```
public void updateContext(android.content.Context context)
```
    Updates the context used by the library. Call this method if the context used to initialize the library becomes stale, e.g. if the context is destroyed due to the Activity lifecycle, etc.
    
    Parameters:
    
    context - New context to be used by the library
  - getServiceUrl
```
public java.lang.String getServiceUrl(ServiceUrls.CloudService cloudService,
                                      @Nullable
                                      java.lang.String path)
```
    Returns the service URL of the specified cloud service type, optionally appending the specified path. The method takes into account the AylaSystemSettings.CloudProvider, AylaSystemSettings.ServiceType and AylaSystemSettings.ServiceLocation values from the AylaSystemSettings object used to initialize the core manager when determining the correct base URL.
    If the path field is null, the base URL for the specified cloud service will be returned. Otherwise the path will be appended to the base URL and returned.
    
    Parameters:
    
    cloudService - Dynamic | User | Application | Log
    
    path - Optional path to append to the cloud service URL. May be null.
    
    Returns:
    
    A valid URL string for the requested cloud service
  - closeSessions
```
protected void closeSessions()
```
  - onPause
```
public void onPause()
```
    Applications should call this method when the app is about to enter the background.
  - onResume
```
public void onResume()
```
    Applications should call this method when the app is resuming from the background
  - getConnectivity
```
public AylaConnectivity getConnectivity()
```
    Returns the AylaConnectivity instance that can be used to register for network state change notifications.
    
    Returns:
    
    the AylaConnectivity used for monitoring the network state
  - getMetricsManager
```
public AylaMetricsManager getMetricsManager()
```
    Returns the AylaMetricsManager instance used to upload logs to Ayla Log Service.
  - getGson
```
public com.google.gson.Gson getGson()
```
    Returns the Gson object used for object deserialization from JSON data. This method lazily creates the Gson object when requested the first time.
    
    Returns:
    
    the Gson object to use for deseriaialization of Ayla JSON objects
  - sendUserServiceRequest
```
public AylaAPIRequest sendUserServiceRequest(AylaAPIRequest<?> request)
```
    Enqueues the provided request to the Ayla Cloud User Service.
    
    Parameters:
    
    request - the request to send
    
    Returns:
    
    the request, which can be used for cancellation.
  - getContext
```
public android.content.Context getContext()
```
    Helper method to retrieve the context from the system settings
    
    Returns:
    
    the context member of the SystemSettings used to initialize this CoreManager object
  - getPlugin
```
public AylaPlugin getPlugin(java.lang.String pluginId)
```
    Returns an installed plug-in, if present
    
    Parameters:
    
    pluginId - the ID of the plugin service to obtain
    
    Returns:
    
    the AylaPlugin that was previously installed, or null if not found
  - installPlugin
```
public void installPlugin(java.lang.String pluginId,
                          AylaPlugin plugin)
```
    Installs a plug-in into the Ayla SDK. Plug-ins may be obtained by calling getPlugIn(). Installing a plug-in with the same ID as a previous plug-in will overwrite the previous plug-in.
    
    Parameters:
    
    pluginId - The ID for this plug-in identifying its utility
    
    plugin - the plugin to install

Class AylaNetworks

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PLUGIN_ID_DEVICE_CLASS

Method Detail

getUserDataGrants

setUserDataGrants

initialize

shutDown

isShutDown

getVersion

getSupportEmail

sharedInstance

getSessionManager

getLoginManager

getSystemSettings

getUserServiceRequestQueue

updateContext

getServiceUrl

closeSessions

onPause

onResume

getConnectivity

getMetricsManager

getGson

sendUserServiceRequest

getContext

getPlugin

installPlugin