arizona_android (arizona v0.4.0)

Builders for Android client effects, used inside ?native views.

Each function returns an arizona_effect:cmd/0 tuple {arizona_effect, [OpCode | Args]} -- the shared wire format every client command module produces (op codes in include/arizona_effect.hrl), encoded by arizona_effect:encode_json/1. Use them as event props (on_tap, ...) or as effects from handle_event/3.

Commands are per platform on purpose: a native view reaches for arizona_android (not the browser's arizona_js), and this module is the home for Android-specific commands as they're added. push_event/navigate mirror their web counterparts.

{'Button', [{on_tap, arizona_android:push_event(~"inc")}], [~"+"]}

Summary

Functions

navigate(Path)

Navigates the client to the server route Path.

navigate(Path, Opts)

Navigates to Path with options.

push_event(Event)

Pushes a named event to the server.

push_event(Event, Payload)

Pushes a named event with an explicit payload.

Functions

navigate(Path)

-spec navigate(Path) -> arizona_effect:cmd() when Path :: binary().

Navigates the client to the server route Path.

navigate(Path, Opts)

-spec navigate(Path, Opts) -> arizona_effect:cmd() when Path :: binary(), Opts :: map().

Navigates to Path with options.

Only server-consumed options reach a native client's behaviour:

flash -- a flash map (#{binary() => term()}) for the view navigated to. arizona_socket strips it from the effect and carries it in-process to the target's flash binding, exactly as it does for arizona_js:navigate/2; the client never sees the key. Only for an effect a live handler returns: the socket is the carrier. As an event prop ({on_tap, arizona_android:navigate(P, #{flash => F})}) the command reaches the client as data, with nothing to carry the flash, so rendering it raises flash_outside_live_effect -- tap a push_event whose handler returns the navigate instead.

The browser-only options of arizona_js:navigate/2 (replace, full) have no native counterpart -- there is no history stack to replace and no page to load -- and the Android and iOS clients read only the path from the command, so passing them is silently ignored rather than an error.

push_event(Event)

-spec push_event(Event) -> arizona_effect:cmd() when Event :: binary().

Pushes a named event to the server.

push_event(Event, Payload)

-spec push_event(Event, Payload) -> arizona_effect:cmd() when Event :: binary(), Payload :: map().

Pushes a named event with an explicit payload.