io.scalajs.dom.ws.CloseEvent.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dom-html_sjs0.6_2.11 Show documentation

DOM/HTML bindings for Scala.js

There is a newer version: 0.4.2

package io.scalajs.dom.ws

import io.scalajs.dom.Event

import scala.scalajs.js
import scala.scalajs.js.annotation.JSGlobal

/**
  * A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the
  * listener indicated by the WebSocket object's onclose attribute.
  */
@js.native
@JSGlobal("CloseEvent")
class CloseEvent() extends Event {

  ///////////////////////////////////////////////////////////////
  //    Properties
  ///////////////////////////////////////////////////////////////

  /**
    * Returns an unsigned short containing the close code send by the server.
    * The following values are permitted status codes.
    */
  def code: Int = js.native

  /**
    * Returns a DOMString indicating the reason the server closed the connection.
    * This is specific to the particular server and sub-protocol.
    */
  def reason: String = js.native

  /**
    * Returns a Boolean that Indicates whether or not the connection was cleanly closed.
    */
  def wasClean: Boolean = js.native

  ///////////////////////////////////////////////////////////////
  //    Methods
  ///////////////////////////////////////////////////////////////

  /**
    * Initializes the value of a CloseEvent created. If the event has already being dispatched, this method does nothing.
    * Do not use this method anymore, use the CloseEvent() constructor instead.
    */
  def initCloseEvent(): Unit = js.native

}