Skip to content

Commit

Permalink
Add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
joelverhagen committed Sep 1, 2021
1 parent 5195bec commit bfff7be
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions src/NuGetGallery.Services/Providers/IUrlHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,33 @@ public interface IUrlHelper
/// <param name="relativeUrl">True to return a relative URL, false to return an absolute URL.</param>
/// <returns>The relative or absolute URL as a string.</returns>
string Package(string id, string version, bool relativeUrl);

/// <summary>
/// Produces a URL to the package ownership request confirmation page.
/// </summary>
/// <param name="id">The package ID for the ownership request.</param>
/// <param name="username">The username of the ownership request recipient (new owner).</param>
/// <param name="confirmationCode">The confirmation code (secret) associated with the request.</param>
/// <param name="relativeUrl">True to return a relative URL, false to return an absolute URL.</param>
/// <returns>The relative or absolute URL as a string.</returns>
string ConfirmPendingOwnershipRequest(string id, string username, string confirmationCode, bool relativeUrl);

/// <summary>
/// Produces a URL to the package ownership request rejection page.
/// </summary>
/// <param name="id">The package ID for the ownership request.</param>
/// <param name="username">The username of the ownership request recipient (new owner).</param>
/// <param name="confirmationCode">The confirmation code (secret) associated with the request.</param>
/// <param name="relativeUrl">True to return a relative URL, false to return an absolute URL.</param>
/// <returns>The relative or absolute URL as a string.</returns>
string RejectPendingOwnershipRequest(string id, string username, string confirmationCode, bool relativeUrl);

/// <summary>
/// Produces a URL to manage the ownership of an existing package.
/// </summary>
/// <param name="id">The package ID to manage ownership for.</param>
/// <param name="relativeUrl">True to return a relative URL, false to return an absolute URL.</param>
/// <returns>The relative or absolute URL as a string.</returns>
string ManagePackageOwnership(string id, bool relativeUrl);
}
}

0 comments on commit bfff7be

Please sign in to comment.