co.ecg.alpaca.toolkit.generated.services

Class UserCollaborate

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.model.BroadWorksService

co.ecg.alpaca.toolkit.model.BroadWorksUserService

co.ecg.alpaca.toolkit.generated.services.UserCollaborate

All Implemented Interfaces:

Serializable

public class UserCollaborate
extends BroadWorksUserService

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserCollaborate.UserCollaborateBridgeGetRequest AlpacaLibrary Auto-Generated Java File Request the collaborate bridged assigned to the user.
static class	UserCollaborate.UserCollaborateBridgeGetResponse AlpacaLibrary Auto-Generated Java File The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate supportOutdial setting is disabled.
static class	UserCollaborate.UserCollaborateDeleteRoomRequest AlpacaLibrary Auto-Generated Java File Request to delete a collaborate room.
static class	UserCollaborate.UserCollaborateInstantRoomAddRequest AlpacaLibrary Auto-Generated Java File Request to add collaborate instant room.
static class	UserCollaborate.UserCollaborateInstantRoomAddResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateInstantRoomAddRequest.
static class	UserCollaborate.UserCollaborateInstantRoomGetRequest AlpacaLibrary Auto-Generated Java File Request the collaborate room settings for an instant room.
static class	UserCollaborate.UserCollaborateInstantRoomGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateInstantRoomGetRequest.
static class	UserCollaborate.UserCollaborateInstantRoomParametersGetRequest AlpacaLibrary Auto-Generated Java File Request collaborate instant room settings.
static class	UserCollaborate.UserCollaborateInstantRoomParametersGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateInstantRoomParametersGetRequest.
static class	UserCollaborate.UserCollaborateInstantRoomParametersModifyRequest AlpacaLibrary Auto-Generated Java File Request to modify collaborate instant room settings.
static class	UserCollaborate.UserCollaborateMyRoomGetRequest AlpacaLibrary Auto-Generated Java File Request collaborate room settings for MyRoom.
static class	UserCollaborate.UserCollaborateMyRoomGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateMyRoomGetRequest.
static class	UserCollaborate.UserCollaborateMyRoomModifyRequest AlpacaLibrary Auto-Generated Java File Request to modify collaborate room settings for MyRoom.
static class	UserCollaborate.UserCollaborateProjectRoomAddRequest AlpacaLibrary Auto-Generated Java File Request to add collaborate project room.
static class	UserCollaborate.UserCollaborateProjectRoomAddResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateProjectRoomAddRequest.
static class	UserCollaborate.UserCollaborateProjectRoomGetRequest AlpacaLibrary Auto-Generated Java File Request collaborate room settings for a project room.
static class	UserCollaborate.UserCollaborateProjectRoomGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateProjectRoomGetRequest.
static class	UserCollaborate.UserCollaborateProjectRoomModifyRequest AlpacaLibrary Auto-Generated Java File Request to modify collaborate room settings for a project room.
static class	UserCollaborate.UserCollaborateRoomGetRequest AlpacaLibrary Auto-Generated Java File Request to get the settings for My Room, Instant Room or Project Room.
static class	UserCollaborate.UserCollaborateRoomGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateRoomGetRequest.
static class	UserCollaborate.UserCollaborateRoomIDRegenerateRequest AlpacaLibrary Auto-Generated Java File Request to regenerate collaborate room id for MyRoom and project room.
static class	UserCollaborate.UserCollaborateRoomIDRegenerateResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateRoomIDRegenerateRequest.
static class	UserCollaborate.UserCollaborateRoomListGetRequest AlpacaLibrary Auto-Generated Java File Request the list of collaborate room instances for this specific user.
static class	UserCollaborate.UserCollaborateRoomListGetResponse AlpacaLibrary Auto-Generated Java File Response to UserCollaborateRoomListGetRequest.
static class	UserCollaborate.UserCollaborateRoomModifyRequest AlpacaLibrary Auto-Generated Java File Request to modify room settings for a specific Project Room or My Room.

Field Summary

Fields

