ChocolateyAliases.

ChocolateyApiKey(ICakeContext, string, string, ChocolateyApiKeySettings) Method

Summary

Sets the Api Key for a Chocolatey Source using the specified settings.

Syntax

[CakeMethodAlias]
[CakeAliasCategory("ApiKey")]
[CakeNamespaceImport("Cake.Common.Tools.Chocolatey.ApiKey")]
public static void ChocolateyApiKey(this ICakeContext context, string apiKey, string source, ChocolateyApiKeySettings settings)

Examples

ChocolateyApiKey("myApiKey", "http://www.mysource.com", new ChocolateyApiKeySettings {
    Debug                 = false,
    Verbose               = false,
    Force                 = false,
    Noop                  = false,
    LimitOutput           = false,
    ExecutionTimeout      = 13,
    CacheLocation         = @"C:\temp",
    AllowUnofficial        = false
});

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.
CakeNamespaceImportAttribute An attribute used to hint Cake about additional namespaces that need to be imported for an alias to work. This attribute can mark an extension method, the extension method class, or the assembly to provide a global set of imports

Parameters

Name Type Description
context ICakeContext The context.
apiKey string The API Key.
source string The source.
settings ChocolateyApiKeySettings The settings.

Return Value

Type Description
void