Package jetbrains.buildServer.serverProxy

Interface UserSummaryRemoteManager

All Known Implementing Classes:

RemoteStatusManager

public interface UserSummaryRemoteManager

Provides team city summary for specified user.

Field Summary

Fields

Modifier and Type	Field	Description
static String	HANDLER

Method Summary

Modifier and Type	Method	Description
byte[]	getFilteredGZippedSummaryByBuildTypes(String userId, Vector buildTypeIds)	Returns gzipped TeamCity summary for the specified user filtered by suitable configurations.
byte[]	getFilteredGZippedSummaryByVcsUris(String userId, Vector vcsUris)	Returns gzipped TeamCity summary for the specified user filtered by suitable configurations.
byte[]	getGZippedSummary(String userId)	Returns gzipped TeamCity summary for the specified user.
Vector	getRunningBuildsStatus()	XML represents all currently running build status XML is like this:
int	getTotalNumberOfEvents(String serializedSubscription)	Returns total number of events corresponding to the specified subscription and currently logged in user.
Vector	getWatchedRunningBuildsStatus(String userId, boolean filterBySuitableConfigurations, Vector samplePaths)	XML represents all currently running build status filtered by user watched configurations and suitable configurations if needed XML is like this:

Field Detail

HANDLER

static final String HANDLER

See Also:

Constant Field Values

Method Detail

getGZippedSummary

byte[] getGZippedSummary(String userId)

Returns gzipped TeamCity summary for the specified user.

Parameters:

userId - user id to create summary for

Returns:

serialized with XStream object of class TeamServerSummaryData

Since:

6.5

getFilteredGZippedSummaryByVcsUris

byte[] getFilteredGZippedSummaryByVcsUris(String userId,
                                          Vector vcsUris)

Returns gzipped TeamCity summary for the specified user filtered by suitable configurations.

Parameters:

userId - user id to create summary for

vcsUris - vcs uris to get suitable configurations

Returns:

serialized with XStream object of class TeamServerSummaryData

Since:

6.5

getFilteredGZippedSummaryByBuildTypes

byte[] getFilteredGZippedSummaryByBuildTypes(String userId,
                                             Vector buildTypeIds)

Returns gzipped TeamCity summary for the specified user filtered by suitable configurations. Used in VS addin.

Parameters:

userId - user id to create summary for

buildTypeIds - suitable configuration ids

Returns:

serialized with XStream object of class TeamServerSummaryData

Since:

6.5

getTotalNumberOfEvents

int getTotalNumberOfEvents(@NotNull
                           String serializedSubscription)

Returns total number of events corresponding to the specified subscription and currently logged in user.

Parameters:

serializedSubscription - serialized subscription collection SubscriptionsCollection

Returns:

total number of events

getRunningBuildsStatus

Vector getRunningBuildsStatus()

XML represents all currently running build status XML is like this:

Returns:

list of xmls with running build status info list.

getWatchedRunningBuildsStatus

Vector getWatchedRunningBuildsStatus(@NotNull
                                     String userId,
                                     boolean filterBySuitableConfigurations,
                                     @NotNull
                                     Vector samplePaths)

XML represents all currently running build status filtered by user watched configurations and suitable configurations if needed XML is like this:

Parameters:

userId - user id

filterBySuitableConfigurations - true for filtering by suitable configurations

samplePaths - sample paths to get suitable configurations

Returns:

list of xmls with running build status info list.

Since:

6.5