Network (cococlientsdk-java 0.28.2 API)

java.lang.Object
- buzz.getcoco.iot.Network

All Implemented Interfaces:

java.lang.Iterable<Device>
```
public class Network
extends java.lang.Object
implements java.lang.Iterable<Device>
```
A Network is virtual entity that is usually associated with physical entity such as home, office. Network class acts as a blueprint for single instance of a network.
User can own multiple networks and a user can be part of networks that are owned by others on basis of invitation Network.ConnectArgs from the owner of the network. Networks can contain Device, Zone, Scene, Rule. All the network that user currently part of can be queried using CocoClient.getAllNetworks(CocoClient.NetworkListListener)
```
 
 List<Network> userNetworks = CocoClient
   .getInstance()
   .getAllNetworks((networkList, throwable) &#45;&gt; {
     if (null == list)
       return;
     // client specific code
   });
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Network.AccessType` AccessType enum denoting what app is allowed to access.
`static class`	`Network.AddResourcesToZone` Deprecated.
`static class`	`Network.AddSceneResourceAction` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for adding new scene resource actions.
`static class`	`Network.AssignToTemplate` Template is a predefined blueprint of zone, device and resource combo which makes a smoother experience for owner and technician in managing resources.
`static class`	`Network.CommandId` An enum denoting possible values for command ids.
`static class`	`Network.ConnectArgs` This class defines setting necessary args before connecting to a network.
`static interface`	`Network.LeaveStatusListener` Listener used to listen updates of `leave(LeaveStatusListener)`.
`static class`	`Network.MoveResourcesBetweenZones` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for moving resources between two zones.
`static interface`	`Network.NetworkManagementStatusListener` Listener used to listen updates of `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)`.
`static class`	`Network.NetworkType` NetworkType enum denoting classifies a network object.
`static class`	`Network.RemoveResourcesFromZone` Deprecated.
`static class`	`Network.RemoveRule` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` to delete rules of the network.
`static class`	`Network.RemoveScene` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for deleting scenes in the network.
`static class`	`Network.RemoveSceneResourceActions` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for removing scene resource action.
`static class`	`Network.RemoveZone` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` to remove zones.
`static class`	`Network.ResourceTemplate` This class encapsulates basic information about resource templates such as zoneId to which it belongs to, icon, name etc.
`static class`	`Network.SaveRule` This class can be sent as a command to save rule after modifying it.
`static class`	`Network.SaveSceneResourceActions` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for saving scene resource actions.
`static class`	`Network.SceneResourceActions` This class acts as super class for the commands around adding/saving scene resource actions.
`static class`	`Network.SetRule` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for creating/changing existing rule info.
`static class`	`Network.SetScene` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for creating a new scene/changing info of an existing scene.
`static class`	`Network.SetSceneMetadata` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for setting metadata of a scene.
`static class`	`Network.SetZone` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for creating new zone/changing name of existing zone.
`static class`	`Network.State` state enum denoting if a network is connected/connecting etc.,
`static class`	`Network.UpdateSceneResourceActions` This class can be sent as an argument to `sendNetworkManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Network.CommandId>, buzz.getcoco.iot.Network.NetworkManagementStatusListener)` for updating scene resource actions.
`static class`	`Network.UserRole` UserRole enum denoting the role of the user in a given network.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Network(java.lang.String id)
The constructor of the class.

