NewmanSettingsExtensions Class

Summary

Extension methods for the NewmanSettings class.
Assembly
Cake.Newman.dll
Namespace
Cake.Newman
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["NewmanSettingsExtensions"] class Type type-node

Syntax

public static class NewmanSettingsExtensions

Methods

Name Value Summary
DisableStrictSSL(NewmanSettings) NewmanSettings
Disables SSL verification checks and allows self-signed SSL certificates.
static
ExitOnFirstFailure(NewmanSettings) NewmanSettings
Specify whether or not to stop a collection run on encountering the first error.
static
ExportCollectionTo(NewmanSettings, FilePath) NewmanSettings
Specify the file where Newman will output the final collection file before completing a run.
static
ExportEnvironmentTo(NewmanSettings, FilePath) NewmanSettings
Specify the file where Newman will output the final environment variables file before completing a run.
static
ExportGlobalsTo(NewmanSettings, FilePath) NewmanSettings
Specify the file where Newman will output the final global variables file before completing a run.
static
IgnoreRedirects(NewmanSettings) NewmanSettings
Prevents newman from automatically following 3XX redirect responses.
static
Insecure(NewmanSettings) NewmanSettings
Disables SSL verification checks and allows self-signed SSL certificates.
static
RunOnlyFolder(NewmanSettings, string) NewmanSettings
Run requests within only the specified folder in a collection.
static
SetIterationCount(NewmanSettings, int) NewmanSettings
Sets the iteration count.
static
SetRequestDelay(NewmanSettings, int) NewmanSettings
Specify the extent of delay between requests (in milliseconds).
static
SetRequestTimeout(NewmanSettings, int) NewmanSettings
Sets the time to wait for request responses.
static
SetScriptTimeout(NewmanSettings, int) NewmanSettings
Sets the time to wait for script to complete.
static
WithData(NewmanSettings, FilePath) NewmanSettings
Specify the file path for an data file to use for the current execution.
static
WithEnvironment(NewmanSettings, FilePath) NewmanSettings
Specify the file path for an environmentsfiel to use for the current execution.
static
WithGlobals(NewmanSettings, FilePath) NewmanSettings
Specify the file path for global variables for the current execution.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin