Package org.gitlab4j.api

Class WikisApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.WikisApi

All Implemented Interfaces:

Constants

public class WikisApi
extends AbstractApi

Since:

v4.8.21 2018-06-5 1:26 AM IST

Author:

shuklaalok7 ([email protected])

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
WikisApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
WikiPage	createPage(Integer projectId, String title, String content)	Creates a new project wiki page.
void	deletePage(Integer projectId, String slug)	Deletes an existing project wiki page.
Optional<WikiPage>	getOptionalPage(Integer projectId, String slug)	Get a single page of project wiki as an Optional instance.
WikiPage	getPage(Integer projectId, String slug)	Get a single page of project wiki.
List<WikiPage>	getPages(Integer projectId)	Get a list of pages in project wiki.
Pager<WikiPage>	getPages(Integer projectId, int itemsPerPage)	Get a Pager of project's wiki pages.
List<WikiPage>	getPages(Integer projectId, int page, int perPage)	Get a list of project snippets.
WikiPage	updatePage(Integer projectId, String slug, String title, String content)	Updates an existing project wiki page.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getGroupIdOrPath, getPageQueryParams, getProjectIdOrPath, getWithAccepts, handle, head, isApiVersion, post, post, post, post, post, put, put, putWithFormData, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WikisApi

public WikisApi(GitLabApi gitLabApi)

Method Detail

getPages

public List<WikiPage> getPages(Integer projectId)
                        throws GitLabApiException

Get a list of pages in project wiki. This only returns the first page of wiki-pages. GET /projects/:id/wikis

Parameters:

projectId - the project ID to get the wiki-pages for

Returns:

a list of pages in the project's wiki

Throws:

GitLabApiException - if any exception occurs

getPages

public List<WikiPage> getPages(Integer projectId,
                               int page,
                               int perPage)
                        throws GitLabApiException

Get a list of project snippets. This only returns the first page of snippets. GET /projects/:id/wikis

Parameters:

projectId - the project ID to get the wiki pages for

page - the page to get

perPage - the number of wiki-pages per page

Returns:

a list of pages in project's wiki for the specified range

Throws:

GitLabApiException - if any exception occurs

getPages

public Pager<WikiPage> getPages(Integer projectId,
                                int itemsPerPage)
                         throws GitLabApiException

Get a Pager of project's wiki pages. GET /projects/:id/wikis

Parameters:

projectId - the project ID to get the wiki-pages for

itemsPerPage - the number of wiki-pages per page

Returns:

the Pager of wiki-pages

Throws:

GitLabApiException - if any exception occurs

getPage

public WikiPage getPage(Integer projectId,
                        String slug)
                 throws GitLabApiException

Get a single page of project wiki. GET /projects/:id/wikis/:slug

Parameters:

projectId - the project ID to get the wiki page for

slug - the slug of the project's wiki page

Returns:

the specified project Snippet

Throws:

GitLabApiException - if any exception occurs

getOptionalPage

public Optional<WikiPage> getOptionalPage(Integer projectId,
                                          String slug)

Get a single page of project wiki as an Optional instance. GET /projects/:id/wikis/:slug

Parameters:

projectId - the project ID to get the snippet for

slug - the slug of the project's wiki page

Returns:

the specified project Snippet as an Optional instance

createPage

public WikiPage createPage(Integer projectId,
                           String title,
                           String content)
                    throws GitLabApiException

Creates a new project wiki page. The user must have permission to create new wiki page. POST /projects/:id/wikis

Parameters:

projectId - the ID of the project owned by the authenticated user, required

title - the title of a snippet, required

content - the content of a wiki page, required

Returns:

a WikiPage instance with info on the created page

Throws:

GitLabApiException - if any exception occurs

updatePage

public WikiPage updatePage(Integer projectId,
                           String slug,
                           String title,
                           String content)
                    throws GitLabApiException

Updates an existing project wiki page. The user must have permission to change an existing wiki page. PUT /projects/:id/wikis/:slug

Parameters:

projectId - the ID of the project owned by the authenticated user, required

slug - the slug of the project's wiki page, required

title - the title of a snippet, optional

content - the content of a page, optional. Either title or content must be supplied.

Returns:

a WikiPage instance with info on the updated page

Throws:

GitLabApiException - if any exception occurs

deletePage

public void deletePage(Integer projectId,
                       String slug)
                throws GitLabApiException

Deletes an existing project wiki page. This is an idempotent function and deleting a non-existent page does not cause an error. DELETE /projects/:id/wikis/:slug

Parameters:

projectId - the project ID

slug - the slug of the project's wiki page

Throws:

GitLabApiException - if any exception occurs