Skip navigation links

waggle.common.modules.conversation
Interface XConversationModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XConversationModule

public static interface XConversationModule.Server

extends XAPIInterface.Server

Server interface for the Conversation Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	changeConversationExternalIDs(XObjectID conversationID, List<String> addExternalIDs, List<String> removeExternalIDs) Change a Conversation's secondary external IDs.
void	changeConversationMembers(XObjectID conversationID, List<XConversationMemberChangeInfo> changeInfos, boolean errorIfRemovingSelf) Change a Conversation's membership.
XConversationInfo	createConversation(XObjectID trackID, String name) Create a new Conversation.
XConversationInfo	createConversationFromInfo(XConversationCreateInfo createInfo) Create a new Conversation.
void	deleteConversationPicture(XObjectID conversationID) Delete any Conversation picture.
void	enterConversation(XObjectID conversationID) Enter a Conversation.
void	exitConversation(XObjectID conversationID) Exit a Conversation.
List<XConversationGetInfo>	getAllActiveConversations() Get information about all active, accessible, Conversations.
XConversationGetInfo	getConversation(XObjectID conversationID) Get info about a Conversation.
List<XArtifactInfo>	getConversationArtifacts(XObjectID conversationID) Get information about a Conversation's referenced Artifacts.
XConversationGetInfo	getConversationByPrimaryExternalID(String externalID) Get information about the specified Conversation.
List<XUserInfo>	getConversationContributors(XObjectID conversationID) Get information about a Conversation's contributors.
XConversationCountsInfo	getConversationCounts() Get counts of discoverable, accessible open and accessible closed Conversations\ for the current User.
List<XConversationMemberInfo>	getConversationDirectMembers(XObjectID conversationID) Get information about a Conversation's direct User and Group members.
List<XConversationDocumentInfo>	getConversationDocuments(XObjectID conversationID, XConversationDocumentOptionsInfo optionsInfo) Get information about a Conversation's referenced Documents.
List<XObjectID>	getConversationEntered(XObjectID conversationID) Return the set of Users that are currently entered into the Conversation.
XConversationGetInfo	getConversationIfAccessible(XObjectID conversationID) Get info about a Conversation.
XConversationMapInfo	getConversationMap(XConversationMapFilterInfo filterInfo) Get a Conversation map.
List<XConversationMemberInfo>	getConversationMembership(XObjectID conversationID) Get information about a Conversation's direct and indirect User membership.
List<XConversationMemberInfo>	getConversationMembershipAndDirectGroups(XObjectID conversationID) Get information about a Conversation's direct and indirect User membership and the Conversation's direct Groups.
XConversationRole	getConversationRole(XObjectID conversationID) Return the current User's role in the specified Conversation.
List<XConversationGetInfo>	getConversations() Get info about a set of Conversations that the current User is a member of across all Tracks.
List<XConversationGetInfo>	getConversationsBySecondaryExternalID(String externalID) Get information about the specified Conversations.
XConversationDetailInfo	getConversationsDetail(XConversationDetailFilterInfo filterInfo) Get info about a set of Conversations that the current User is a member of across all Tracks, along with extra details that are useful to the UI.
List<XConversationGetInfo>	getConversationsIfAccessible(List<XObjectID> conversationIDs) Get info about a set of accessible Conversations.
List<XConversationGetInfo>	getConversationsInCommon(XObjectID userID) Get Conversations that are in common with another User.
List<XConversationDetailConversationInfo>	getDiscoverableConversations() Get all discoverable Conversations.
List<XConversationDetailConversationInfo>	getDiscoverableConversationsForUser(XObjectID userID) Get all Conversations discoverable by the caller that the specified User is a member of.
List<XConversationGetInfo>	getGeolocatedConversations(double minLatitude, double maxLatitude, double minLongitude, double maxLongitude) Get all accessible geolocated Conversations.
List<waggle.common.modules.object.infos.XObjectInfo>	getGeolocatedObjects(XObjectID conversationID, double minLatitude, double maxLatitude, double minLongitude, double maxLongitude) Get all geolocated objects in this Conversation.
List<XConversationGetInfo>	getNewConversations() Get the new Conversations for the current user.
InputStream	getOriginalConversationPicture(XObjectID conversationID) Get any original Conversation picture.
InputStream	getScaledConversationPicture(XObjectID conversationID) Get any scaled Conversation picture.
List<XConversationGetInfo>	getTopActiveConversations(int limit) Return all open Conversations, in any Tracks in which the user is a Member.
List<XConversationGetInfo>	getTrackClosedConversations(XObjectID trackID) Get info about a set of closed Conversations in the specified Track that the User has access to and is a member of.
List<XConversationGetInfo>	getTrackConversations(XObjectID trackID) Get info about a set of all Conversations in the specified Track that the User has access to and is a member of.
List<XConversationGetInfo>	getTrackDiscoverableConversations(XObjectID trackID) Get info about a set of discoverable Conversations in the specified Track that the User has access to and is not a member of.
List<XConversationGetInfo>	getTrackOpenConversations(XObjectID trackID) Get info about a set of open Conversations in the specified Track that the User has access to and is a member of.
void	joinDiscoverableConversation(XObjectID conversationID) Join a Discoverable Conversation.
XConversationInfo	moveConversation(XObjectID conversationID, XObjectID trackID) Move a Conversation to another Track.
void	removeConversation(XObjectID conversationID) Remove a Conversation.
XSearchResultsInfo	searchConversation(XObjectID conversationID, XConversationSearchInfo searchInfo) Search the content of a Conversation.
void	setConversationDiscoverable(XObjectID conversationID, boolean discoverable) Change a Conversation's discoverable status.
void	setConversationName(XObjectID conversationID, String name) Change a Conversation's name.
void	setConversationState(XObjectID conversationID, XConversationState state, String chatText) Change a Conversation's state with an optional custom message.
void	updateConversation(XObjectID conversationID, XUpdater updater) Update a Conversation.
void	uploadConversationPicture(XObjectID conversationID, XAPIInputStream inputStream, String mimeType, long length) Upload a picture for the specified Conversation.
String	uploadConversationPictureToDataUri(XAPIInputStream inputStream, String mimeType, long length) Convert an image to a scaled image Data URI.

