BaseRemoteOptimizer Class

Summary

Base class for remote, web image optimizers.
graph BT Type-->Base0["BaseOptimizer"] click Base0 "/api/Cake.ImageOptimizer/BaseOptimizer" Base0-->Base1["Object"] Type["BaseRemoteOptimizer"] class Type type-node Derived0["PunyPngOptimizer"]-->Type click Derived0 "/api/Cake.ImageOptimizer/PunyPngOptimizer" Derived1["SmushItOptimizer"]-->Type click Derived1 "/api/Cake.ImageOptimizer/SmushItOptimizer" Derived2["KrakenOptimizer"]-->Type click Derived2 "/api/Cake.ImageOptimizer/KrakenOptimizer"

Syntax

public abstract class BaseRemoteOptimizer : BaseOptimizer

Constructors

Name Summary
BaseRemoteOptimizer(IFileSystem, ICakeEnvironment, ICakeLog) Initializes a new instance of the BaseRemoteOptimizer class.

Fields

Name Constant Value Summary
_Environment
Represents the environment Cake operates in.
Inherited from BaseOptimizer
_FileSystem
Represents a file system.
Inherited from BaseOptimizer
_Log
Represents a log.
Inherited from BaseOptimizer

Properties

Name Value Summary
Endpoint Uri
Gets the endpoint URL of the web service.
Extensions IList<string>
A list of extensions supported by the Optimizer
Inherited from BaseOptimizer
FileParameter string
Gets the parameter name of the file to be uploaded
FileSize int
Gets the maximum file size to optimize.
Inherited from BaseOptimizer
Name string
Gets the name of the optimizer.
Inherited from BaseOptimizer
Timeout int
Gets the maximum timespan for the request.
Inherited from BaseOptimizer

Methods

Name Value Summary
Optimize(FilePath) ImageOptimizerResult
Optimizes the specified file.
PopulatePostData(FilePath) IDictionary<string, object>
Populates the request data before posting it to the web optimizer
ReadResponse(string, FilePath) ImageOptimizerResult
Read the response from the web optimizer
Supports(string) bool
Does the specified file.
Inherited from BaseOptimizer

Extension Methods

Name Value Summary
Dump<BaseRemoteOptimizer>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BaseRemoteOptimizer>(BaseRemoteOptimizer[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BaseRemoteOptimizer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<BaseRemoteOptimizer>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<BaseRemoteOptimizer>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BaseRemoteOptimizer>(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