C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
GenericResponseAggregator Class Reference

The GenericResponseAggregator used to assist with implementation of providing session responses.

Public Functions

void AddResponse (Guid sessionId, ResponseInfo const &response)
 
void AddResponse (Guid sessionId, String const &destination, ContentInfo const &content)
 
void AddResponse (Guid sessionId, String const &destination, ContentInfo const &content, Collections::IMap< String, String > const &parameters)
 
virtual void Clear ()
 
 GenericResponseAggregator ()
 
virtual Collections::List< ResponseInfo > GetNextResponses (Guid sessionId)
 
virtual bool HasResponses (Guid sessionId)
 
virtual bool RemoveResponses (Guid sessionId)
 

Usage Description

void AddResponse ( Guid  sessionId,
ResponseInfo const &  response 
)

Adds a response for the specified session.

Parameters
sessionIdThe session's unique identifier.
responseThe response.
void AddResponse ( Guid  sessionId,
String const &  destination,
ContentInfo const &  content 
)

Adds a response for the specified session.

Parameters
sessionIdThe session's unique identifier.
destinationThe destination of the response.
contentThe content of the response.
void AddResponse ( Guid  sessionId,
String const &  destination,
ContentInfo const &  content,
Collections::IMap< String, String > const &  parameters 
)

Adds a response for the specified session.

Parameters
sessionIdThe session's unique identifier.
destinationThe destination of the response.
contentThe content of the response.
contentThe parameters included with the response.
void Clear ( )
virtual

Clears this instance.

Collections::List< ResponseInfo > GetNextResponses ( Guid  sessionId)
virtual

Gets the next responses for the specified session.

bool HasResponses ( Guid  sessionId)
virtual

Determines whether the specified session has responses. Returns true if it does; otherwise, returns false.

bool RemoveResponses ( Guid  sessionId)
virtual

Removes the responses for the specified session. Returns true if responses for the session existed and were removed, otherwise returns false.