Package org.gitlab4j.api
Class ApplicationsApi
java.lang.Object
org.gitlab4j.api.AbstractApi
org.gitlab4j.api.ApplicationsApi
- All Implemented Interfaces:
Constants
This class implements the client side API for the GitLab Applications API.
See Applications API at GitLab for more information.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants
Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType
-
Field Summary
Fields inherited from class org.gitlab4j.api.AbstractApi
gitLabApi
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
-
Method Summary
Modifier and TypeMethodDescriptioncreateApplication
(String name, String redirectUri, List<Constants.ApplicationScope> scopes) Create an OAUTH Application.createApplication
(String name, String redirectUri, Constants.ApplicationScope[] scopes) Create an OAUTH Application.void
deleteApplication
(Long applicationId) Delete the specified OAUTH Application.Get all OATH applications.getApplications
(int itemsPerPage) Get a Pager of all OAUTH applications.getApplications
(int page, int perPage) Get all OAUTH applications using the specified page and per page settingGet a Stream of all OAUTH Application instances.Methods inherited from class org.gitlab4j.api.AbstractApi
addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate
-
Constructor Details
-
ApplicationsApi
-
-
Method Details
-
getApplications
Get all OATH applications.GitLab Endpoint: GET /api/v4/applications
- Returns:
- a List of OAUTH Application instances
- Throws:
GitLabApiException
- if any exception occurs
-
getApplications
Get all OAUTH applications using the specified page and per page settingGitLab Endpoint: GET /api/v4/applications
- Parameters:
page
- the page to getperPage
- the number of items per page- Returns:
- a list of OAUTH Applications in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getApplications
Get a Pager of all OAUTH applications.GitLab Endpoint: GET /api/v4/applications
- Parameters:
itemsPerPage
- the number of items per page- Returns:
- a Pager of Application instances in the specified range
- Throws:
GitLabApiException
- if any exception occurs
-
getApplicationsStream
Get a Stream of all OAUTH Application instances.GitLab Endpoint: GET /api/v4/applications
- Returns:
- a Stream of OAUTH Application instances
- Throws:
GitLabApiException
- if any exception occurs
-
createApplication
public Application createApplication(String name, String redirectUri, Constants.ApplicationScope[] scopes) throws GitLabApiException Create an OAUTH Application.GitLab Endpoint: POST /api/v4/applications
- Parameters:
name
- the name for the OAUTH ApplicationredirectUri
- the redirect URI for the OAUTH Applicationscopes
- the scopes of the application (api, read_user, sudo, read_repository, openid, profile, email)- Returns:
- the created Application instance
- Throws:
GitLabApiException
- if any exception occurs
-
createApplication
public Application createApplication(String name, String redirectUri, List<Constants.ApplicationScope> scopes) throws GitLabApiException Create an OAUTH Application.GitLab Endpoint: POST /api/v4/applications
- Parameters:
name
- the name for the OAUTH ApplicationredirectUri
- the redirect URI for the OAUTH Applicationscopes
- the scopes of the application (api, read_user, sudo, read_repository, openid, profile, email)- Returns:
- the created Application instance
- Throws:
GitLabApiException
- if any exception occurs
-
deleteApplication
Delete the specified OAUTH Application.GitLab Endpoint: DELETE /api/v4/applications/:applicationId
- Parameters:
applicationId
- the ID of the OUAUTH Application to delete- Throws:
GitLabApiException
- if any exception occurs
-