// Copyright © 2015 The CefSharp Authors. All rights reserved.
|
//
|
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
|
|
using System;
|
using System.Collections.Generic;
|
|
namespace CefSharp
|
{
|
/// <summary>
|
/// Class used to represent post data for a web request. The methods of this class may be called on any thread.
|
/// </summary>
|
public interface IPostData : IDisposable
|
{
|
/// <summary>
|
/// Add the specified <see cref="IPostDataElement"/>.
|
/// </summary>
|
/// <param name="element">element to be added.</param>
|
/// <returns>Returns true if the add succeeds.</returns>
|
bool AddElement(IPostDataElement element);
|
|
/// <summary>
|
/// Remove the specified <see cref="IPostDataElement"/>.
|
/// </summary>
|
/// <param name="element">element to be removed.</param>
|
/// <returns> Returns true if the add succeeds.</returns>
|
bool RemoveElement(IPostDataElement element);
|
|
/// <summary>
|
/// Retrieve the post data elements.
|
/// </summary>
|
IList<IPostDataElement> Elements { get; }
|
|
/// <summary>
|
/// Returns true if this object is read-only.
|
/// </summary>
|
bool IsReadOnly { get; }
|
|
/// <summary>
|
/// Remove all existing post data elements.
|
/// </summary>
|
void RemoveElements();
|
|
/// <summary>
|
/// Gets a value indicating whether the object has been disposed of.
|
/// </summary>
|
bool IsDisposed { get; }
|
|
/// <summary>
|
/// Create a new <see cref="IPostDataElement"/> instance
|
/// </summary>
|
/// <returns>PostDataElement</returns>
|
IPostDataElement CreatePostDataElement();
|
|
/// <summary>
|
/// Returns true if the underlying POST data includes elements that are not
|
/// represented by this IPostData object (for example, multi-part file upload
|
/// data). Modifying IPostData objects with excluded elements may result in
|
/// the request failing.
|
/// </summary>
|
bool HasExcludedElements { get; }
|
}
|
}
|
