mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
ec5de110ad
Base methods: Task<IReadOnlyList<EmailAddress>> GetAll() Overload methods: Task<IReadOnlyList<EmailAddress>> GetAll(ApiOptions options);
57 lines
2.3 KiB
C#
57 lines
2.3 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's User Emails API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/users/emails/">User Emails API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IUserEmailsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all email addresses for the authenticated user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
|
|
/// </remarks>
|
|
/// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
|
|
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
|
Task<IReadOnlyList<EmailAddress>> GetAll();
|
|
|
|
/// <summary>
|
|
/// Gets all email addresses for the authenticated user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
|
|
/// </remarks>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
|
|
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
|
Task<IReadOnlyList<EmailAddress>> GetAll(ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Adds email addresses for the authenticated user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/users/emails/#add-email-addresses
|
|
/// </remarks>
|
|
/// <param name="emailAddresses">The email addresses to add.</param>
|
|
/// <returns>Returns the added <see cref="EmailAddress"/>es.</returns>
|
|
Task<IReadOnlyList<EmailAddress>> Add(params string[] emailAddresses);
|
|
|
|
/// <summary>
|
|
/// Deletes email addresses for the authenticated user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/users/emails/#delete-email-addresses
|
|
/// </remarks>
|
|
/// <param name="emailAddresses">The email addresses to delete.</param>
|
|
/// <returns>Returns the added <see cref="EmailAddress"/>es.</returns>
|
|
Task Delete(params string[] emailAddresses);
|
|
}
|
|
}
|