Method Detail

createConversation

XConversationInfo createConversation(XObjectID trackID,
                                     String name)

Create a new Conversation.

Parameters:

trackID - The Track.

name - The name of the Conversation.

Returns:

Info about the created Conversation.

createConversationFromInfo

XConversationInfo createConversationFromInfo(XConversationCreateInfo createInfo)

Create a new Conversation.

Parameters:

createInfo - The creation info for the Conversation.

Returns:

Info about the created Conversation.

getConversation

XConversationGetInfo getConversation(XObjectID conversationID)

Get info about a Conversation.

Parameters:

conversationID - The Conversation.

Returns:

Information about the Conversation.

getConversationIfAccessible

XConversationGetInfo getConversationIfAccessible(XObjectID conversationID)

Get info about a Conversation.

Parameters:

conversationID - The Conversation.

Returns:

Information about the Conversation or null if the Conversation is not accessible.

getConversationsIfAccessible

List<XConversationGetInfo> getConversationsIfAccessible(List<XObjectID> conversationIDs)

Get info about a set of accessible Conversations.

Parameters:

conversationIDs - The Conversations.

Returns:

Information about the accessible Conversations.

getTrackConversations

List<XConversationGetInfo> getTrackConversations(XObjectID trackID)

Get info about a set of all Conversations in the specified Track that the User has access to and is a member of.

Parameters:

trackID - The Track.

Returns:

Information about the set of Conversations.

getTrackOpenConversations

List<XConversationGetInfo> getTrackOpenConversations(XObjectID trackID)

Get info about a set of open Conversations in the specified Track that the User has access to and is a member of.

Parameters:

trackID - The Track.

Returns:

Information about the set of Conversations.

getTrackClosedConversations

List<XConversationGetInfo> getTrackClosedConversations(XObjectID trackID)

Get info about a set of closed Conversations in the specified Track that the User has access to and is a member of.

Parameters:

trackID - The Track.

Returns:

Information about the set of Conversations.

getTrackDiscoverableConversations

List<XConversationGetInfo> getTrackDiscoverableConversations(XObjectID trackID)

Get info about a set of discoverable Conversations in the specified Track that the User has access to and is not a member of.

Parameters:

trackID - The Track.

Returns:

Information about the set of Conversations.

getConversations

List<XConversationGetInfo> getConversations()

Get info about a set of Conversations that the current User is a member of across all Tracks.

Returns:

Information about the set of Conversations.

getConversationsDetail

XConversationDetailInfo getConversationsDetail(XConversationDetailFilterInfo filterInfo)

Get info about a set of Conversations that the current User is a member of across all Tracks, along with extra details that are useful to the UI.

Parameters:

filterInfo - The filter info.

Returns:

Information about the set of Conversations.

getTopActiveConversations

List<XConversationGetInfo> getTopActiveConversations(int limit)

Return all open Conversations, in any Tracks in which the user is a Member.

Parameters:

limit - Maximum number of records to return.

Returns:

All open Conversations, in any Tracks in which the user is a Member, most recently created first.

getNewConversations

List<XConversationGetInfo> getNewConversations()

Get the new Conversations for the current user.

Returns:

The new Conversations for the current user, most recently created first.

