ProjectsApi (DataHubClient) | DataHubClient

DataHubClient

ProjectsApi Type

Namespace: DataHubClient
Assembly: DataHubClient.dll
Base Type: obj

Client for the GitLab Projects API used by DataHubs. See the .

Constructors

Constructor	Description
`ProjectsApi(baseUrl, auth, http)` Full Usage: `ProjectsApi(baseUrl, auth, http)` Parameters: baseUrl : `string` auth : `Authentication` http : `IHttpClient` Returns: `ProjectsApi`	baseUrl : `string` auth : `Authentication` http : `IHttpClient` Returns: `ProjectsApi`

Instance members

Instance member	Description
`this.GetAsync` Full Usage: `this.GetAsync` Parameters: projectId : `int` - The project identifier. Returns: `Async<Project>`	Gets a project by numeric project identifier. projectId : `int` The project identifier. Returns: `Async<Project>`
`this.ListAllAsync` Full Usage: `this.ListAllAsync` Parameters: ?search : `string` - Optional search term used to filter projects. ?simple : `bool` - Whether GitLab should return the compact project representation. ?visibility : `string` - Optional visibility filter: `public`, `internal`, or `private`. Returns: `Async<ResizeArray<Project>>` All matching projects in ascending ID order.	Lists every visible project in ascending ID order using keyset pagination. Anonymous requests return only public projects. This method continues until an empty page and fails if the server returns non-increasing IDs or any page fails. ?search : `string` Optional search term used to filter projects. ?simple : `bool` Whether GitLab should return the compact project representation. ?visibility : `string` Optional visibility filter: `public`, `internal`, or `private`. Returns: `Async<ResizeArray<Project>>` All matching projects in ascending ID order.
`this.ListAsync` Full Usage: `this.ListAsync` Parameters: ?search : `string` - Optional search term used to filter projects. ?simple : `bool` - Whether GitLab should return the compact project representation. Returns: `Async<ResizeArray<Project>>`	Lists one page of visible projects. Use `ListAllAsync` to retrieve every page. ?search : `string` Optional search term used to filter projects. ?simple : `bool` Whether GitLab should return the compact project representation. Returns: `Async<ResizeArray<Project>>`
`this.SearchAsync` Full Usage: `this.SearchAsync` Parameters: search : `string` - The search term used to filter projects. Returns: `Async<ResizeArray<Project>>`	Searches projects visible to the authenticated user. search : `string` The search term used to filter projects. Returns: `Async<ResizeArray<Project>>`