Class SettingsClient

Inheritance

System.Object

SettingsClient

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 SettingsClient

Constructors

| Improve this Doc View Source

SettingsClient(String, HttpClient)

Declaration

public SettingsClient(string baseUrl, HttpClient httpClient)

Parameters

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

Properties

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

| Improve this Doc View Source

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

GetGeneralAPISettingsAsync()

Get instance's global settings for api

Declaration

public virtual Task<GeneralAPISettings> GetGeneralAPISettingsAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralAPISettingsAsync(CancellationToken)

Get instance's global settings for api

Declaration

public virtual async Task<GeneralAPISettings> GetGeneralAPISettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
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<GeneralAPISettings>	GeneralAPISettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralAttachmentSettingsAsync()

Get instance's global settings for Attachment

Declaration

public virtual Task<GeneralAttachmentSettings> GetGeneralAttachmentSettingsAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralAttachmentSettingsAsync(CancellationToken)

Get instance's global settings for Attachment

Declaration

public virtual async Task<GeneralAttachmentSettings> GetGeneralAttachmentSettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
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<GeneralAttachmentSettings>	GeneralAttachmentSettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralRepositorySettingsAsync()

Get instance's global settings for repositories

Declaration

public virtual Task<GeneralRepoSettings> GetGeneralRepositorySettingsAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralRepositorySettingsAsync(CancellationToken)

Get instance's global settings for repositories

Declaration

public virtual async Task<GeneralRepoSettings> GetGeneralRepositorySettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
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<GeneralRepoSettings>	GeneralRepoSettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralUISettingsAsync()

Get instance's global settings for ui

Declaration

public virtual Task<GeneralUISettings> GetGeneralUISettingsAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetGeneralUISettingsAsync(CancellationToken)

Get instance's global settings for ui

Declaration

public virtual async Task<GeneralUISettings> GetGeneralUISettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
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<GeneralUISettings>	GeneralUISettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

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

Declaration

protected virtual async Task<SettingsClient.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<SettingsClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T