Constructors
Modifier	Constructor and Description
`protected`	`Network(java.lang.String id)` The constructor of the class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect()` To connect to an individual network.
`void`	`connect(int port)` To connect to an individual network.This function must be used to connect to single network.
`static boolean`	`containsClearFlag(Network.State state)` A function to check if the state contains a clear flag for network i.e, if state is either of `Network.State.NETWORK_RESET`, `Network.State.CONNECTION_ERROR`, `Network.State.DISCONNECTED`.
`boolean`	`containsDevice(long deviceNodeId)` A function to check if network the `Device` given the ID.
`boolean`	`containsRule(int ruleId)` A function to check if networks contains `Rule`.
`boolean`	`containsScene(int sceneId)` A function to check if scene with given ID is present in the network.
`boolean`	`containsZone(int zoneId)` A function to check if a given `Zone` is present in the network.
`static int`	`createClearOnDisconnectionFlag(Network.State... states)` A function to create flags to clear network from memory in case of disconnection.
`void`	`createRule(java.lang.String ruleName, Network.NetworkManagementStatusListener listener)` A function to create rule in the network.
`void`	`createScene(java.lang.String sceneName, Network.NetworkManagementStatusListener listener)` A function to create scene in a network.
`void`	`createZone(java.lang.String zoneName, Network.NetworkManagementStatusListener listener)` A function to create a zone in the network.
`void`	`deleteRule(Rule[] rules, Network.NetworkManagementStatusListener listener)` A function to delete multiple rules in a network.
`void`	`deleteRule(Rule rule, Network.NetworkManagementStatusListener listener)` A function to delete rule in a network.
`void`	`deleteScene(Scene[] scenes, Network.NetworkManagementStatusListener listener)` A function to delete multiple scenes in a network.
`void`	`deleteScene(Scene scene, Network.NetworkManagementStatusListener listener)` A function to delete a scene from the network.
`void`	`deleteZone(Zone[] zones, Network.NetworkManagementStatusListener listener)` A function to delete multiple zones from the network.
`void`	`deleteZone(Zone zone, Network.NetworkManagementStatusListener listener)` A function to delete a zone from the network.
`void`	`disconnect()` This function is used to disconnect from a network and delete from local database accordingly.
`Network.AccessType`	`getAccessType()` This function is used to return the access type of the user.
`ConnectivityStateManager.State`	`getConnectivityManagerState()` This function is used to get the connectivity state of the network.
`<T extends Device> T`	`getDevice(long deviceNodeId)` This function is used to get device in the network given the deviceId.
`java.lang.Iterable<Device>`	`getDeviceIterable()` This function fetches device iterable to traverse over list of devices.
`java.util.Map<java.lang.Long,Device>`	`getDeviceMap()` This function is used to return the HashMap that the sdk uses to map the DeviceIds to the Device Objects.
`java.lang.String`	`getId()` This function is used to get the ID that uniquely identifies this Network.
`java.lang.String`	`getMetadata()` A function to get metadata of the network.
`java.lang.String`	`getName()` This function is used to get the Name of the network.
`Network.NetworkType`	`getNetworkType()` This function is used to get the type of the network.
`java.util.List<Network.ResourceTemplate>`	`getResourceTemplates()` This function is used to get the list of resource templates that belongs to the network.
`<T extends Rule> T`	`getRule(int ruleId)` This function is used to get the rule of this network give the ruleId.
`java.lang.Iterable<Rule>`	`getRuleIterable()` This function fetches device iterable to traverse over list of rules.
`java.util.Map<java.lang.Integer,Rule>`	`getRuleMap()` This function is used to return the HashMap that the sdk uses to map the ruleIds to the Rule Objects.
`<T extends Scene> T`	`getScene(int sceneId)` This function is used to get the scene of this network given the scene.
`java.lang.Iterable<Scene>`	`getSceneIterable()` This function fetches device iterable to traverse over list of scenes.
`java.util.Map<java.lang.Integer,Scene>`	`getSceneMap()` This function is used to return the HashMap that the sdk uses to map the sceneIds to the Scene Objects.
`Network.State`	`getState()` This function is used to get the current state of the Network.
`Network.UserRole`	`getUserRole()` This function is used to get role of the current user in this network.
`<T extends Zone> T`	`getZone(int zoneId)` This function is used to get the zone of this network given the zoneId.
`java.lang.Iterable<Zone>`	`getZoneIterable()` This function fetches device iterable to traverse over list of zones.
`java.util.Map<java.lang.Integer,Zone>`	`getZoneMap()` This function is used to return the HashMap that the sdk uses to map the zoneIds to the Zone Objects.
`int`	`hashCode()`
`protected void`	`internalAddDevice(Device device)` A function that will get called when a device is added to network.
`protected void`	`internalAddRule(Rule rule)` A function that would be triggered when a `Rule` is added to network.
`protected void`	`internalAddScene(Scene scene)` A function that would be triggered when a `Scene` is added to network.
`protected void`	`internalAddZone(Zone zone)` A function that would be triggered when a `Zone` is added to network.
`protected void`	`internalRemoveDevice(long deviceNodeId)` A function that would be triggered when a device is removed from network.
`protected void`	`internalRemoveNetwork()` A function that will get called when network is removed.
`protected void`	`internalRemoveRule(int ruleId)` A function that would be triggered when `Rule` is removed from network.
`protected void`	`internalRemoveScene(int sceneId)` A function that would be triggered when a `Scene` is removed from network.
`protected void`	`internalRemoveZone(int zoneId)` A function that would be triggered when a zone is removed.
`protected void`	`internalSetAccessType(Network.AccessType accessType)` A function that would be triggered when `accessType` is updated.
`protected void`	`internalSetConnectivityState(ConnectivityStateManager.State state)` A function that would be triggered when `connectivityManagerState` is updated.
`protected void`	`internalSetMetadata(java.lang.String metadata)` A function that would be triggered when `metadata` is updated.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `name` of the network is updated.
`protected void`	`internalSetNetworkType(Network.NetworkType type)` A function that would be triggered when `networkType` is updated.
`protected void`	`internalSetResourceTemplates(java.util.List<Network.ResourceTemplate> resourceTemplates)` A function that will get called when `Network.ResourceTemplate`'s is updated.
`protected void`	`internalSetState(Network.State state)` A function that would be triggered when `state` is updated.
`protected void`	`internalSetUserRole(Network.UserRole userRole)` A function that would be triggered when `Network.UserRole` is updated.
`java.util.Iterator<Device>`	`iterator()`
`void`	`leave(Network.LeaveStatusListener listener)` This function is used to leave the network.
`void`	`moveResources(Zone fromZone, Zone toZone, Resource[] resources, Network.NetworkManagementStatusListener listener)` A function to move resources of a zone to another zone.
`void`	`restoreNetworkState(java.lang.String networkState)` A function to restore network information from the provided jsonString.
`java.lang.String`	`saveState()` A function to serialize the instance of this class.
`void`	`sendContentInfo(long contentTime, java.lang.String data, long[] nodeIds)` An api to send data to the specified nodes or all nodes of network with an additional param of time to achieve content synchronization.
`void`	`sendData(java.lang.String data, long[] nodeIds)` An api to send data to the specified nodes or all nodes of network.
`void`	`sendNetworkManagementCommand(Command<Network.CommandId> command, Network.NetworkManagementStatusListener listener)` A function to send networkManagementCommands such as `createScene(String, NetworkManagementStatusListener)`, `createZone(String, NetworkManagementStatusListener)` ...
`java.lang.String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Network
```
protected Network(java.lang.String id)
```
    The constructor of the class. Constructor is protected to make sure that networks can be only created by the cococlientsdk-java.
    
    Parameters:
    
    id - ID of the current network.
