Location.hx 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /*
  2. * Copyright (C)2005-2019 Haxe Foundation
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the "Software"),
  6. * to deal in the Software without restriction, including without limitation
  7. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8. * and/or sell copies of the Software, and to permit persons to whom the
  9. * Software is furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20. * DEALINGS IN THE SOFTWARE.
  21. */
  22. // This file is generated from mozilla\Location.webidl. Do not edit!
  23. package js.html;
  24. /**
  25. The `Location` interface represents the location (URL) of the object it is linked to. Changes done on it are reflected on the object it relates to. Both the `Document` and `Window` interface have such a linked `Location`, accessible via `Document.location` and `Window.location` respectively.
  26. Documentation [Location](https://developer.mozilla.org/en-US/docs/Web/API/Location) by [Mozilla Contributors](https://developer.mozilla.org/en-US/docs/Web/API/Location$history), licensed under [CC-BY-SA 2.5](https://creativecommons.org/licenses/by-sa/2.5/).
  27. @see <https://developer.mozilla.org/en-US/docs/Web/API/Location>
  28. **/
  29. @:native("Location")
  30. extern class Location {
  31. /**
  32. Is a `DOMString` containing the entire URL. If changed, the associated document navigates to the new page. It can be set from a different origin than the associated document.
  33. **/
  34. var href : String;
  35. /**
  36. Returns a `DOMString` containing the canonical form of the origin of the specific location.
  37. **/
  38. var origin(default,null) : String;
  39. /**
  40. Is a `DOMString` containing the protocol scheme of the URL, including the final `':'`.
  41. **/
  42. var protocol : String;
  43. /**
  44. Is a `DOMString` containing the host, that is the hostname, a `':'`, and the port of the URL.
  45. **/
  46. var host : String;
  47. /**
  48. Is a `DOMString` containing the domain of the URL.
  49. **/
  50. var hostname : String;
  51. /**
  52. Is a `DOMString` containing the port number of the URL.
  53. **/
  54. var port : String;
  55. /**
  56. Is a `DOMString` containing an initial `'/'` followed by the path of the URL.
  57. **/
  58. var pathname : String;
  59. /**
  60. Is a `DOMString` containing a `'?'` followed by the parameters or "querystring" of the URL. Modern browsers provide URLSearchParams and URL.searchParams to make it easy to parse out the parameters from the querystring.
  61. **/
  62. var search : String;
  63. /**
  64. Is a `DOMString` containing a `'#'` followed by the fragment identifier of the URL.
  65. **/
  66. var hash : String;
  67. /**
  68. Loads the resource at the URL provided in parameter.
  69. @throws DOMError
  70. **/
  71. function assign( url : String ) : Void;
  72. /**
  73. Replaces the current resource with the one at the provided URL. The difference from the `assign()` method is that after using `replace()` the current page will not be saved in session `History`, meaning the user won't be able to use the back button to navigate to it.
  74. @throws DOMError
  75. **/
  76. function replace( url : String ) : Void;
  77. /**
  78. Reloads the resource from the current URL. Its optional unique parameter is a `Boolean`, which, when it is `true`, causes the page to always be reloaded from the server. If it is `false` or not specified, the browser may reload the page from its cache.
  79. @throws DOMError
  80. **/
  81. function reload( forceget : Bool = false ) : Void;
  82. }