Skip navigation links

waggle.common.modules.buzz
Interface XBuzzModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XBuzzModule

public static interface XBuzzModule.Server

extends XAPIInterface.Server

Server interface for the Buzz Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	closeBuzz(XObjectID buzzID) Close an open Buzz.
List<XBuzzInfo>	getBuzzes() Get all open buzzes.
List<XBuzzSummaryInfo>	getBuzzesSummary() Get summary data for all open buzzes.
XBuzzInfo	openBuzz(XObjectID userID, XObjectID conversationID) Buzz another User.

Method Detail

getBuzzes

List<XBuzzInfo> getBuzzes()

Get all open buzzes.

Returns:

Returns all open buzzes.

getBuzzesSummary

List<XBuzzSummaryInfo> getBuzzesSummary()

Get summary data for all open buzzes.

Returns:

Returns all open buzzes summary data.

openBuzz

XBuzzInfo openBuzz(XObjectID userID,
                   XObjectID conversationID)

Buzz another User.

Parameters:

userID - The User to be buzzed.

conversationID - The Conversation the User is to be buzzed into.

Returns:

The buzz info.

closeBuzz

void closeBuzz(XObjectID buzzID)

Close an open Buzz.

Parameters:

buzzID - The Buzz.

Skip navigation links