ICakePlatform Interface

Summary

Represents the platform that Cake is running on.
Namespace
Cake.Core
Implementing Types
graph BT Type["ICakePlatform"] class Type type-node Implementing0["CakePlatform"]-.->Type click Implementing0 "/api/Cake.Core/CakePlatform" Implementing1["FakePlatform"]-.->Type click Implementing1 "/api/Cake.Testing/FakePlatform"

Syntax

public interface ICakePlatform

Properties

Name Value Summary
Family PlatformFamily
Gets the platform family.
Is64Bit bool
Gets a value indicating whether or not the current operative system is 64 bit.

Extension Methods

Name Value Summary
Dump<ICakePlatform>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ICakePlatform>(ICakePlatform[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
IsLinux() bool
Determines whether the specified platform is a Linux platform.
IsOSX() bool
Determines whether the specified platform is a macOS platform.
IsUnix() bool
Determines whether the specified platform is a Unix platform.
IsWindows() bool
Determines whether the specified platform is a Windows platform.
NotNull<ICakePlatform>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ICakePlatform>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ICakePlatform>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ICakePlatform>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin