"Fossies" - the Fresh Open Source Software Archive

Member "selenium-selenium-4.8.1/dotnet/src/webdriver/INavigation.cs" (17 Feb 2023, 3429 Bytes) of package /linux/www/selenium-selenium-4.8.1.tar.gz:

    1 // <copyright file="INavigation.cs" company="WebDriver Committers">
    2 // Licensed to the Software Freedom Conservancy (SFC) under one
    3 // or more contributor license agreements. See the NOTICE file
    4 // distributed with this work for additional information
    5 // regarding copyright ownership. The SFC licenses this file
    6 // to you under the Apache License, Version 2.0 (the "License");
    7 // you may not use this file except in compliance with the License.
    8 // You may obtain a copy of the License at
    9 //
   10 //     http://www.apache.org/licenses/LICENSE-2.0
   11 //
   12 // Unless required by applicable law or agreed to in writing, software
   13 // distributed under the License is distributed on an "AS IS" BASIS,
   14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   15 // See the License for the specific language governing permissions and
   16 // limitations under the License.
   17 // </copyright>
   18 
   19 using System;
   20 
   21 namespace OpenQA.Selenium
   22 {
   23     /// <summary>
   24     /// Defines an interface allowing the user to access the browser's history and to
   25     /// navigate to a given URL.
   26     /// </summary>
   27     public interface INavigation
   28     {
   29         /// <summary>
   30         /// Move back a single entry in the browser's history.
   31         /// </summary>
   32         void Back();
   33 
   34         /// <summary>
   35         /// Move a single "item" forward in the browser's history.
   36         /// </summary>
   37         /// <remarks>Does nothing if we are on the latest page viewed.</remarks>
   38         void Forward();
   39 
   40         /// <summary>
   41         ///  Load a new web page in the current browser window.
   42         /// </summary>
   43         /// <param name="url">The URL to load. It is best to use a fully qualified URL</param>
   44         /// <remarks>
   45         /// Calling the <see cref="GoToUrl(string)"/> method will load a new web page in the current browser window.
   46         /// This is done using an HTTP GET operation, and the method will block until the
   47         /// load is complete. This will follow redirects issued either by the server or
   48         /// as a meta-redirect from within the returned HTML. Should a meta-redirect "rest"
   49         /// for any duration of time, it is best to wait until this timeout is over, since
   50         /// should the underlying page change while your test is executing the results of
   51         /// future calls against this interface will be against the freshly loaded page.
   52         /// </remarks>
   53         void GoToUrl(string url);
   54 
   55         /// <summary>
   56         ///  Load a new web page in the current browser window.
   57         /// </summary>
   58         /// <param name="url">The URL to load.</param>
   59         /// <remarks>
   60         /// Calling the <see cref="GoToUrl(System.Uri)"/> method will load a new web page in the current browser window.
   61         /// This is done using an HTTP GET operation, and the method will block until the
   62         /// load is complete. This will follow redirects issued either by the server or
   63         /// as a meta-redirect from within the returned HTML. Should a meta-redirect "rest"
   64         /// for any duration of time, it is best to wait until this timeout is over, since
   65         /// should the underlying page change while your test is executing the results of
   66         /// future calls against this interface will be against the freshly loaded page.
   67         /// </remarks>
   68         void GoToUrl(Uri url);
   69 
   70         /// <summary>
   71         /// Refreshes the current page.
   72         /// </summary>
   73         void Refresh();
   74     }
   75 }