Modifier and Type	Field and Description
UserCollaborate.UserCollaborateBridgeGetResponse	collaborateBridge
UserCollaborate.UserCollaborateInstantRoomParametersGetResponse	collaborateInstantRoomParameters
List<UserCollaborate.UserCollaborateRoomGetResponse>	collaborateRoom
UserCollaborate.UserCollaborateRoomListGetResponse	collaborateRoomList
static ServiceTag<UserCollaborate>	tag

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUserService

user

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksService

outstandingRequests

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

broadWorksServer, populated

Constructor Summary

Constructors

Constructor and Description
UserCollaborate() The serializable constructor for the UserService
UserCollaborate(User user) Returns a UserService Object with the User Assigned

Method Summary

Modifier and Type	Method and Description
String	getClassName()
UserCollaborate.UserCollaborateBridgeGetResponse	getCollaborateBridge() The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate supportOutdial setting is disabled.
UserCollaborate.UserCollaborateInstantRoomParametersGetResponse	getCollaborateInstantRoomParameters() Response to UserCollaborateInstantRoomParametersGetRequest.
List<UserCollaborate.UserCollaborateRoomGetResponse>	getCollaborateRoom() Response to UserCollaborateRoomGetRequest.
UserCollaborate.UserCollaborateRoomListGetResponse	getCollaborateRoomList() Response to UserCollaborateRoomListGetRequest.
DefaultResponse	populate() Populates all available service data
void	push(User user) Adds all available service data to a User

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksService

isPrimary, setPrimary, waitForLoad

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tag

public static final ServiceTag<UserCollaborate> tag

collaborateBridge

public UserCollaborate.UserCollaborateBridgeGetResponse collaborateBridge

collaborateInstantRoomParameters

public UserCollaborate.UserCollaborateInstantRoomParametersGetResponse collaborateInstantRoomParameters

collaborateRoomList

public UserCollaborate.UserCollaborateRoomListGetResponse collaborateRoomList

collaborateRoom

public List<UserCollaborate.UserCollaborateRoomGetResponse> collaborateRoom

Constructor Detail

UserCollaborate

@GwtIncompatible
public UserCollaborate(User user)

Returns a UserService Object with the User Assigned

Parameters:

user -

UserCollaborate

public UserCollaborate()

The serializable constructor for the UserService

Method Detail

getClassName

public String getClassName()

getCollaborateBridge

@GwtIncompatible
public UserCollaborate.UserCollaborateBridgeGetResponse getCollaborateBridge()

The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate supportOutdial setting is disabled. Response to UserCollaborateBridgeGetRequest.

Returns:

the UserCollaborateBridgeGetResponse for this service

getCollaborateInstantRoomParameters

@GwtIncompatible
public UserCollaborate.UserCollaborateInstantRoomParametersGetResponse getCollaborateInstantRoomParameters()

Response to UserCollaborateInstantRoomParametersGetRequest.

Returns:

the UserCollaborateInstantRoomParametersGetResponse for this service

getCollaborateRoomList

@GwtIncompatible
public UserCollaborate.UserCollaborateRoomListGetResponse getCollaborateRoomList()

Response to UserCollaborateRoomListGetRequest. Contains a table with column headings : "Room Type", "Name", "Room Id", in a row for each collaborate room instance. Possible values for Room Type column are MyRoom, Project Room and Instant Room.

Returns:

the UserCollaborateRoomListGetResponse for this service

getCollaborateRoom

@GwtIncompatible
public List<UserCollaborate.UserCollaborateRoomGetResponse> getCollaborateRoom()

Response to UserCollaborateRoomGetRequest. The roomType and roomName parameters are returned for all rooms. The following parameters are returned for My room and Project Room: attendeeNotification, endCollaborateRoomSessionOnOwnerExit and ownerRequired. In addition, the roomSchedule is returned for Project Room and the instantRoomStartTime and instantRoomEndTime are returned for Instant Room.

Returns:

the UserCollaborateRoomGetResponse for this service

populate

@GwtIncompatible
public DefaultResponse populate()

Populates all available service data

Specified by:

populate in class BroadWorksObject

push

@GwtIncompatible
public void push(User user)

Adds all available service data to a User

Specified by:

push in class BroadWorksUserService