Class NuGetSource

Namespace

MonkeyLoader.NuGet

Assembly

MonkeyLoader.dll

Represents a NuGet feed source.

[JsonObject(MemberSerialization = MemberSerialization.OptIn, ItemNullValueHandling = NullValueHandling.Ignore)]
public sealed class NuGetSource

Inheritance

object

NuGetSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NuGetSource(string, Uri)

Creates a new unauthenticated NuGetSource instance with the given details.

[JsonConstructor]
public NuGetSource(string name, Uri sourceUri)

Parameters

name string

The nice name of the source.

sourceUri Uri

The URI of the source's feed. Usually ends with /v3/index.json

NuGetSource(string, Uri, string, string)

Creates a new authenticated NuGetSource instance with the given details.

public NuGetSource(string name, Uri sourceUri, string username, string password)

Parameters

name string

The nice name of the source.

sourceUri Uri

The URI of the source's feed. Usually ends with /v3/index.json

username string

The username to use to authenticate with this source.

password string

The password to use to authenticate with this source.

Properties

Authenticated

Gets whether this NuGet source uses authentication.
true when Username and Password aren't empty.

public bool Authenticated { get; }

Property Value

bool

Name

Gets the name of this source, e.g. "Official NuGet Feed".

[JsonProperty("Name")]
public string Name { get; }

Property Value

string

Password

Gets the password to use to authenticate with this NuGet source.
Should be null when no authentication is required.

public string? Password { get; }

Property Value

string

SourceUri

Gets the URI of this NuGet source's feed.
Usually ends with /v3/index.json

[JsonProperty("SourceUri")]
public Uri SourceUri { get; }

Property Value

Uri

Username

Gets the username to use to authenticate with this NuGet source.
Should be null when no authentication is required.

public string? Username { get; }

Property Value

string

Methods

GetPackageSource()

Gets a NuGet.Configuration.PackageSource created from this NuGet source.

public PackageSource GetPackageSource()

Returns

PackageSource

The package source based on this.

GetSourceRepository()

Gets a NuGet.Protocol.Core.Types.SourceRepository created from this NuGet source.

public SourceRepository GetSourceRepository()

Returns

SourceRepository

The source repositor based on this.