getConversationCounts

XConversationCountsInfo getConversationCounts()

Get counts of discoverable, accessible open and accessible closed Conversations\ for the current User.

Returns:

The Conversation counts for the current User.

getDiscoverableConversations

List<XConversationDetailConversationInfo> getDiscoverableConversations()

Get all discoverable Conversations. The return value will not include Conversations in which the calling User has Viewer access.

Returns:

All discoverable Conversations.

getDiscoverableConversationsForUser

List<XConversationDetailConversationInfo> getDiscoverableConversationsForUser(XObjectID userID)

Get all Conversations discoverable by the caller that the specified User is a member of. The return value will not include Conversations in which the calling User has Viewer access.

Parameters:

userID - The other User.

Returns:

All Conversations discoverable by the caller that the specified User is a member of.

getConversationByPrimaryExternalID

XConversationGetInfo getConversationByPrimaryExternalID(String externalID)

Get information about the specified Conversation.

Parameters:

externalID - The Conversation's primary external ID (Business Object ID).

Returns:

Information about the located Conversation.

getConversationsBySecondaryExternalID

List<XConversationGetInfo> getConversationsBySecondaryExternalID(String externalID)

Get information about the specified Conversations.

Parameters:

externalID - The Conversation's secondary external ID (Business Object ID).

Returns:

Information about the located Conversations.

getConversationArtifacts

List<XArtifactInfo> getConversationArtifacts(XObjectID conversationID)

Get information about a Conversation's referenced Artifacts.

Parameters:

conversationID - The Conversation.

Returns:

Information about the Artifacts referenced by a Conversation.

getAllActiveConversations

List<XConversationGetInfo> getAllActiveConversations()

Get information about all active, accessible, Conversations. Active Conversations are those that have currently entered clients or have a voice or application Conference in progress.

Returns:

All active, accessible, Conversations.

getConversationDocuments

List<XConversationDocumentInfo> getConversationDocuments(XObjectID conversationID,
                                                         XConversationDocumentOptionsInfo optionsInfo)

Get information about a Conversation's referenced Documents.

Parameters:

conversationID - The Conversation.

optionsInfo - Option settings.

Returns:

Information about the Documents and Versions referenced by a Conversation.

getConversationEntered

List<XObjectID> getConversationEntered(XObjectID conversationID)

Return the set of Users that are currently entered into the Conversation.

Parameters:

conversationID - The Conversation.

Returns:

The set of Users that are currently entered into the Conversation.

getConversationRole

XConversationRole getConversationRole(XObjectID conversationID)

Return the current User's role in the specified Conversation.

Parameters:

conversationID - The Conversation.

Returns:

The current User's role in the specified Conversation.

getConversationDirectMembers

List<XConversationMemberInfo> getConversationDirectMembers(XObjectID conversationID)

Get information about a Conversation's direct User and Group members.

Parameters:

conversationID - The Conversation.

Returns:

List of information about a Conversation's direct User and Group members.

getConversationMembership

List<XConversationMemberInfo> getConversationMembership(XObjectID conversationID)

Get information about a Conversation's direct and indirect User membership.

Parameters:

conversationID - The Conversation.

Returns:

List of information about a Conversation's direct and indirect User membership.

getConversationMembershipAndDirectGroups

List<XConversationMemberInfo> getConversationMembershipAndDirectGroups(XObjectID conversationID)

Get information about a Conversation's direct and indirect User membership and the Conversation's direct Groups.

Parameters:

conversationID - The Conversation.

Returns:

List of information about a Conversation's direct and indirect User membership and the Conversation's direct Groups.

getConversationContributors

List<XUserInfo> getConversationContributors(XObjectID conversationID)

Get information about a Conversation's contributors. Includes all Users who have ever contributed to a Conversation.

Parameters:

conversationID - The Conversation.

Returns:

Information about the contributors.

setConversationName

void setConversationName(XObjectID conversationID,
                         String name)

Change a Conversation's name.

Parameters:

conversationID - The Conversation.

name - The new name.

setConversationState

void setConversationState(XObjectID conversationID,
                          XConversationState state,
                          String chatText)

Change a Conversation's state with an optional custom message.

Parameters:

conversationID - The Conversation.

state - The state.

chatText - The Chat Text. May be null.

setConversationDiscoverable

void setConversationDiscoverable(XObjectID conversationID,
                                 boolean discoverable)

Change a Conversation's discoverable status.

Parameters:

conversationID - The Conversation.

discoverable - The discoverable status.

changeConversationExternalIDs

void changeConversationExternalIDs(XObjectID conversationID,
                                   List<String> addExternalIDs,
                                   List<String> removeExternalIDs)

Change a Conversation's secondary external IDs.

Parameters:

