Class PackageClient

Inheritance

System.Object

PackageClient

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dangl.GiteaOrgManager.Client

Assembly: Dangl.GiteaOrgManager.dll

Syntax

public class PackageClient

Constructors

PackageClient(String, HttpClient)

Declaration

public PackageClient(string baseUrl, HttpClient httpClient)

Parameters

Type	Name	Description
System.String	baseUrl
System.Net.Http.HttpClient	httpClient

Properties

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

JsonSerializerSettings

Declaration

protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

DeletePackageAsync(String, String, String, String)

Delete a package

Declaration

public virtual Task DeletePackageAsync(string owner, string type, string name, string version)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package

Returns

Type	Description
System.Threading.Tasks.Task	APIEmpty is an empty response

Exceptions

Type	Condition
ApiException	A server side error occurred.

DeletePackageAsync(String, String, String, String, CancellationToken)

Delete a package

Declaration

public virtual async Task DeletePackageAsync(string owner, string type, string name, string version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task	APIEmpty is an empty response

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetPackageAsync(String, String, String, String)

Gets a package

Declaration

public virtual Task<Package> GetPackageAsync(string owner, string type, string name, string version)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package

Returns

Type	Description
System.Threading.Tasks.Task<Package>	Package

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetPackageAsync(String, String, String, String, CancellationToken)

Gets a package

Declaration

public virtual async Task<Package> GetPackageAsync(string owner, string type, string name, string version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<Package>	Package

Exceptions

Type	Condition
ApiException	A server side error occurred.

ListPackageFilesAsync(String, String, String, String)

Gets all files of a package

Declaration

public virtual Task<ICollection<PackageFile>> ListPackageFilesAsync(string owner, string type, string name, string version)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PackageFile>>	PackageFileList

Exceptions

Type	Condition
ApiException	A server side error occurred.

ListPackageFilesAsync(String, String, String, String, CancellationToken)

Gets all files of a package

Declaration

public virtual async Task<ICollection<PackageFile>> ListPackageFilesAsync(string owner, string type, string name, string version, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the package
System.String	type	type of the package
System.String	name	name of the package
System.String	version	version of the package
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PackageFile>>	PackageFileList

Exceptions

Type	Condition
ApiException	A server side error occurred.

ListPackagesAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Type>, String)

Gets all packages of an owner

Declaration

public virtual Task<ICollection<Package>> ListPackagesAsync(string owner, int? page, int? limit, Type? type, string q)

Parameters

Type	Name	Description
System.String	owner	owner of the packages
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
System.Nullable<Type>	type	package type filter
System.String	q	name filter

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Package>>	PackageList

Exceptions

Type	Condition
ApiException	A server side error occurred.

ListPackagesAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Type>, String, CancellationToken)

Gets all packages of an owner

Declaration

public virtual async Task<ICollection<Package>> ListPackagesAsync(string owner, int? page, int? limit, Type? type, string q, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the packages
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
System.Nullable<Type>	type	package type filter
System.String	q	name filter
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Package>>	PackageList

Exceptions

Type	Condition
ApiException	A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)

Declaration

protected virtual async Task<PackageClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<PackageClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T