UiAction (Gerrit Review Plugin API Documentation)

All Superinterfaces:

RestView<R>

All Known Implementing Classes:

Abandon, CherryPick, DeleteChange, DeletePrivateByPost, GarbageCollect, Move, PostHashtags, PostPrivate, PutDescription, PutTopic, Rebase, RebaseChain, Restore, Revert, RevertSubmission, SetReadyForReview, SetWorkInProgress, Submit
```
public interface UiAction<R extends RestResource>
extends RestView<R>
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class UiAction.Description
Describes an action invokable through the web interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UiAction.Description`	`getDescription(R resource)`	Get the description of the action customized for the resource.

- Method Detail
  - getDescription
```
UiAction.Description getDescription(R resource)
                             throws Exception
```
    Get the description of the action customized for the resource.
    
    Parameters:
    
    resource - the resource the view would act upon if the action is invoked by the client. Information from the resource can be used to customize the description.
    
    Returns:
    
    a description of the action. The server will populate the id and method properties. If null the action will assumed unavailable and not presented. This is usually the same as setVisible(false).
    
    Throws:
    
    Exception