org.kurento.room.api

Interface UserNotificationService

public interface UserNotificationService

This specification was designed so that the room manager could send notifications or responses back to the remote peers whilst remaining isolated from the transport or communications layers. The notification API will be used by the default implementation of NotificationRoomHandler (provided by the room SDK - DefaultNotificationRoomHandler).

JSON-RPC messages specification was used to define the following primitives.It is expected but not required for the client-server communications to use this protocol. It is left for the integrator to provide an implementation for this API. If the developer chooses another mechanism to communicate with the client, they will have to use their own implementation of NotificationRoomHandler which will completly decouple the communication details from the room API.

Author:

Radu Tom Vlad

Method Summary

Modifier and Type	Method and Description
void	closeSession(ParticipantRequest participantRequest) Notifies that any information associated with the provided request should be cleaned up (the participant has left).
void	sendErrorResponse(ParticipantRequest participantRequest, Object data, RoomException error) Responds back to the remote peer with the details of why the invoked method failed to be processed correctly.
void	sendNotification(String participantId, String method, Object params) Sends a notification to a remote peer.
void	sendResponse(ParticipantRequest participantRequest, Object result) Responds back to the remote peer with the result of the invoked method.

Method Detail

sendResponse

void sendResponse(ParticipantRequest participantRequest,
                  Object result)

Responds back to the remote peer with the result of the invoked method.

Parameters:

participantRequest - instance of ParticipantRequest POJO

result - Object containing information that depends on the invoked method. It'd normally be a JSON element-type object.

sendErrorResponse

void sendErrorResponse(ParticipantRequest participantRequest,
                       Object data,
                       RoomException error)

Responds back to the remote peer with the details of why the invoked method failed to be processed correctly.

Parameters:

participantRequest - instance of ParticipantRequest POJO

data - optional (nullable) Object containing additional information on the error. Can be a String or a JSON element-type object.

error - instance of RoomException POJO, includes a code and error message

sendNotification

void sendNotification(String participantId,
                      String method,
                      Object params)

Sends a notification to a remote peer. This falls outside the normal exchange of messages (client requests - server answers) so there's no need for a request identifier.

Parameters:

participantId - identifier of the targeted participant

method - String with the name of the method or event to be invoked on the client

params - Object containing information that depends on the invoked method. It'd normally be a JSON element-type object.

closeSession

void closeSession(ParticipantRequest participantRequest)

Notifies that any information associated with the provided request should be cleaned up (the participant has left).

Parameters:

participantRequest - instance of ParticipantRequest POJO