conversationID - The Conversation's ID.

addExternalIDs - The external IDs to be added.

removeExternalIDs - The external IDs to be removed.

changeConversationMembers

void changeConversationMembers(XObjectID conversationID,
                               List<XConversationMemberChangeInfo> changeInfos,
                               boolean errorIfRemovingSelf)

Change a Conversation's membership. Only pass the memberships that are changing in "changeInfos". There is no need to get the full current conversation membership & send it back to the server again.

Parameters:

conversationID - The Conversation.

changeInfos - The Conversation members and their access levels. List of XConversationMemberChangeInfo.

errorIfRemovingSelf - If true then report an error if the requested changes would result in the removal of the calling User.

updateConversation

void updateConversation(XObjectID conversationID,
                        XUpdater updater)

Update a Conversation.

Parameters:

conversationID - The Conversation.

updater - The fields to be updated.

moveConversation

XConversationInfo moveConversation(XObjectID conversationID,
                                   XObjectID trackID)

Move a Conversation to another Track. The source Conversation is marked as being MOVED.

Parameters:

conversationID - The Conversation to move.

trackID - The new Track.

Returns:

The Conversation information DTO.

searchConversation

XSearchResultsInfo searchConversation(XObjectID conversationID,
                                      XConversationSearchInfo searchInfo)

Search the content of a Conversation.

Parameters:

conversationID - The Track.

searchInfo - The search string.

Returns:

Info about the Artifacts matching the search.

removeConversation

void removeConversation(XObjectID conversationID)

Remove a Conversation.

Parameters:

conversationID - The Conversation.

enterConversation

void enterConversation(XObjectID conversationID)

Enter a Conversation.

Parameters:

conversationID - The Conversation.

exitConversation

void exitConversation(XObjectID conversationID)

Exit a Conversation.

Parameters:

conversationID - The Conversation.

joinDiscoverableConversation

void joinDiscoverableConversation(XObjectID conversationID)

Join a Discoverable Conversation.

Parameters:

conversationID - The Conversation.

getConversationsInCommon

List<XConversationGetInfo> getConversationsInCommon(XObjectID userID)

Get Conversations that are in common with another User.

Parameters:

userID - The User.

Returns:

The Conversations that are in common.

getGeolocatedConversations

List<XConversationGetInfo> getGeolocatedConversations(double minLatitude,
                                                      double maxLatitude,
                                                      double minLongitude,
                                                      double maxLongitude)

Get all accessible geolocated Conversations.

Parameters:

minLatitude - The minimum latitude.

maxLatitude - The maximum latitude.

minLongitude - The minimum longitude.

maxLongitude - The maximum longitude.

Returns:

The set of Conversations.

getGeolocatedObjects

List<waggle.common.modules.object.infos.XObjectInfo> getGeolocatedObjects(XObjectID conversationID,
                                                                          double minLatitude,
                                                                          double maxLatitude,
                                                                          double minLongitude,
                                                                          double maxLongitude)

Get all geolocated objects in this Conversation.

Parameters:

conversationID - The Conversation.

minLatitude - The minimum latitude.

maxLatitude - The maximum latitude.

minLongitude - The minimum longitude.

maxLongitude - The maximum longitude.

Returns:

The set of Infos.

getConversationMap

XConversationMapInfo getConversationMap(XConversationMapFilterInfo filterInfo)

Get a Conversation map.

Parameters:

filterInfo - The filter.

Returns:

The Conversation map information.

uploadConversationPicture

void uploadConversationPicture(XObjectID conversationID,
                               XAPIInputStream inputStream,
                               String mimeType,
                               long length)

Upload a picture for the specified Conversation.

Parameters:

conversationID - The Conversation.

inputStream - The InputStream containing the picture.

mimeType - The mimetype of the picture.

length - The length of the picture.

uploadConversationPictureToDataUri

String uploadConversationPictureToDataUri(XAPIInputStream inputStream,
                                          String mimeType,
                                          long length)

Convert an image to a scaled image Data URI.

Parameters:

inputStream - The InputStream containing the picture.

mimeType - The mimetype of the picture.

length - The length of the picture.

Returns:

The Data URI.

getOriginalConversationPicture

InputStream getOriginalConversationPicture(XObjectID conversationID)

Get any original Conversation picture.

Parameters:

conversationID - The Conversation.

Returns:

The original picture or null.

getScaledConversationPicture

InputStream getScaledConversationPicture(XObjectID conversationID)

Get any scaled Conversation picture.

Parameters:

conversationID - The Conversation.

Returns:

The scaled picture or null.

deleteConversationPicture

void deleteConversationPicture(XObjectID conversationID)

Delete any Conversation picture.

Parameters:

conversationID - The Conversation.

Skip navigation links