Sha256: 2c88b2d061bbc2890a90a3254d2843c8011924805ea870aa9c68ea3e83657a2b

Contents?: true

Size: 1.23 KB

Versions: 21

Compression:

Stored size: 1.23 KB

Contents

#Client API
Client API covers controller action event handlers.

### Controller MACROS
  * Embed(view_controller_name, spot_name, context) - Embed a view controller with the name `view_controller_name` inside the current view controller at the spot with a context
  * Goto(action_name) - Change actions
  * Request(service_name, info, event_cb_name) - Initiate a service.  See [Services](./services.md) for more info.
  * Send(event_name, info) - Send a custom event on the main queue.
  * Raise(event_name, info) - Will send an event to the parent view controller (and it will bubble up, following `event_gw` which is set in `Embed` as the parent controller
  * Lower(spot_name, event_name, info) - Send an event to a particular spot

### Controller Event Handlers
  * Variables
    * `context` - The information for the controllers context
    * `params` - What was passed in the event
    * `__base__` - The address of the controller
    * `__info__` - Holds the `context`, current action, etc. See [Datatypes](./datatypes.md)
### Controller on_entry
    * `context` - The information for the controllers context
    * `__base__` - The address of the controller
    * `__info__` - Holds the `context`, current action, etc. See [Datatypes](./datatypes.md)

Version data entries

21 entries across 21 versions & 1 rubygems

Version Path
flok-0.0.36 docs/client_api.md
flok-0.0.35 docs/client_api.md
flok-0.0.34 docs/client_api.md
flok-0.0.33 docs/client_api.md
flok-0.0.32 docs/client_api.md
flok-0.0.31 docs/client_api.md
flok-0.0.30 docs/client_api.md
flok-0.0.29 docs/client_api.md
flok-0.0.28 docs/client_api.md
flok-0.0.27 docs/client_api.md
flok-0.0.26 docs/client_api.md
flok-0.0.25 docs/client_api.md
flok-0.0.24 docs/client_api.md
flok-0.0.23 docs/client_api.md
flok-0.0.21 docs/client_api.md
flok-0.0.20 docs/client_api.md
flok-0.0.19 docs/client_api.md
flok-0.0.18 docs/client_api.md
flok-0.0.17 docs/client_api.md
flok-0.0.16 docs/client_api.md