Skip navigation links

waggle.common.modules.voice
Interface XVoiceModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XVoiceModule

public static interface XVoiceModule.Server

extends XAPIInterface.Server

Server interface for the Voice Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	bookmark(XObjectID conversationID, XObjectID conferenceID, Long position) Bookmark a position in the conference.
String	call(XObjectID conversationID, String phoneNumber) Call the user at the specified number and add them to the Conversation's conference call.
String	callOther(XObjectID conversationID, XObjectID userID, String phoneNumber) Call another user at the specified number and add them to the Conversation's conference call.
XCallStatusInfo	getCallStatusInfo(XObjectID conversationID) Get the calling user's current call status in a given conversation.
void	hangUp(String callID) Hang up the specified call.
void	hangUpOther(XObjectID conversationID, XObjectID userID) Hang up another user on a call in the specified conversation.
void	mute(String callID, Boolean mute) Mute or unmute the specified call.

Method Detail

call

String call(XObjectID conversationID,
            String phoneNumber)

Call the user at the specified number and add them to the Conversation's conference call.

Parameters:

conversationID - a XObjectID value

phoneNumber - a String value

Returns:

a String value containing a unique call id

callOther

String callOther(XObjectID conversationID,
                 XObjectID userID,
                 String phoneNumber)

Call another user at the specified number and add them to the Conversation's conference call.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

phoneNumber - a String value containing the hash of a user's public phone number.

Returns:

a String value containing a unique call id

hangUp

void hangUp(String callID)

Hang up the specified call.

Parameters:

callID - the call id.

hangUpOther

void hangUpOther(XObjectID conversationID,
                 XObjectID userID)

Hang up another user on a call in the specified conversation.

Parameters:

conversationID - a XObjectID value

userID - a XObjectID value

mute

void mute(String callID,
          Boolean mute)

Mute or unmute the specified call.

Parameters:

callID - the call id.

mute - true if line should be muted.

bookmark

void bookmark(XObjectID conversationID,
              XObjectID conferenceID,
              Long position)

Bookmark a position in the conference.

Parameters:

conversationID - a XObjectID value

conferenceID - a XObjectID value

position - a Long value containing the offset in milliseconds. 0 is allowed to specify the addition of a marker for the current moment if the conference is still on going.

getCallStatusInfo

XCallStatusInfo getCallStatusInfo(XObjectID conversationID)

Get the calling user's current call status in a given conversation.

Parameters:

conversationID - a XObjectID value

Returns:

a CallStatusInfo value

Skip navigation links