- Method Detail
  - createClearOnDisconnectionFlag
```
public static int createClearOnDisconnectionFlag(Network.State... states)
```
    A function to create flags to clear network from memory in case of disconnection.
    
    Parameters:
    
    states - array of states
    
    Returns:
    
    an integer flag
  - containsClearFlag
```
public static boolean containsClearFlag(Network.State state)
```
    A function to check if the state contains a clear flag for network i.e, if state is either of Network.State.NETWORK_RESET, Network.State.CONNECTION_ERROR, Network.State.DISCONNECTED.
    
    Parameters:
    
    state - State under interest to check for clear
    
    Returns:
    
    True if state of network contains clear flag
  - connect
```
public void connect()
```
    To connect to an individual network. This function must be used to connect to single network.
    
    Throws:
    
    java.lang.RuntimeException - Throws an exception on failure during communication.
  - connect
```
public void connect(int port)
```
    To connect to an individual network.This function must be used to connect to single network.
    
    Parameters:
    
    port - This function takes a port over which the communication will take place NOTE: The port should be a free port or this call will fail If 0 is passed there will be a search and free port will be chosen automatically.
    
    Throws:
    
    java.lang.RuntimeException - Throws an exception on failure during communication.
  - disconnect
```
public void disconnect()
```
    This function is used to disconnect from a network and delete from local database accordingly. Once disconnected no more updates will be published unless networks is connected back again with connect()
    
    Throws:
    
    java.lang.RuntimeException - Throw an exception on failures during communication.
  - leave
```
public void leave(Network.LeaveStatusListener listener)
```
    This function is used to leave the network. Owner of the network can not leave the network. User who were invited to the network can leave the network. Once user has left the network he/she can no more access resources(devices, resource, rules, zone...) of network and can only join back to the network on the invitation of the owner.
```
   
     networkTobeLeft
      .leave(commandStatus, throwable &#45;&gt; {
        if (null != throwable) {
         // client specific code
       }
     });
   
 
```
    Parameters:
    
    listener - The listener that would be triggered with result.
  - sendNetworkManagementCommand
```
public void sendNetworkManagementCommand(Command<Network.CommandId> command,
                                         Network.NetworkManagementStatusListener listener)
```
    A function to send networkManagementCommands such as createScene(String, NetworkManagementStatusListener), createZone(String, NetworkManagementStatusListener) ...
```
 
   network
   .sendNetworkManagementCommand(new createZone("livingRoom"),
   (response, throwable) &#45;&gt; {
      if (null != throwable) {
        // client specific code.
      }
   });
   
   
```
    Parameters:
    
    command - The command which has to be sent
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - createZone
```
public void createZone(java.lang.String zoneName,
                       Network.NetworkManagementStatusListener listener)
```
    A function to create a zone in the network.
```
    
      network
      .createZone(newZoneName,
      (commandStatus, throwable) &#45;&gt; {
        if (null != throwable) {
          // client specific code.
        }
      });
    
  
```
    Parameters:
    
    zoneName - The name of the zone.
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteZone
```
public void deleteZone(Zone zone,
                       Network.NetworkManagementStatusListener listener)
```
    A function to delete a zone from the network.
```
   
     network.
     deleteZone(zoneTobeDeleted,
     (status, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
 
```
    Parameters:
    
    zone - The zone which has to deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteZone
```
public void deleteZone(Zone[] zones,
                       Network.NetworkManagementStatusListener listener)
```
    A function to delete multiple zones from the network.
```
   
     Zone[] zonesToBeDeleted = new Zone[] {livingZone, parkingArea};
     network
     .deleteZone(zoneToBeDeleted,
     (command, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
```
    Parameters:
    
    zones - The zones which are to deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - moveResources
```
public void moveResources(Zone fromZone,
                          Zone toZone,
                          Resource[] resources,
                          Network.NetworkManagementStatusListener listener)
```
    A function to move resources of a zone to another zone.
```
   
     Resources[] resourcesTobeMoved = newResources[] {
     fan, light, airConditioner
     };

     network
     .moveResources(defaultZone, livingArea, resourcesTobeMoved,
     (command, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });

   
 
```
    Parameters:
    
    fromZone - The zone from which the resources have to be moved
    
    toZone - The zone to which the resource has to be moved
    
    resources - The resources the needs to be moved.
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - createScene
```
public void createScene(java.lang.String sceneName,
                        Network.NetworkManagementStatusListener listener)
```
    A function to create scene in a network.
```
   
     network
     .createScene(newSceneName, (commandStatus, throwable) &#45;&gt; {
       if (null != throwable) {
         // code specific code.
       }
     });
   
 
```
    Parameters:
    
    sceneName - The name of the scene
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteScene
```
public void deleteScene(Scene scene,
                        Network.NetworkManagementStatusListener listener)
```
    A function to delete a scene from the network.
```
   
     network
     .deleteScene(sceneTobeDeleted, (command, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
```
    Parameters:
    
    scene - Scene which has to be deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteScene
```
public void deleteScene(Scene[] scenes,
                        Network.NetworkManagementStatusListener listener)
```
    A function to delete multiple scenes in a network.
    
    Parameters:
    
    scenes - The scenes to be deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - createRule
```
public void createRule(java.lang.String ruleName,
                       Network.NetworkManagementStatusListener listener)
```
    A function to create rule in the network.
```
   
     network
     .createRule(nameOfNewRule, (commandStatus, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
 
```
    Parameters:
    
    ruleName - The name of the rule
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteRule
```
public void deleteRule(Rule rule,
                       Network.NetworkManagementStatusListener listener)
```
    A function to delete rule in a network.
```
   
     network
     .delete(ruleTobeDeleted, (commandStatus, throwable) &#45;&gt; {
       if (null != throwable) {
        // client specific code.
       }
     });
   
 
```
    Parameters:
    
    rule - Rule which has to be deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - deleteRule
```
public void deleteRule(Rule[] rules,
                       Network.NetworkManagementStatusListener listener)
```
    A function to delete multiple rules in a network.
    
    Parameters:
    
    rules - The rules to be deleted
    
    listener - The listener which will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - getId
```
public final java.lang.String getId()
```
    This function is used to get the ID that uniquely identifies this Network.
    
    Returns:
    
    String: ID of the Network
  - getName
```
public java.lang.String getName()
```
    This function is used to get the Name of the network.
    
    Returns:
    
    String: Name of the Network
  - getState
```
public Network.State getState()
```
    This function is used to get the current state of the Network.
    
    Returns:
    
    State: The enum indicating the state of the network
  - getConnectivityManagerState
```
public ConnectivityStateManager.State getConnectivityManagerState()
```
    This function is used to get the connectivity state of the network. NOTE: This will only work after ConnectivityStateManager.getInstance().
    
    Returns:
    
    ConnectivityStateManager.State: the enum indicating the state of the network
  - getUserRole
```
public Network.UserRole getUserRole()
```
    This function is used to get role of the current user in this network.
    
    Returns:
    
    UserRole: The enum indicating the role of the user
  - getAccessType
```
public Network.AccessType getAccessType()
```
    This function is used to return the access type of the user.
    
    Returns:
    
    AccessType: The enum indicating the AccessType of the user (sometimes a root user may want to drop his privileges and also sometimes a guest may have higher privileges given by the admin)
  - getNetworkType
```
public Network.NetworkType getNetworkType()
```
    This function is used to get the type of the network.
    
    Returns:
    
    NetworkType: The enum indicating the type of the network
  - getDeviceMap
```
public java.util.Map<java.lang.Long,Device> getDeviceMap()
```
    This function is used to return the HashMap that the sdk uses to map the DeviceIds to the Device Objects. This function can also be used to data-bind the sdk to the application.
    
    Returns:
    
    The key being the deviceNodeId and the value being the Device Object. NOTE: This HashMap is for read-only any misuse may cause the program to misbehave and even crash.
  - getZoneMap
```
public java.util.Map<java.lang.Integer,Zone> getZoneMap()
```
    This function is used to return the HashMap that the sdk uses to map the zoneIds to the Zone Objects.
    
    Returns:
    
    The key being the zoneId and the value being the Zone Object. NOTE: This HashMap is for read-only any misuse may cause the program to misbehave and even crash.
  - getSceneMap
```
public java.util.Map<java.lang.Integer,Scene> getSceneMap()
```
    This function is used to return the HashMap that the sdk uses to map the sceneIds to the Scene Objects.
    
    Returns:
    
    The key being the sceneId and the value being the Scene Object. NOTE: This hashmap is for read-only any misuse may cause the program to misbehave and even crash.
  - getRuleMap
```
public java.util.Map<java.lang.Integer,Rule> getRuleMap()
```
    This function is used to return the HashMap that the sdk uses to map the ruleIds to the Rule Objects.
    
    Returns:
    
    The key being the ruleId and the value being the Rule Object. NOTE: This HashMap is for read-only any misuse may cause the program to misbehave and even crash.
  - getResourceTemplates
```
public java.util.List<Network.ResourceTemplate> getResourceTemplates()
```
    This function is used to get the list of resource templates that belongs to the network. If the network doesn't have any templates associated with it then empty list would be returned.
```
   
     List<ResourceTemplates> resourceTemplates = network
      .getResourceTemplates();

     if (!resourceTemplates.isEmpty()) {
        // client specific code.
     }

   
 
```
    Returns:
    
    ResourceTemplate list
  - getDevice
```
public final <T extends Device> T getDevice(long deviceNodeId)
```
    This function is used to get device in the network given the deviceId.
```
 
   Device device = network
   .getDevice(deviceId);

   if (null != device) {
     // success case.
   }
 
 
```
    Type Parameters:
    
    T - capture for casting.
    
    Parameters:
    
    deviceNodeId - ID of the Device that needs to be looked up.
    
    Returns:
    
    Zone with the given zoneId
  - getZone
```
public final <T extends Zone> T getZone(int zoneId)
```
    This function is used to get the zone of this network given the zoneId.
```
   
     Zone livingRoom = network
         .getZone(livingRoomId);

     if (null != livingRoom) {
       // success case.
     }
   
 
```
    Type Parameters:
    
    T - capture for casting
    
    Parameters:
    
    zoneId - ID of zone that needs to be looked up.
    
    Returns:
    
    Zone with the given zoneId
  - getScene
