public interface InteractionListenerI
InteractionListenerI
interface delivers InteractionI
level events to the
application.Modifier and Type | Method and Description |
---|---|
void |
onInteractionEvent(NotificationEventI<InteractionI> interactionEvent)
This method delivers a
NotificationEventI object which contains a NotificationType , the object that is
being updated (InteractionI ), an optional ErrorI object and an optional ResponseData object. |
void |
onInteractionMediaEvent(NotificationEventI<? extends MediaI> nei) |
void onInteractionEvent(NotificationEventI<InteractionI> interactionEvent)
NotificationEventI
object which contains a NotificationType
, the object that is
being updated (InteractionI
), an optional ErrorI
object and an optional ResponseData
object.
A NotificationType.NEW
notification indicates that a new InteractionI
object has been added to the session.
A NotificationType.UPDATE
notification indicates that properties of the specified InteractionI
instance has
been modified and the newly supplied InteractionI
object represents a complete update.
A NotificationType.DELETE
notification indicates that the identified InteractionI
has been deleted. The
majority of API methods will throw an ObjectInvalidException
if invoked after the InteractionI
object has
been deleted. However a small set of API methods for retrieving specific properties are available for the client
application after the InteractionI
object has been deleted. If an API method is accessible after object deletion it
will be specified in the API documentation. The client application must discontinue the use of the
InteractionI
and must null out all references it holds to the deleted InteractionI
object. This is
to ensure that garbage collection of the deleted objects can occur.
An NotificationType.ERROR
notification indicates the failure of a InteractionI
method call made by the
client application on one of the InteractionI
instances. The accompanying ErrorI
object provides details as
to the cause of the error. A NotificationType.RESPONSE
notification indicates that a response has been received for
an InteractionI
SDK method that has requested data from the server. The response notifications will have a
ResponseData
object containing the data that was requested.
The CCS API executes this event listener method in the context of the CCS API processing threads. On receiving a notification event, the application must immediately switch executing context from the CCS API processing threads and move processing of the event to application threads.
interactionEvent
- details of an InteractionI
object notificationvoid onInteractionMediaEvent(NotificationEventI<? extends MediaI> nei)