Ufront API Documentation

Ufront is an open source client-server web framework for Haxe. This API documentation includes all the classes used in the various Ufront libraries.

The menu on the left only shows the ufront package, which is where most of the good stuff is.The API documentation for any dependencies is included in the search and in links in the documentation, but is hidden from the menu to avoid clutter.

package ufront.api

ApiReturnType

A set of flags that indicates if a UFApi returns a Future, an Outcome, a Void or a combination of these.

RequireAsyncCallbackApi

RequireApiProxy is a marker interface that makes sure an API proxy is built before we reference it.

UFApi

An API that can be used in Ufront controllers, tasks, other APIs, or remoting requests.

UFApiClientContext

UFApiClientContext is a macro-powered class that will generate callback style proxies for your UFApiContext.

UFApiContext

UFApiContext is a base class for setting up your Haxe remoting API context.

UFAsyncApi

An asynchronous proxy that calls a server API, using a Surprise to wait for the result.

UFCallbackApi

An asynchronous proxy that calls a server API, using callbacks to wait for the result.