Packages

abstract class Access[F[_], S, M] extends BaseAccess[F, S, M] with EventAccess[F, S, M]

Provides access to make side effects

Linear Supertypes
EventAccess[F, S, M], BaseAccess[F, S, M], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Access
  2. EventAccess
  3. BaseAccess
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Access()(implicit arg0: Async[F])

Abstract Value Members

  1. abstract def downloadFiles(id: ElementId[F, S, M]): F[List[File[Array[Byte]]]]

    Download selected file list from input correspondent to given element id.

    Download selected file list from input correspondent to given element id.

    Definition Classes
    BaseAccess
  2. abstract def downloadFilesAsStream(id: ElementId[F, S, M]): F[List[File[LazyBytes[F]]]]

    Same as downloadFiles but for stream mode.

    Same as downloadFiles but for stream mode. The method is useful when user want to upload very large files list which is problematic to keep in memory (especially when count of users is more than one).

    Definition Classes
    BaseAccess
  3. abstract def downloadFormData(id: ElementId[F, S, M]): FormDataDownloader[F, S]

    Downloads form from client

    Downloads form from client

    event('submit) { access =>
      access
        .downloadFormData(myForm)
        .onProgress { (loaded, total) =>
          // transition …
        }
        .start
        .flatMap { formData =>
          val picture = data.file("picture") // Array[Byte]
          val title = data.text("title") // String
          access.transition {
            // ... transtion
          }
        }
    }
    id

    form elementId

    Definition Classes
    BaseAccess
  4. abstract def evalJs(code: String): F[String]

    Execute arbitrary JavaScript code on client and get stringified JSON back.

    Execute arbitrary JavaScript code on client and get stringified JSON back.

    access.evalJs("new Date().getTimezoneOffset()").map(offset => ...)
    Definition Classes
    BaseAccess
  5. abstract def eventData: F[String]

    Gives json with string, number and boolean fields of object of the event happened in current render phase.

    Gives json with string, number and boolean fields of object of the event happened in current render phase. Note that is expensive operation which requires network round trip.

    Definition Classes
    EventAccess
  6. abstract def focus(id: ElementId[F, S, M]): F[Unit]

    Makes focus on the element

    Makes focus on the element

    Definition Classes
    BaseAccess
  7. abstract def property(id: ElementId[F, S, M]): PropertyHandler[F]

    Extracts property of element from client-side DOM.

    Extracts property of element from client-side DOM.

    Definition Classes
    BaseAccess
    Example:
    1. event('click) { access =>
        for {
          request <- access.property(searchField).get('value)
          result  <- searchModel.search(request)
          _       <- access.transition {
            case state: State.Awesome =>
              state.copy(list = searchResult)
          }
        } yield ()
      }
    Since

    0.6.0

    See also

    Context.elementId

  8. abstract def publish(message: M): F[Unit]

    Publish message to environment.

    Publish message to environment.

    Definition Classes
    BaseAccess
  9. abstract def sessionId: F[QualifiedSessionId]

    Gives current session id.

    Gives current session id.

    Definition Classes
    BaseAccess
  10. abstract def state: F[S]

    Gives current state.

    Gives current state.

    Definition Classes
    BaseAccess
  11. abstract def transition(f: Transition[S]): F[Unit]

    Applies transition to current state.

    Applies transition to current state.

    Definition Classes
    BaseAccess

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def maybeTransition(f: PartialFunction[S, S]): F[Unit]

    Applies transition to current state.

    Applies transition to current state.

    Definition Classes
    BaseAccess
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def property(id: ElementId[F, S, M], propName: Symbol): F[String]

    Shortcut for property(id).get(proName).

    Shortcut for property(id).get(proName).

    Definition Classes
    BaseAccess
    Since

    0.6.0

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def valueOf(id: ElementId[F, S, M]): F[String]

    Shortcut for property(id).get('value).

    Shortcut for property(id).get('value).

    Definition Classes
    BaseAccess
    Since

    0.6.0

  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from EventAccess[F, S, M]

Inherited from BaseAccess[F, S, M]

Inherited from AnyRef

Inherited from Any

Ungrouped