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

Interface AccountApi

public interface AccountApi

Method Summary

Modifier and Type	Method	Description
void	addEmail(EmailInput input)
SshKeyInfo	addSshKey(String key)
EmailApi	createEmail(EmailInput emailInput)
void	delete()
List<DeletedDraftCommentInfo>	deleteDraftComments(DeleteDraftCommentsInput input)
void	deleteEmail(String email)
void	deleteExternalIds(List<String> externalIds)
void	deleteSshKey(int seq)
void	deleteWatchedProjects(List<ProjectWatchInfo> in)
AccountDetailInfo	detail()
EmailApi	email(String email)
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<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)
void	setDisplayName(String displayName)
EditPreferencesInfo	setEditPreferences(EditPreferencesInfo in)
String	setHttpPassword(String httpPassword)	Set a new HTTP password.
void	setName(String name)
GeneralPreferencesInfo	setPreferences(GeneralPreferencesInfo in)
void	setStatus(String status)
List<ProjectWatchInfo>	setWatchedProjects(List<ProjectWatchInfo> in)
void	signAgreement(String agreementName)
void	starChange(String changeId)
AccountStateInfo	state()
void	unstarChange(String changeId)

Method Details

get

AccountInfo get()
         throws RestApiException

Throws:

RestApiException

detail

AccountDetailInfo detail()
                  throws RestApiException

Throws:

RestApiException

state

AccountStateInfo state()
                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

@CanIgnoreReturnValue
GeneralPreferencesInfo setPreferences(GeneralPreferencesInfo in)
                               throws RestApiException

Throws:

RestApiException

getDiffPreferences

DiffPreferencesInfo getDiffPreferences()
                                throws RestApiException

Throws:

RestApiException

setDiffPreferences

@CanIgnoreReturnValue
DiffPreferencesInfo setDiffPreferences(DiffPreferencesInfo in)
                                throws RestApiException

Throws:

RestApiException

getEditPreferences

EditPreferencesInfo getEditPreferences()
                                throws RestApiException

Throws:

RestApiException

setEditPreferences

@CanIgnoreReturnValue
EditPreferencesInfo setEditPreferences(EditPreferencesInfo in)
                                throws RestApiException

Throws:

RestApiException

getWatchedProjects

List<ProjectWatchInfo> getWatchedProjects()
                                   throws RestApiException

Throws:

RestApiException

setWatchedProjects

@CanIgnoreReturnValue
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

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

createEmail

@CanIgnoreReturnValue
EmailApi createEmail(EmailInput emailInput)
              throws RestApiException

Throws:

RestApiException

email

EmailApi email(String email)
        throws RestApiException

Throws:

RestApiException

setStatus

void setStatus(String status)
        throws RestApiException

Throws:

RestApiException

setDisplayName

void setDisplayName(String displayName)
             throws RestApiException

Throws:

RestApiException

listSshKeys

List<SshKeyInfo> listSshKeys()
                      throws RestApiException

Throws:

RestApiException

addSshKey

@CanIgnoreReturnValue
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

@CanIgnoreReturnValue
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

deleteDraftComments

@CanIgnoreReturnValue
List<DeletedDraftCommentInfo> deleteDraftComments(DeleteDraftCommentsInput input)
                                           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

@CanIgnoreReturnValue
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

delete

void delete()
     throws RestApiException

Throws:

RestApiException