```
public final <T extends Scene> T getScene(int sceneId)
```
    This function is used to get the scene of this network given the scene.
```
 Scene party = network
   .getScene(parentSceneId);

 if (null != party) {
   // success case.
 }
 
 
```
    Type Parameters:
    
    T - capture for casting.
    
    Parameters:
    
    sceneId - ID of the Scene that needs to be looked up.
    
    Returns:
    
    Scene with the given zoneId
  - getRule
```
public final <T extends Rule> T getRule(int ruleId)
```
    This function is used to get the rule of this network give the ruleId. Rule temperatureControl = network .getRule(temperatureControlRuleId) if (null != temperatureControl) { // success case. }
    
    Type Parameters:
    
    T - Class to which Rule object has to be casted.
    
    Parameters:
    
    ruleId - ID of the Rule that needs to be looked up.
    
    Returns:
    
    Rule with the given ruleId
  - saveState
```
public java.lang.String saveState()
```
    A function to serialize the instance of this class.
```
 
   String networkJsonString = network.saveState();
 
 
```
    Returns:
    
    The serializedJson which represents the complete memory state.
    
    See Also:
    
    CocoClient.restoreNetworkState(String)
  - restoreNetworkState
```
public void restoreNetworkState(java.lang.String networkState)
```
    A function to restore network information from the provided jsonString.
    
    Parameters:
    
    networkState - JSON string which was serialized to memory during saveState()
    
    See Also:
    
    CocoClient.restoreNetworkState(String)
  - internalRemoveNetwork
```
protected void internalRemoveNetwork()
```
    A function that will get called when network is removed.
  - internalSetResourceTemplates
```
protected void internalSetResourceTemplates(java.util.List<Network.ResourceTemplate> resourceTemplates)
```
    A function that will get called when Network.ResourceTemplate's is updated.
    
    Parameters:
    
    resourceTemplates - Updated resource template's.
  - internalAddDevice
```
protected void internalAddDevice(Device device)
```
    A function that will get called when a device is added to network.
    
    Parameters:
    
    device - Device which is added.
  - internalRemoveDevice
```
protected void internalRemoveDevice(long deviceNodeId)
```
    A function that would be triggered when a device is removed from network.
    
    Parameters:
    
    deviceNodeId - ID of device that is removed.
  - containsDevice
```
public boolean containsDevice(long deviceNodeId)
```
    A function to check if network the Device given the ID.
    
    Parameters:
    
    deviceNodeId - ID of device that's needs to be looked up.
    
    Returns:
    
    A flag representing if device is present.
  - internalAddZone
```
protected void internalAddZone(Zone zone)
```
    A function that would be triggered when a Zone is added to network.
    
    Parameters:
    
    zone - Zone which is added.
  - internalRemoveZone
```
protected void internalRemoveZone(int zoneId)
```
    A function that would be triggered when a zone is removed.
    
    Parameters:
    
    zoneId - ID of zone which is removed.
  - containsZone
```
public boolean containsZone(int zoneId)
```
    A function to check if a given Zone is present in the network.
    
    Parameters:
    
    zoneId - ID of the zone that's needs to looked up.
    
    Returns:
    
    boolean - flag representing whether network contains the zone with given ID.
  - internalAddScene
```
protected void internalAddScene(Scene scene)
```
    A function that would be triggered when a Scene is added to network.
    
    Parameters:
    
    scene - Scene which is added to network.
  - internalRemoveScene
```
protected void internalRemoveScene(int sceneId)
```
    A function that would be triggered when a Scene is removed from network.
    
    Parameters:
    
    sceneId - SceneId which is removed from network.
  - containsScene
```
public boolean containsScene(int sceneId)
```
    A function to check if scene with given ID is present in the network.
    
    Parameters:
    
    sceneId - ID of scene that needs to be looked up.
    
    Returns:
    
    boolean - flag representing whether network contains scene with give ID.
  - internalAddRule
```
protected void internalAddRule(Rule rule)
```
    A function that would be triggered when a Rule is added to network.
    
    Parameters:
    
    rule - Rule which is added to network.
  - internalRemoveRule
```
protected void internalRemoveRule(int ruleId)
```
    A function that would be triggered when Rule is removed from network.
    
    Parameters:
    
    ruleId - ID of rule which is removed.
  - containsRule
```
public boolean containsRule(int ruleId)
```
    A function to check if networks contains Rule.
    
    Parameters:
    
    ruleId - ID which needs to be looked up.
    
    Returns:
    
    A flag that represents
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when name of the network is updated.
    
    Parameters:
    
    name - Updated name of the network.
  - internalSetUserRole
```
protected void internalSetUserRole(Network.UserRole userRole)
```
    A function that would be triggered when Network.UserRole is updated.
    
    Parameters:
    
    userRole - Updated user role of the network.
  - internalSetAccessType
```
protected void internalSetAccessType(Network.AccessType accessType)
```
    A function that would be triggered when accessType is updated.
    
    Parameters:
    
    accessType - Updated access type of the network.
  - internalSetState
```
protected void internalSetState(Network.State state)
```
    A function that would be triggered when state is updated.
    
    Parameters:
    
    state - Updated state of the network.
  - internalSetConnectivityState
```
protected void internalSetConnectivityState(ConnectivityStateManager.State state)
```
    A function that would be triggered when connectivityManagerState is updated.
    
    Parameters:
    
    state - Updated state.
  - internalSetNetworkType
```
protected void internalSetNetworkType(Network.NetworkType type)
```
    A function that would be triggered when networkType is updated.
    
    Parameters:
    
    type - Updated network type of the network.
  - internalSetMetadata
```
protected void internalSetMetadata(java.lang.String metadata)
```
    A function that would be triggered when metadata is updated.
    
    Parameters:
    
    metadata - Updated metadata of the network.
  - getMetadata
```
public java.lang.String getMetadata()
```
    A function to get metadata of the network.
    
    Returns:
    
    metadata of the network.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - iterator
```
public java.util.Iterator<Device> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Device>
  - getDeviceIterable
```
public java.lang.Iterable<Device> getDeviceIterable()
```
    This function fetches device iterable to traverse over list of devices.
    
    Returns:
    
    A device iterable
  - getZoneIterable
```
public java.lang.Iterable<Zone> getZoneIterable()
```
    This function fetches device iterable to traverse over list of zones.
    
    Returns:
    
    A zone iterable
  - getSceneIterable
```
public java.lang.Iterable<Scene> getSceneIterable()
```
    This function fetches device iterable to traverse over list of scenes.
    
    Returns:
    
    A scene iterable
  - getRuleIterable
```
public java.lang.Iterable<Rule> getRuleIterable()
```
    This function fetches device iterable to traverse over list of rules.
    
    Returns:
    
    A rule iterable
  - sendData
```
public void sendData(java.lang.String data,
                     long[] nodeIds)
```
    An api to send data to the specified nodes or all nodes of network.
    
    Parameters:
    
    data - The data that has to be sent
    
    nodeIds - The nodes which will get the data. null to send to all nodes.
  - sendContentInfo
```
public void sendContentInfo(long contentTime,
                            java.lang.String data,
                            long[] nodeIds)
```
    An api to send data to the specified nodes or all nodes of network with an additional param of time to achieve content synchronization.
    
    Parameters:
    
    contentTime - The time at which the data is sent
    
    data - The data that has to be sent
    
    nodeIds - The nodes which will get the data. null to send to all nodes.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Network

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Network

Method Detail

createClearOnDisconnectionFlag

containsClearFlag

connect

connect

disconnect

leave

sendNetworkManagementCommand

createZone

deleteZone

deleteZone

moveResources

createScene

deleteScene

deleteScene

createRule

deleteRule

deleteRule

getId

getName

getState

getConnectivityManagerState

getUserRole

getAccessType

getNetworkType

getDeviceMap

getZoneMap

getSceneMap

getRuleMap

getResourceTemplates

getDevice

getZone

getScene

getRule

saveState

restoreNetworkState

internalRemoveNetwork

internalSetResourceTemplates

internalAddDevice

internalRemoveDevice

containsDevice

internalAddZone

internalRemoveZone

containsZone

internalAddScene

internalRemoveScene

containsScene

internalAddRule

internalRemoveRule

containsRule

internalSetName

internalSetUserRole

internalSetAccessType

internalSetState

internalSetConnectivityState

internalSetNetworkType

internalSetMetadata

getMetadata

hashCode

iterator

getDeviceIterable

getZoneIterable

getSceneIterable

getRuleIterable

sendData

sendContentInfo

toString