NavigationHistoryEntry.hs

{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE ForeignFunctionInterface, JavaScriptFFI #-}
{-# LANGUAGE ImplicitParams, ConstraintKinds, KindSignatures #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
-- | Generated by dom-gen from html (webref). Do not edit.
module GHCJS.DOM.JSFFI.Generated.NavigationHistoryEntry
       (js_getState, js_getUrl, js_getKey, js_getId, js_getIndex, js_getSameDocument, getState, getState_, getUrl, getUrlUnsafe, getUrlUnchecked, getKey, getId, getIndex, getSameDocument, dispose, NavigationHistoryEntry(..), gTypeNavigationHistoryEntry)
       where
import Prelude ((.), (==), (>>=), (<$>), (++), Bool(..), Maybe(..), IO, Int, Word, Double, Float)
import qualified Prelude as P
import Control.Monad (void)
import GHCJS.Types (JSVal, JSString)
import GHCJS.Foreign (jsUndefined, jsNull)
import GHCJS.DOM.Types
import qualified GHCJS.DOM.Types as Types
import GHCJS.DOM.EventTargetClosures (EventName, unsafeEventName, unsafeEventNameAsync)
import GHCJS.DOM.JSFFI.Generated.Enums

foreign import javascript safe "(($1) => { return $1[\"getState\"](); })"
        js_getState :: NavigationHistoryEntry -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/getState MDN NavigationHistoryEntry.getState documentation>
getState :: (MonadDOM m) => NavigationHistoryEntry -> m JSVal
getState self = liftDOM ((js_getState (self)))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/getState MDN NavigationHistoryEntry.getState documentation>
getState_ :: (MonadDOM m) => NavigationHistoryEntry -> m ()
getState_ self = liftDOM (void ((js_getState (self))))

foreign import javascript unsafe "(($1) => { return $1[\"url\"]; })"
        js_getUrl :: NavigationHistoryEntry -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrl :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m (Maybe result)
getUrl self = liftDOM (((fromMaybeJSString . Nullable) <$> (js_getUrl (self))))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrlUnsafe :: (MonadDOM m, HasCallStack, FromJSString result) => NavigationHistoryEntry -> m result
getUrlUnsafe self = liftDOM ((((fromMaybeJSString . Nullable) <$> (js_getUrl (self))) >>= P.maybe (P.error "Nothing to return") P.return))

-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/url MDN NavigationHistoryEntry.url documentation>
getUrlUnchecked :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getUrlUnchecked self = liftDOM ((pFromJSVal <$> (js_getUrl (self))))

foreign import javascript unsafe "(($1) => { return $1[\"key\"]; })"
        js_getKey :: NavigationHistoryEntry -> IO JSString
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/key MDN NavigationHistoryEntry.key documentation>
getKey :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getKey self = liftDOM ((fromJSString <$> (js_getKey (self))))

foreign import javascript unsafe "(($1) => { return $1[\"id\"]; })"
        js_getId :: NavigationHistoryEntry -> IO JSString
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/id MDN NavigationHistoryEntry.id documentation>
getId :: (MonadDOM m, FromJSString result) => NavigationHistoryEntry -> m result
getId self = liftDOM ((fromJSString <$> (js_getId (self))))

foreign import javascript unsafe "(($1) => { return $1[\"index\"]; })"
        js_getIndex :: NavigationHistoryEntry -> IO JSVal
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/index MDN NavigationHistoryEntry.index documentation>
getIndex :: (MonadDOM m) => NavigationHistoryEntry -> m Int53
getIndex self = liftDOM (((js_getIndex (self)) >>= fromJSValUnchecked))

foreign import javascript unsafe "(($1) => { return $1[\"sameDocument\"]; })"
        js_getSameDocument :: NavigationHistoryEntry -> IO Bool
-- | <https://developer.mozilla.org/docs/Web/API/NavigationHistoryEntry/sameDocument MDN NavigationHistoryEntry.sameDocument documentation>
getSameDocument :: (MonadDOM m) => NavigationHistoryEntry -> m Bool
getSameDocument self = liftDOM ((js_getSameDocument (self)))

-- | <https://html.spec.whatwg.org/multipage/nav-history-apis.html#handler-navigationhistoryentry-ondispose dispose event>
dispose :: EventName NavigationHistoryEntry Event
dispose = unsafeEventName (toJSString "dispose")