Skip navigation links

waggle.common.modules.poll
Interface XPollModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XPollModule

public static interface XPollModule.Server

extends XAPIInterface.Server

Server interface for the Poll Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XObjectID	createPoll(XObjectID conversationID, XPollCreateInfo createInfo) Create a Poll widget.
XPollGetInfo	getPoll(XObjectID pollID) Get current Poll information and how I voted.
void	pollClose(XObjectID pollID, String chatText) Close a Poll.
void	pollOpen(XObjectID pollID, String chatText) Open a Poll.
void	updatePoll(XObjectID pollID, XPollCreateInfo updateInfo) Update a poll object.
void	voteMultiple(XObjectID pollID, List<String> pollOptions) Vote for a Poll.
void	voteSingle(XObjectID pollID, String pollOption) Vote for a Poll.

Method Detail

createPoll

XObjectID createPoll(XObjectID conversationID,
                     XPollCreateInfo createInfo)

Create a Poll widget.

Parameters:

conversationID - The Conversation.

createInfo - The create info.

Returns:

The object ID.

updatePoll

void updatePoll(XObjectID pollID,
                XPollCreateInfo updateInfo)

Update a poll object.

Parameters:

pollID - The Poll.

updateInfo - The update info.

voteSingle

void voteSingle(XObjectID pollID,
                String pollOption)

Vote for a Poll.

Parameters:

pollID - The Poll.

pollOption - The Poll option.

voteMultiple

void voteMultiple(XObjectID pollID,
                  List<String> pollOptions)

Vote for a Poll.

Parameters:

pollID - The Poll.

pollOptions - The Poll options.

pollOpen

void pollOpen(XObjectID pollID,
              String chatText)

Open a Poll.

Parameters:

pollID - The Poll.

chatText - Any custom Chat text. May be null.

pollClose

void pollClose(XObjectID pollID,
               String chatText)

Close a Poll.

Parameters:

pollID - The Poll.

chatText - Any custom Chat text. May be null.

getPoll

XPollGetInfo getPoll(XObjectID pollID)

Get current Poll information and how I voted.

Parameters:

pollID - The Poll.

Returns:

The Poll info.

Skip navigation links