blob: bce62c7e0fe4cf68c966462a286d0c0f77265889 [file] [log] [blame] [edit]
// <copyright file="NetworkResponsetHandler.cs" company="WebDriver Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>
using System;
namespace OpenQA.Selenium
{
/// <summary>
/// Allows a user to handle a returned network, potentially modifying it before processing by the browser.
/// </summary>
public class NetworkResponseHandler
{
/// <summary>
/// Gets or sets a function that evaluates returned response data in an <see cref="HttpResponseData"/> object,
/// and returns a value indicating whether the data matches the specified criteria.
/// </summary>
public Func<HttpResponseData, bool> ResponseMatcher { get; set; }
/// <summary>
/// Gets or sets a function that accepts an <see cref="HttpResponseData"/> object describing a network
/// response received by the browser, and returns a modified <see cref="HttpResponseData"/> object to used
/// as the actual network response.
/// </summary>
public Func<HttpResponseData, HttpResponseData> ResponseTransformer { get; set; }
}
}