Package com.google.gerrit.extensions.api.changes

Interface ChangeMessageApi

All Known Implementing Classes:

ChangeMessageApi.NotImplemented

public interface ChangeMessageApi

Interface for change message APIs.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ChangeMessageInfo	delete(DeleteChangeMessageInput input)	Deletes a change message by replacing its message.
ChangeMessageInfo	get()	Gets one change message.

Method Details

get

ChangeMessageInfo get()
               throws RestApiException

Gets one change message.

Throws:

RestApiException

delete

ChangeMessageInfo delete(DeleteChangeMessageInput input)
                  throws RestApiException

Deletes a change message by replacing its message. For NoteDb, it's implemented by rewriting the commit history of change meta branch.

Returns:

the change message with its message updated.

Throws:

RestApiException