Class UserClient

Inheritance

System.Object

UserClient

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 UserClient

Constructors

| Improve this Doc View Source

UserClient(String, HttpClient)

Declaration

public UserClient(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

GetUserSettingsAsync()

Get user settings

Declaration

public virtual Task<ICollection<UserSettings>> GetUserSettingsAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetUserSettingsAsync(CancellationToken)

Get user settings

Declaration

public virtual async Task<ICollection<UserSettings>> GetUserSettingsAsync(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<System.Collections.Generic.ICollection<UserSettings>>	UserSettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVerificationTokenAsync()

Get a Token to verify

Declaration

public virtual Task<string> GetVerificationTokenAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	APIString is a string response

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetVerificationTokenAsync(CancellationToken)

Get a Token to verify

Declaration

public virtual async Task<string> GetVerificationTokenAsync(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<System.String>	APIString is a string response

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<UserClient.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<UserClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

| Improve this Doc View Source

UpdateUserSettingsAsync(UserSettingsOptions)

Update user settings

Declaration

public virtual Task<ICollection<UserSettings>> UpdateUserSettingsAsync(UserSettingsOptions body)

Parameters

Type	Name	Description
UserSettingsOptions	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UpdateUserSettingsAsync(UserSettingsOptions, CancellationToken)

Update user settings

Declaration

public virtual async Task<ICollection<UserSettings>> UpdateUserSettingsAsync(UserSettingsOptions body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UserSettingsOptions	body
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<UserSettings>>	UserSettings

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserAddEmailAsync(CreateEmailOption)

Add email addresses

Declaration

public virtual Task<ICollection<Email>> UserAddEmailAsync(CreateEmailOption body)

Parameters

Type	Name	Description
CreateEmailOption	body

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Email>>	EmailList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserAddEmailAsync(CreateEmailOption, CancellationToken)

Add email addresses

Declaration

public virtual async Task<ICollection<Email>> UserAddEmailAsync(CreateEmailOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateEmailOption	body
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<Email>>	EmailList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCheckFollowingAsync(String, String)

Check if one user is following another user

Declaration

public virtual Task UserCheckFollowingAsync(string username, string target)

Parameters

Type	Name	Description
System.String	username	username of following user
System.String	target	username of followed user

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCheckFollowingAsync(String, String, CancellationToken)

Check if one user is following another user

Declaration

public virtual async Task UserCheckFollowingAsync(string username, string target, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of following user
System.String	target	username of followed user
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.

| Improve this Doc View Source

UserCreateHookAsync(CreateHookOption)

Create a hook

Declaration

public virtual Task<Hook> UserCreateHookAsync(CreateHookOption body)

Parameters

Type	Name	Description
CreateHookOption	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCreateHookAsync(CreateHookOption, CancellationToken)

Create a hook

Declaration

public virtual async Task<Hook> UserCreateHookAsync(CreateHookOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateHookOption	body
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<Hook>	Hook

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCreateOAuth2ApplicationAsync(CreateOAuth2ApplicationOptions)

creates a new OAuth2 application

Declaration

public virtual Task<OAuth2Application> UserCreateOAuth2ApplicationAsync(CreateOAuth2ApplicationOptions body)

Parameters

Type	Name	Description
CreateOAuth2ApplicationOptions	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCreateOAuth2ApplicationAsync(CreateOAuth2ApplicationOptions, CancellationToken)

creates a new OAuth2 application

Declaration

public virtual async Task<OAuth2Application> UserCreateOAuth2ApplicationAsync(CreateOAuth2ApplicationOptions body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateOAuth2ApplicationOptions	body
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<OAuth2Application>	OAuth2Application

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCreateTokenAsync(String, CreateAccessTokenOption)

Create an access token

Declaration

public virtual Task<AccessToken> UserCreateTokenAsync(string username, CreateAccessTokenOption body)

Parameters

Type	Name	Description
System.String	username	username of user
CreateAccessTokenOption	body

Returns

Type	Description
System.Threading.Tasks.Task<AccessToken>	AccessToken represents an API access token.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCreateTokenAsync(String, CreateAccessTokenOption, CancellationToken)

Create an access token

Declaration

public virtual async Task<AccessToken> UserCreateTokenAsync(string username, CreateAccessTokenOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
CreateAccessTokenOption	body
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<AccessToken>	AccessToken represents an API access token.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentCheckFollowingAsync(String)

Check whether a user is followed by the authenticated user

Declaration

public virtual Task UserCurrentCheckFollowingAsync(string username)

Parameters

Type	Name	Description
System.String	username	username of followed user

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentCheckFollowingAsync(String, CancellationToken)

Check whether a user is followed by the authenticated user

Declaration

public virtual async Task UserCurrentCheckFollowingAsync(string username, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of followed user
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.

| Improve this Doc View Source

UserCurrentCheckStarringAsync(String, String)

Whether the authenticated is starring the repo

Declaration

public virtual Task UserCurrentCheckStarringAsync(string owner, string repo)

Parameters

Type	Name	Description
System.String	owner	owner of the repo
System.String	repo	name of the repo

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentCheckStarringAsync(String, String, CancellationToken)

Whether the authenticated is starring the repo

Declaration

public virtual async Task UserCurrentCheckStarringAsync(string owner, string repo, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the repo
System.String	repo	name of the repo
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.

| Improve this Doc View Source

UserCurrentDeleteFollowAsync(String)

Unfollow a user

Declaration

public virtual Task UserCurrentDeleteFollowAsync(string username)

Parameters

Type	Name	Description
System.String	username	username of user to unfollow

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentDeleteFollowAsync(String, CancellationToken)

Unfollow a user

Declaration

public virtual async Task UserCurrentDeleteFollowAsync(string username, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user to unfollow
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.

| Improve this Doc View Source

UserCurrentDeleteGPGKeyAsync(Int64)

Remove a GPG key

Declaration

public virtual Task UserCurrentDeleteGPGKeyAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of key to delete

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentDeleteGPGKeyAsync(Int64, CancellationToken)

Remove a GPG key

Declaration

public virtual async Task UserCurrentDeleteGPGKeyAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of key to delete
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.

| Improve this Doc View Source

UserCurrentDeleteKeyAsync(Int64)

Delete a public key

Declaration

public virtual Task UserCurrentDeleteKeyAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of key to delete

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentDeleteKeyAsync(Int64, CancellationToken)

Delete a public key

Declaration

public virtual async Task UserCurrentDeleteKeyAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of key to delete
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.

| Improve this Doc View Source

UserCurrentDeleteStarAsync(String, String)

Unstar the given repo

Declaration

public virtual Task UserCurrentDeleteStarAsync(string owner, string repo)

Parameters

Type	Name	Description
System.String	owner	owner of the repo to unstar
System.String	repo	name of the repo to unstar

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentDeleteStarAsync(String, String, CancellationToken)

Unstar the given repo

Declaration

public virtual async Task UserCurrentDeleteStarAsync(string owner, string repo, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the repo to unstar
System.String	repo	name of the repo to unstar
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.

| Improve this Doc View Source

UserCurrentGetGPGKeyAsync(Int64)

Get a GPG key

Declaration

public virtual Task<GPGKey> UserCurrentGetGPGKeyAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of key to get

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentGetGPGKeyAsync(Int64, CancellationToken)

Get a GPG key

Declaration

public virtual async Task<GPGKey> UserCurrentGetGPGKeyAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of key to get
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<GPGKey>	GPGKey

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentGetKeyAsync(Int64)

Get a public key

Declaration

public virtual Task<PublicKey> UserCurrentGetKeyAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of key to get

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentGetKeyAsync(Int64, CancellationToken)

Get a public key

Declaration

public virtual async Task<PublicKey> UserCurrentGetKeyAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of key to get
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<PublicKey>	PublicKey

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListFollowersAsync(Nullable<Int32>, Nullable<Int32>)

List the authenticated user's followers

Declaration

public virtual Task<ICollection<User>> UserCurrentListFollowersAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListFollowersAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's followers

Declaration

public virtual async Task<ICollection<User>> UserCurrentListFollowersAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListFollowingAsync(Nullable<Int32>, Nullable<Int32>)

List the users that the authenticated user is following

Declaration

public virtual Task<ICollection<User>> UserCurrentListFollowingAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListFollowingAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the users that the authenticated user is following

Declaration

public virtual async Task<ICollection<User>> UserCurrentListFollowingAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListGPGKeysAsync(Nullable<Int32>, Nullable<Int32>)

List the authenticated user's GPG keys

Declaration

public virtual Task<ICollection<GPGKey>> UserCurrentListGPGKeysAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<GPGKey>>	GPGKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListGPGKeysAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's GPG keys

Declaration

public virtual async Task<ICollection<GPGKey>> UserCurrentListGPGKeysAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<GPGKey>>	GPGKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListKeysAsync(String, Nullable<Int32>, Nullable<Int32>)

List the authenticated user's public keys

Declaration

public virtual Task<ICollection<PublicKey>> UserCurrentListKeysAsync(string fingerprint, int? page, int? limit)

Parameters

Type	Name	Description
System.String	fingerprint	fingerprint of the key
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PublicKey>>	PublicKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListKeysAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's public keys

Declaration

public virtual async Task<ICollection<PublicKey>> UserCurrentListKeysAsync(string fingerprint, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	fingerprint	fingerprint of the key
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<PublicKey>>	PublicKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListReposAsync(Nullable<Int32>, Nullable<Int32>)

List the repos that the authenticated user owns

Declaration

public virtual Task<ICollection<Repository>> UserCurrentListReposAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListReposAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the repos that the authenticated user owns

Declaration

public virtual async Task<ICollection<Repository>> UserCurrentListReposAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListStarredAsync(Nullable<Int32>, Nullable<Int32>)

The repos that the authenticated user has starred

Declaration

public virtual Task<ICollection<Repository>> UserCurrentListStarredAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListStarredAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

The repos that the authenticated user has starred

Declaration

public virtual async Task<ICollection<Repository>> UserCurrentListStarredAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListSubscriptionsAsync(Nullable<Int32>, Nullable<Int32>)

List repositories watched by the authenticated user

Declaration

public virtual Task<ICollection<Repository>> UserCurrentListSubscriptionsAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentListSubscriptionsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List repositories watched by the authenticated user

Declaration

public virtual async Task<ICollection<Repository>> UserCurrentListSubscriptionsAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPostGPGKeyAsync(CreateGPGKeyOption)

Create a GPG key

Declaration

public virtual Task<GPGKey> UserCurrentPostGPGKeyAsync(CreateGPGKeyOption form)

Parameters

Type	Name	Description
CreateGPGKeyOption	form

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPostGPGKeyAsync(CreateGPGKeyOption, CancellationToken)

Create a GPG key

Declaration

public virtual async Task<GPGKey> UserCurrentPostGPGKeyAsync(CreateGPGKeyOption form, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateGPGKeyOption	form
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<GPGKey>	GPGKey

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPostKeyAsync(CreateKeyOption)

Create a public key

Declaration

public virtual Task<PublicKey> UserCurrentPostKeyAsync(CreateKeyOption body)

Parameters

Type	Name	Description
CreateKeyOption	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPostKeyAsync(CreateKeyOption, CancellationToken)

Create a public key

Declaration

public virtual async Task<PublicKey> UserCurrentPostKeyAsync(CreateKeyOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreateKeyOption	body
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<PublicKey>	PublicKey

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPutFollowAsync(String)

Follow a user

Declaration

public virtual Task UserCurrentPutFollowAsync(string username)

Parameters

Type	Name	Description
System.String	username	username of user to follow

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPutFollowAsync(String, CancellationToken)

Follow a user

Declaration

public virtual async Task UserCurrentPutFollowAsync(string username, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user to follow
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.

| Improve this Doc View Source

UserCurrentPutStarAsync(String, String)

Star the given repo

Declaration

public virtual Task UserCurrentPutStarAsync(string owner, string repo)

Parameters

Type	Name	Description
System.String	owner	owner of the repo to star
System.String	repo	name of the repo to star

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentPutStarAsync(String, String, CancellationToken)

Star the given repo

Declaration

public virtual async Task UserCurrentPutStarAsync(string owner, string repo, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	owner	owner of the repo to star
System.String	repo	name of the repo to star
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.

| Improve this Doc View Source

UserCurrentTrackedTimesAsync(Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

List the current user's tracked times

Declaration

public virtual Task<ICollection<TrackedTime>> UserCurrentTrackedTimesAsync(int? page, int? limit, DateTimeOffset? since, DateTimeOffset? before)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
System.Nullable<System.DateTimeOffset>	since	Only show times updated after the given time. This is a timestamp in RFC 3339 format
System.Nullable<System.DateTimeOffset>	before	Only show times updated before the given time. This is a timestamp in RFC 3339 format

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<TrackedTime>>	TrackedTimeList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserCurrentTrackedTimesAsync(Nullable<Int32>, Nullable<Int32>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)

List the current user's tracked times

Declaration

public virtual async Task<ICollection<TrackedTime>> UserCurrentTrackedTimesAsync(int? page, int? limit, DateTimeOffset? since, DateTimeOffset? before, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
System.Nullable<System.DateTimeOffset>	since	Only show times updated after the given time. This is a timestamp in RFC 3339 format
System.Nullable<System.DateTimeOffset>	before	Only show times updated before the given time. This is a timestamp in RFC 3339 format
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<TrackedTime>>	TrackedTimeList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserDeleteAccessTokenAsync(String, String)

delete an access token

Declaration

public virtual Task UserDeleteAccessTokenAsync(string username, string token)

Parameters

Type	Name	Description
System.String	username	username of user
System.String	token	token to be deleted, identified by ID and if not available by name

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserDeleteAccessTokenAsync(String, String, CancellationToken)

delete an access token

Declaration

public virtual async Task UserDeleteAccessTokenAsync(string username, string token, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.String	token	token to be deleted, identified by ID and if not available by name
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.

| Improve this Doc View Source

UserDeleteEmailAsync(DeleteEmailOption)

Delete email addresses

Declaration

public virtual Task UserDeleteEmailAsync(DeleteEmailOption body)

Parameters

Type	Name	Description
DeleteEmailOption	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserDeleteEmailAsync(DeleteEmailOption, CancellationToken)

Delete email addresses

Declaration

public virtual async Task UserDeleteEmailAsync(DeleteEmailOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DeleteEmailOption	body
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.

| Improve this Doc View Source

UserDeleteHookAsync(Int64)

Delete a hook

Declaration

public virtual Task UserDeleteHookAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to delete

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserDeleteHookAsync(Int64, CancellationToken)

Delete a hook

Declaration

public virtual async Task UserDeleteHookAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to delete
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.

| Improve this Doc View Source

UserDeleteOAuth2ApplicationAsync(Int64)

delete an OAuth2 Application

Declaration

public virtual Task UserDeleteOAuth2ApplicationAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	token to be deleted

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserDeleteOAuth2ApplicationAsync(Int64, CancellationToken)

delete an OAuth2 Application

Declaration

public virtual async Task UserDeleteOAuth2ApplicationAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	token to be deleted
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.

| Improve this Doc View Source

UserEditHookAsync(Int64, EditHookOption)

Update a hook

Declaration

public virtual Task<Hook> UserEditHookAsync(long id, EditHookOption body)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to update
EditHookOption	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserEditHookAsync(Int64, EditHookOption, CancellationToken)

Update a hook

Declaration

public virtual async Task<Hook> UserEditHookAsync(long id, EditHookOption body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to update
EditHookOption	body
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<Hook>	Hook

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetAsync(String)

Get a user

Declaration

public virtual Task<User> UserGetAsync(string username)

Parameters

Type	Name	Description
System.String	username	username of user to get

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetAsync(String, CancellationToken)

Get a user

Declaration

public virtual async Task<User> UserGetAsync(string username, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user to get
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<User>	User

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetCurrentAsync()

Get the authenticated user

Declaration

public virtual Task<User> UserGetCurrentAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetCurrentAsync(CancellationToken)

Get the authenticated user

Declaration

public virtual async Task<User> UserGetCurrentAsync(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<User>	User

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetHeatmapDataAsync(String)

Get a user's heatmap

Declaration

public virtual Task<ICollection<UserHeatmapData>> UserGetHeatmapDataAsync(string username)

Parameters

Type	Name	Description
System.String	username	username of user to get

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetHeatmapDataAsync(String, CancellationToken)

Get a user's heatmap

Declaration

public virtual async Task<ICollection<UserHeatmapData>> UserGetHeatmapDataAsync(string username, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user to get
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<UserHeatmapData>>	UserHeatmapData

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetHookAsync(Int64)

Get a hook

Declaration

public virtual Task<Hook> UserGetHookAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to get

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetHookAsync(Int64, CancellationToken)

Get a hook

Declaration

public virtual async Task<Hook> UserGetHookAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	id of the hook to get
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<Hook>	Hook

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetOAuth2ApplicationAsync(Int64)

get an OAuth2 Application

Declaration

public virtual Task<OAuth2Application> UserGetOAuth2ApplicationAsync(long id)

Parameters

Type	Name	Description
System.Int64	id	Application ID to be found

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetOAuth2ApplicationAsync(Int64, CancellationToken)

get an OAuth2 Application

Declaration

public virtual async Task<OAuth2Application> UserGetOAuth2ApplicationAsync(long id, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	Application ID to be found
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<OAuth2Application>	OAuth2Application

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetOauth2ApplicationAsync(Nullable<Int32>, Nullable<Int32>)

List the authenticated user's oauth2 applications

Declaration

public virtual Task<ICollection<OAuth2Application>> UserGetOauth2ApplicationAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<OAuth2Application>>	OAuth2ApplicationList represents a list of OAuth2 applications.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetOauth2ApplicationAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's oauth2 applications

Declaration

public virtual async Task<ICollection<OAuth2Application>> UserGetOauth2ApplicationAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<OAuth2Application>>	OAuth2ApplicationList represents a list of OAuth2 applications.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetStopWatchesAsync(Nullable<Int32>, Nullable<Int32>)

Get list of all existing stopwatches

Declaration

public virtual Task<ICollection<StopWatch>> UserGetStopWatchesAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<StopWatch>>	StopWatchList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetStopWatchesAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get list of all existing stopwatches

Declaration

public virtual async Task<ICollection<StopWatch>> UserGetStopWatchesAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<StopWatch>>	StopWatchList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetTokensAsync(String, Nullable<Int32>, Nullable<Int32>)

List the authenticated user's access tokens

Declaration

public virtual Task<ICollection<AccessToken>> UserGetTokensAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<AccessToken>>	AccessTokenList represents a list of API access token.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserGetTokensAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's access tokens

Declaration

public virtual async Task<ICollection<AccessToken>> UserGetTokensAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<AccessToken>>	AccessTokenList represents a list of API access token.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListActivityFeedsAsync(String, Nullable<Boolean>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)

List a user's activity feeds

Declaration

public virtual Task<ICollection<Activity>> UserListActivityFeedsAsync(string username, bool? only_performed_by, DateTimeOffset? date, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Boolean>	only_performed_by	if true, only show actions performed by the requested user
System.Nullable<System.DateTimeOffset>	date	the date of the activities to be found
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Activity>>	ActivityFeedsList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListActivityFeedsAsync(String, Nullable<Boolean>, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List a user's activity feeds

Declaration

public virtual async Task<ICollection<Activity>> UserListActivityFeedsAsync(string username, bool? only_performed_by, DateTimeOffset? date, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Boolean>	only_performed_by	if true, only show actions performed by the requested user
System.Nullable<System.DateTimeOffset>	date	the date of the activities to be found
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Activity>>	ActivityFeedsList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListEmailsAsync()

List the authenticated user's email addresses

Declaration

public virtual Task<ICollection<Email>> UserListEmailsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Email>>	EmailList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListEmailsAsync(CancellationToken)

List the authenticated user's email addresses

Declaration

public virtual async Task<ICollection<Email>> UserListEmailsAsync(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<System.Collections.Generic.ICollection<Email>>	EmailList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListFollowersAsync(String, Nullable<Int32>, Nullable<Int32>)

List the given user's followers

Declaration

public virtual Task<ICollection<User>> UserListFollowersAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListFollowersAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the given user's followers

Declaration

public virtual async Task<ICollection<User>> UserListFollowersAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListFollowingAsync(String, Nullable<Int32>, Nullable<Int32>)

List the users that the given user is following

Declaration

public virtual Task<ICollection<User>> UserListFollowingAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListFollowingAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the users that the given user is following

Declaration

public virtual async Task<ICollection<User>> UserListFollowingAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<User>>	UserList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListGPGKeysAsync(String, Nullable<Int32>, Nullable<Int32>)

List the given user's GPG keys

Declaration

public virtual Task<ICollection<GPGKey>> UserListGPGKeysAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<GPGKey>>	GPGKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListGPGKeysAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the given user's GPG keys

Declaration

public virtual async Task<ICollection<GPGKey>> UserListGPGKeysAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<GPGKey>>	GPGKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListHooksAsync(Nullable<Int32>, Nullable<Int32>)

List the authenticated user's webhooks

Declaration

public virtual Task<ICollection<Hook>> UserListHooksAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Hook>>	HookList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListHooksAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the authenticated user's webhooks

Declaration

public virtual async Task<ICollection<Hook>> UserListHooksAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Hook>>	HookList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListKeysAsync(String, String, Nullable<Int32>, Nullable<Int32>)

List the given user's public keys

Declaration

public virtual Task<ICollection<PublicKey>> UserListKeysAsync(string username, string fingerprint, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.String	fingerprint	fingerprint of the key
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<PublicKey>>	PublicKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListKeysAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the given user's public keys

Declaration

public virtual async Task<ICollection<PublicKey>> UserListKeysAsync(string username, string fingerprint, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.String	fingerprint	fingerprint of the key
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<PublicKey>>	PublicKeyList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListReposAsync(String, Nullable<Int32>, Nullable<Int32>)

List the repos owned by the given user

Declaration

public virtual Task<ICollection<Repository>> UserListReposAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListReposAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the repos owned by the given user

Declaration

public virtual async Task<ICollection<Repository>> UserListReposAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListStarredAsync(String, Nullable<Int32>, Nullable<Int32>)

The repos that the given user has starred

Declaration

public virtual Task<ICollection<Repository>> UserListStarredAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListStarredAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

The repos that the given user has starred

Declaration

public virtual async Task<ICollection<Repository>> UserListStarredAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListSubscriptionsAsync(String, Nullable<Int32>, Nullable<Int32>)

List the repositories watched by a user

Declaration

public virtual Task<ICollection<Repository>> UserListSubscriptionsAsync(string username, int? page, int? limit)

Parameters

Type	Name	Description
System.String	username	username of the user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListSubscriptionsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List the repositories watched by a user

Declaration

public virtual async Task<ICollection<Repository>> UserListSubscriptionsAsync(string username, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	username	username of the user
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Repository>>	RepositoryList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListTeamsAsync(Nullable<Int32>, Nullable<Int32>)

List all the teams a user belongs to

Declaration

public virtual Task<ICollection<Team>> UserListTeamsAsync(int? page, int? limit)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Team>>	TeamList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserListTeamsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List all the teams a user belongs to

Declaration

public virtual async Task<ICollection<Team>> UserListTeamsAsync(int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Team>>	TeamList

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserSearchAsync(String, Nullable<Int64>, Nullable<Int32>, Nullable<Int32>)

Search for users

Declaration

public virtual Task<Response2> UserSearchAsync(string q, long? uid, int? page, int? limit)

Parameters

Type	Name	Description
System.String	q	keyword
System.Nullable<System.Int64>	uid	ID of the user to search for
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results

Returns

Type	Description
System.Threading.Tasks.Task<Response2>	SearchResults of a successful search

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserSearchAsync(String, Nullable<Int64>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Search for users

Declaration

public virtual async Task<Response2> UserSearchAsync(string q, long? uid, int? page, int? limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	q	keyword
System.Nullable<System.Int64>	uid	ID of the user to search for
System.Nullable<System.Int32>	page	page number of results to return (1-based)
System.Nullable<System.Int32>	limit	page size of results
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<Response2>	SearchResults of a successful search

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserUpdateOAuth2ApplicationAsync(Int64, CreateOAuth2ApplicationOptions)

update an OAuth2 Application, this includes regenerating the client secret

Declaration

public virtual Task<OAuth2Application> UserUpdateOAuth2ApplicationAsync(long id, CreateOAuth2ApplicationOptions body)

Parameters

Type	Name	Description
System.Int64	id	application to be updated
CreateOAuth2ApplicationOptions	body

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserUpdateOAuth2ApplicationAsync(Int64, CreateOAuth2ApplicationOptions, CancellationToken)

update an OAuth2 Application, this includes regenerating the client secret

Declaration

public virtual async Task<OAuth2Application> UserUpdateOAuth2ApplicationAsync(long id, CreateOAuth2ApplicationOptions body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	id	application to be updated
CreateOAuth2ApplicationOptions	body
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<OAuth2Application>	OAuth2Application

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserVerifyGPGKeyAsync()

Verify a GPG key

Declaration

public virtual Task<GPGKey> UserVerifyGPGKeyAsync()

Returns

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

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

UserVerifyGPGKeyAsync(CancellationToken)

Verify a GPG key

Declaration

public virtual async Task<GPGKey> UserVerifyGPGKeyAsync(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<GPGKey>	GPGKey

Exceptions

Type	Condition
ApiException	A server side error occurred.