CallbacksInterface (cococlientsdk-java 0.28.2 API)

All Known Subinterfaces:

DefaultCallbacksInterface

All Known Implementing Classes:

ConnectivityStateManager
```
public interface CallbacksInterface
```
Interface comprising signatures of callbacks used by CallbackMultiplexer to notify its subscribers.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`advertiseResourceCallback(Resource resource)` A function that needs to be implemented by the subscriber to listen to resource advertisement sent by `Device`.
`void`	`commandStatusCallback(CommandResponse<?> response)` A function that needs to implemented by the subscriber to response for sent `Command`'s.
`void`	`connectStatusCallback(Network network)` A function that needs to be implemented by subscribers to get info regrading connection status of the `Network`.
`void`	`contentInfoCallback(Network network, long sourceNodeId, long contentTime, java.lang.String data)` A callback for receiver nodes that triggers upon receiving the data sent using `Network.sendContentInfo(long, String, long[])`.
`void`	`deviceInfoCallback(Device device)` A function that needs to be implemented by subscriber to listen updates regarding `Device`.
`void`	`deviceManagementStatusCallback(Device device, CommandResponse<?> commandResponse, Resource[] resourcesImpacted)` A function that needs to be implemented by subscriber to listen to responses of `Device.sendDeviceManagementCommand(Command, Device.DeviceManagementStatusListener)`.
`void`	`errorCallback(java.lang.Throwable tr)` A callback indicating an internal error.
`void`	`infoRequestCallback(InfoRequest infoRequest)` A function that needs to be implemented by subscriber to listen to `InfoRequest` sent by `Device`.
`void`	`infoRequestStatusCallback(Command.State state, InfoRequest infoRequest)` A function that needs to be implemented by subscriber to listen to state of sent `InfoRequest`.
`void`	`infoResponseCallback(InfoRequest request, InfoResponse infoResponse)` A function that needs to be implemented by subscriber to listen to `InfoResponse` sent by `Device` in repose to `InfoRequest`.
`void`	`infoResponseStatusCallback(Command.State state, InfoResponse infoResponse)` A function that needs to be implemented by subscriber to listen to status of `InfoResponse`.
`void`	`leaveNetworkStatusCallback(Network network, Command.State status)` `Command.State.SUCCESS` and `Command.State.FAILURE` are only possible.
`void`	`messageCallback(java.lang.String title, java.lang.String message, MessageType messageType)` A function that needs to be implemented by subscriber to listen to messages that are passed back usually during resource addition.
`void`	`networkDataCallback(Network network)` A function that needs to be implemented by subscriber to listen to updates of network.
`void`	`networkListCallback(java.util.ArrayList<Network> networksList)` A function that needs to be implemented by subscriber to listen update regarding `Network`.
`void`	`networkManagementCommandCallback(Network network, CommandResponse<?> command)` A function that needs to be implemented by subscriber to listen to responses of `Network.sendNetworkManagementCommand(Command, Network.NetworkManagementStatusListener)`.
`void`	`networkMetadataCallback(Network network)` A callback that delivers metadata updates for a network.
`void`	`nodeConnectionStatusCallback(Network network, long nodeId, NodeType nodeType, boolean isOnline)` A function that needs to be implemented by the subscriber to listen updates regarding node connection status.
`void`	`receiveDataCallback(Network network, long sourceNodeId, java.lang.String data)` A callback for receiver nodes that triggers upon receiving the message sent in a network using `Network.sendData(String, long[])`.
`void`	`resourceAttributeCallback(Attribute attribute)` A function that needs to be implemented by the subscriber to listen updates regarding updates in `Attribute`'s data.
`void`	`resourceCallback(Resource resource)` A function that needs to be implemented by subscriber to listen updates regarding `Resource`'s info.
`void`	`resourceCapabilityCallback(Capability capability)` A function that needs to be implemented by subscriber to listen updates regarding `Resource`'s capabilities.
`void`	`resourceExcludedCallback(Resource resource)` A function that needs to implemented by subscriber to listen to update regarding `Resource`'s exclusion.
`void`	`resourceIncludedCallback(java.util.ArrayList<Resource> resources)` A function that needs to implemented by subscriber to listen to update regarding `Resource`'s inclusion.
`void`	`ruleDeletedCallback(Network network, int ruleId)` A function that needs to be implemented by the subscriber to listen updates regarding `Rule`'s.
`void`	`ruleInfoCallback(Rule rule)` A function that needs to be implemented by the subscriber to listen updates regarding `Rule`'s.
`void`	`sceneDeletedCallback(Network network, int sceneId)` A function that needs to be implemented by the subscriber to listen updates regarding `Scene`'s.
`void`	`sceneInfoCallback(Scene scene)` A function that needs to be implemented by the subscriber to listen updates regarding `Scene`'s.
`void`	`tunnelStatusCallback(Capability tunnel, long tunnelHandle, CapabilityTunnel.State state, int port)` A function that needs to implemented by subscriber to listen to updates regarding `CapabilityTunnel.State`.
`void`	`zoneDeletedCallback(Network network, int zoneId)` A function that needs to be implemented by the subscriber to listen updates regarding `Zone` deletions.
`void`	`zoneInfoCallback(Zone zone)` A function that needs to be implemented by the subscriber to listen updates regarding `Zone`'s.

