Package com.google.gerrit.extensions.api.accounts

Interface AccountApi

All Known Implementing Classes:

AccountApi.NotImplemented, AccountApiImpl

public interface AccountApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AccountApi.NotImplemented	A default implementation which allows source compatibility when adding new methods to the interface.

Method Summary

Modifier and Type	Method	Description
void	addEmail(EmailInput input)
SshKeyInfo	addSshKey(String key)
void	deleteEmail(String email)
void	deleteExternalIds(List<String> externalIds)
void	deleteSshKey(int seq)
void	deleteWatchedProjects(List<ProjectWatchInfo> in)
String	generateHttpPassword()	Generate a new HTTP password.
AccountInfo	get()
boolean	getActive()
String	getAvatarUrl(int size)
DiffPreferencesInfo	getDiffPreferences()
EditPreferencesInfo	getEditPreferences()
List<EmailInfo>	getEmails()
List<AccountExternalIdInfo>	getExternalIds()
List<GroupInfo>	getGroups()
GeneralPreferencesInfo	getPreferences()
List<ChangeInfo>	getStarredChanges()
SortedSet<String>	getStars(String changeId)
List<ProjectWatchInfo>	getWatchedProjects()
GpgKeyApi	gpgKey(String id)
void	index()
List<AgreementInfo>	listAgreements()
Map<String,GpgKeyInfo>	listGpgKeys()
List<SshKeyInfo>	listSshKeys()
Map<String,GpgKeyInfo>	putGpgKeys(List<String> add, List<String> remove)
void	setActive(boolean active)
DiffPreferencesInfo	setDiffPreferences(DiffPreferencesInfo in)
EditPreferencesInfo	setEditPreferences(EditPreferencesInfo in)
String	setHttpPassword(String httpPassword)	Set a new HTTP password.
void	setName(String name)
GeneralPreferencesInfo	setPreferences(GeneralPreferencesInfo in)
void	setStars(String changeId, StarsInput input)
void	setStatus(String status)
List<ProjectWatchInfo>	setWatchedProjects(List<ProjectWatchInfo> in)
void	signAgreement(String agreementName)
void	starChange(String changeId)
void	unstarChange(String changeId)

Method Detail

get

AccountInfo get()
         throws RestApiException

Throws:

RestApiException

getActive

boolean getActive()
           throws RestApiException

Throws:

RestApiException

setActive

void setActive(boolean active)
        throws RestApiException

Throws:

RestApiException

getAvatarUrl

String getAvatarUrl(int size)
             throws RestApiException

Throws:

RestApiException

getPreferences

GeneralPreferencesInfo getPreferences()
                               throws RestApiException

Throws:

RestApiException

setPreferences

GeneralPreferencesInfo setPreferences(GeneralPreferencesInfo in)
                               throws RestApiException

Throws:

RestApiException

getDiffPreferences

DiffPreferencesInfo getDiffPreferences()
                                throws RestApiException

Throws:

RestApiException

setDiffPreferences

DiffPreferencesInfo setDiffPreferences(DiffPreferencesInfo in)
                                throws RestApiException

Throws:

RestApiException

getEditPreferences

EditPreferencesInfo getEditPreferences()
                                throws RestApiException

Throws:

RestApiException

setEditPreferences

EditPreferencesInfo setEditPreferences(EditPreferencesInfo in)
                                throws RestApiException

Throws:

RestApiException

getWatchedProjects

List<ProjectWatchInfo> getWatchedProjects()
                                   throws RestApiException

Throws:

RestApiException

setWatchedProjects

List<ProjectWatchInfo> setWatchedProjects(List<ProjectWatchInfo> in)
                                   throws RestApiException

Throws:

RestApiException

deleteWatchedProjects

void deleteWatchedProjects(List<ProjectWatchInfo> in)
                    throws RestApiException

Throws:

RestApiException

starChange

void starChange(String changeId)
         throws RestApiException

Throws:

RestApiException

unstarChange

void unstarChange(String changeId)
           throws RestApiException

Throws:

RestApiException

setStars

void setStars(String changeId,
              StarsInput input)
       throws RestApiException

Throws:

RestApiException

getStars

SortedSet<String> getStars(String changeId)
                    throws RestApiException

Throws:

RestApiException

getStarredChanges

List<ChangeInfo> getStarredChanges()
                            throws RestApiException

Throws:

RestApiException

getGroups

List<GroupInfo> getGroups()
                   throws RestApiException

Throws:

RestApiException

getEmails

List<EmailInfo> getEmails()
                   throws RestApiException

Throws:

RestApiException

addEmail

void addEmail(EmailInput input)
       throws RestApiException

Throws:

RestApiException

deleteEmail

void deleteEmail(String email)
          throws RestApiException

Throws:

RestApiException

setStatus

void setStatus(String status)
        throws RestApiException

Throws:

RestApiException

listSshKeys

List<SshKeyInfo> listSshKeys()
                      throws RestApiException

Throws:

RestApiException

addSshKey

SshKeyInfo addSshKey(String key)
              throws RestApiException

Throws:

RestApiException

deleteSshKey

void deleteSshKey(int seq)
           throws RestApiException

Throws:

RestApiException

listGpgKeys

Map<String,GpgKeyInfo> listGpgKeys()
                                  throws RestApiException

Throws:

RestApiException

putGpgKeys

Map<String,GpgKeyInfo> putGpgKeys(List<String> add,
                                        List<String> remove)
                                 throws RestApiException

Throws:

RestApiException

gpgKey

GpgKeyApi gpgKey(String id)
          throws RestApiException

Throws:

RestApiException

listAgreements

List<AgreementInfo> listAgreements()
                            throws RestApiException

Throws:

RestApiException

signAgreement

void signAgreement(String agreementName)
            throws RestApiException

Throws:

RestApiException

index

void index()
    throws RestApiException

Throws:

RestApiException

getExternalIds

List<AccountExternalIdInfo> getExternalIds()
                                    throws RestApiException

Throws:

RestApiException

deleteExternalIds

void deleteExternalIds(List<String> externalIds)
                throws RestApiException

Throws:

RestApiException

setName

void setName(String name)
      throws RestApiException

Throws:

RestApiException

generateHttpPassword

String generateHttpPassword()
                     throws RestApiException

Generate a new HTTP password.

Returns:

the generated password.

Throws:

RestApiException

setHttpPassword

String setHttpPassword(String httpPassword)
                throws RestApiException

Set a new HTTP password.

May only be invoked by administrators.

Parameters:

httpPassword - the new password, null to remove the password.

Returns:

the new password, null if the password was removed.

Throws:

RestApiException