summaryrefslogtreecommitdiffstats
path: root/Documentation/pg-plugin-project-api.txt
blob: 897430c8e778107a55e596f9f24b74bfcc580fb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
= Gerrit Code Review - Project admin customization API

This API is provided by link:pg-plugin-dev.html#plugin-project[plugin.project()]
and provides customization to admin page.

== createCommand
`projectApi.createCommand(title, checkVisibleCallback)`

Create a project command in the admin panel.

.Params
- *title* String title.
- *checkVisibleCallback* function to configure command visibility.

.Returns
- GrProjectApi for chainging.

`checkVisibleCallback(projectName, projectConfig)`

.Params
- *projectName* String project name.
- *projectConfig* Object REST API response for project config.

.Returns
- `false` to hide the command for the specific project.

== onTap
`projectApi.onTap(tapCalback)`

Add a command tap callback.

.Params
- *tapCallback* function that's excuted on command tap.

.Returns
- Nothing