- Method Detail
  - connectStatusCallback
```
void connectStatusCallback(Network network)
```
    A function that needs to be implemented by subscribers to get info regrading connection status of the Network.
    
    Parameters:
    
    network - Network whose connect status is updated.
  - deviceInfoCallback
```
void deviceInfoCallback(Device device)
```
    A function that needs to be implemented by subscriber to listen updates regarding Device.
    
    Parameters:
    
    device - Device whose info is updated.
  - resourceCallback
```
void resourceCallback(Resource resource)
```
    A function that needs to be implemented by subscriber to listen updates regarding Resource's info.
    
    Parameters:
    
    resource - Resource whose info is updated.
  - resourceCapabilityCallback
```
void resourceCapabilityCallback(Capability capability)
```
    A function that needs to be implemented by subscriber to listen updates regarding Resource's capabilities.
    
    Parameters:
    
    capability - Capability
  - resourceAttributeCallback
```
void resourceAttributeCallback(Attribute attribute)
```
    A function that needs to be implemented by the subscriber to listen updates regarding updates in Attribute's data.
    
    Parameters:
    
    attribute - Attribute whose info is updated.
  - commandStatusCallback
```
void commandStatusCallback(CommandResponse<?> response)
```
    A function that needs to implemented by the subscriber to response for sent Command's.
    
    Parameters:
    
    response - response sent by the Device.
  - networkListCallback
```
void networkListCallback(java.util.ArrayList<Network> networksList)
```
    A function that needs to be implemented by subscriber to listen update regarding Network.
    
    Parameters:
    
    networksList - List of networks present.
  - deviceManagementStatusCallback
```
void deviceManagementStatusCallback(Device device,
                                    CommandResponse<?> commandResponse,
                                    Resource[] resourcesImpacted)
```
    A function that needs to be implemented by subscriber to listen to responses of Device.sendDeviceManagementCommand(Command, Device.DeviceManagementStatusListener).
    
    Parameters:
    
    device - Device on which commands was executed.
    
    commandResponse - response sent by Device.
    
    resourcesImpacted - Resource's which are impacted by the command sent.
  - infoRequestCallback
```
void infoRequestCallback(InfoRequest infoRequest)
```
    A function that needs to be implemented by subscriber to listen to InfoRequest sent by Device.
    
    Parameters:
    
    infoRequest - InfoRequest that is sent by Device.
  - infoResponseStatusCallback
```
void infoResponseStatusCallback(Command.State state,
                                InfoResponse infoResponse)
```
    A function that needs to be implemented by subscriber to listen to status of InfoResponse.
    
    Parameters:
    
    state - state sent by Device.
    
    infoResponse - InfoResponse.
  - messageCallback
```
void messageCallback(java.lang.String title,
                     java.lang.String message,
                     MessageType messageType)
```
    A function that needs to be implemented by subscriber to listen to messages that are passed back usually during resource addition.
    
    Parameters:
    
    title - The title that can be show on UI
    
    message - The message that can be shown on UI
    
    messageType - The message type indicating kind of message
  - advertiseResourceCallback
```
void advertiseResourceCallback(Resource resource)
```
    A function that needs to be implemented by the subscriber to listen to resource advertisement sent by Device.
    
    Parameters:
    
    resource - Resource advertised by the Device.
  - infoRequestStatusCallback
```
void infoRequestStatusCallback(Command.State state,
                               InfoRequest infoRequest)
```
    A function that needs to be implemented by subscriber to listen to state of sent InfoRequest.
    
    Parameters:
    
    state - state sent by device.
    
    infoRequest - InfoRequest that is sent to device.
  - infoResponseCallback
```
void infoResponseCallback(InfoRequest request,
                          InfoResponse infoResponse)
```
    A function that needs to be implemented by subscriber to listen to InfoResponse sent by Device in repose to InfoRequest.
    
    Parameters:
    
    request - InfoRequest Which triggered response from Device.
    
    infoResponse - InfoResponse sent by Device.
  - resourceIncludedCallback
```
void resourceIncludedCallback(java.util.ArrayList<Resource> resources)
```
    A function that needs to implemented by subscriber to listen to update regarding Resource's inclusion.
    
    Parameters:
    
    resources - List of resource's that are included.
  - resourceExcludedCallback
```
void resourceExcludedCallback(Resource resource)
```
    A function that needs to implemented by subscriber to listen to update regarding Resource's exclusion.
    
    Parameters:
    
    resource - resource that is included.
  - tunnelStatusCallback
```
void tunnelStatusCallback(Capability tunnel,
                          long tunnelHandle,
                          CapabilityTunnel.State state,
                          int port)
```
    A function that needs to implemented by subscriber to listen to updates regarding CapabilityTunnel.State.
    
    Parameters:
    
    tunnel - The tunnel capability object.
    
    tunnelHandle - a long type handles status of tunnel
    
    state - current status of tunnel.
    
    port - port over which transmission is happening.
  - zoneInfoCallback
```
void zoneInfoCallback(Zone zone)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Zone's.
    
    Parameters:
    
    zone - Zone whose info is updated.
  - zoneDeletedCallback
```
void zoneDeletedCallback(Network network,
                         int zoneId)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Zone deletions.
    
    Parameters:
    
    network - Network to which deleted zone belongs to.
    
    zoneId - ID of the deleted zone.
  - sceneInfoCallback
```
void sceneInfoCallback(Scene scene)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Scene's.
    
    Parameters:
    
    scene - scene whose info is updated.
  - sceneDeletedCallback
```
void sceneDeletedCallback(Network network,
                          int sceneId)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Scene's.
    
    Parameters:
    
    network - Network whose scene is deleted.
    
    sceneId - ID of deleted scene.
  - ruleInfoCallback
```
void ruleInfoCallback(Rule rule)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Rule's.
    
    Parameters:
    
    rule - rule whose info is updated.
  - ruleDeletedCallback
```
void ruleDeletedCallback(Network network,
                         int ruleId)
```
    A function that needs to be implemented by the subscriber to listen updates regarding Rule's.
    
    Parameters:
    
    network - Network whose scene is deleted.
    
    ruleId - ID of deleted scene.
  - nodeConnectionStatusCallback
```
void nodeConnectionStatusCallback(Network network,
                                  long nodeId,
                                  NodeType nodeType,
                                  boolean isOnline)
```
    A function that needs to be implemented by the subscriber to listen updates regarding node connection status.
    
    Parameters:
    
    network - Network Whose node status is changed.
    
    nodeId - ID of the node.
    
    nodeType - Type of the node.
    
    isOnline - Flag representing if node is online.
  - networkManagementCommandCallback
```
void networkManagementCommandCallback(Network network,
                                      CommandResponse<?> command)
```
    A function that needs to be implemented by subscriber to listen to responses of Network.sendNetworkManagementCommand(Command, Network.NetworkManagementStatusListener).
    
    Parameters:
    
    network - Network on which commands was executed.
    
    command - response that's sent by Device.
  - networkDataCallback
```
void networkDataCallback(Network network)
```
    A function that needs to be implemented by subscriber to listen to updates of network.
    
    Parameters:
    
    network - Network whose data is updated.
  - leaveNetworkStatusCallback
```
void leaveNetworkStatusCallback(Network network,
                                Command.State status)
```
    Command.State.SUCCESS and Command.State.FAILURE are only possible.
    
    Parameters:
    
    network - The network on which Network.leave(Network.LeaveStatusListener) was called.
    
    status - The status for the command sent.
  - errorCallback
```
void errorCallback(java.lang.Throwable tr)
```
    A callback indicating an internal error. Usually triggered if an exception is thrown while handling another callback. NOTE: If this callback throws exception. It will be silently discarded.
    
    Parameters:
    
    tr - The error which occurred.
  - receiveDataCallback
```
void receiveDataCallback(Network network,
                         long sourceNodeId,
                         java.lang.String data)
```
    A callback for receiver nodes that triggers upon receiving the message sent in a network using Network.sendData(String, long[]).
    
    Parameters:
    
    network - The Network in which message was sent.
    
    sourceNodeId - The nodeId of the author of the message.
    
    data - The content of the message.
  - contentInfoCallback
```
void contentInfoCallback(Network network,
                         long sourceNodeId,
                         long contentTime,
                         java.lang.String data)
```
    A callback for receiver nodes that triggers upon receiving the data sent using Network.sendContentInfo(long, String, long[]).
    
    Parameters:
    
    network - The Network in which message was sent.
    
    sourceNodeId - The nodeId of the author of the message.
    
    contentTime - The time of sending
    
    data - The content of the message.
  - networkMetadataCallback
```
void networkMetadataCallback(Network network)
```
    A callback that delivers metadata updates for a network.
    
    Parameters:
    
    network - Network object with updated metadata.

Interface CallbacksInterface

Method Summary

Method Detail

connectStatusCallback

deviceInfoCallback

resourceCallback

resourceCapabilityCallback

resourceAttributeCallback

commandStatusCallback

networkListCallback

deviceManagementStatusCallback

infoRequestCallback

infoResponseStatusCallback

messageCallback

advertiseResourceCallback

infoRequestStatusCallback

infoResponseCallback

resourceIncludedCallback

resourceExcludedCallback

tunnelStatusCallback

zoneInfoCallback

zoneDeletedCallback

sceneInfoCallback

sceneDeletedCallback

ruleInfoCallback

ruleDeletedCallback

nodeConnectionStatusCallback

networkManagementCommandCallback

networkDataCallback

leaveNetworkStatusCallback

errorCallback

receiveDataCallback

contentInfoCallback

networkMetadataCallback