A base Proxy implementation.

In PureMVC, Proxy classes are used to manage parts of the application's data model.

A Proxy might simply manage a reference to a local data object, in which case interacting with it might involve setting and getting of its data in synchronous fashion.

Proxy classes are also used to encapsulate the application's interaction with remote services to save or retrieve data, in which case, we adopt an asynchronous idiom; setting data (or calling a method) on the Proxy and listening for a Notification to be sent when the Proxy has retrieved the data from the service.

Model

Proxy

Hierarchy (view full)

Implements

Constructors

  • Constructor

    Parameters

    • Optionalname: string

      The name of the proxy. Defaults to Proxy.NAME if not provided.

    • Optionaldata: any

      The data associated with the proxy. Can be null.

    Returns Proxy

Properties

_data?: any

the data object

_name: string

the proxy name

multitonKey: string

The Multiton Key for this app

MULTITON_MSG: string = "multitonKey for this Notifier not yet initialized!"

Message Constants

NAME: string = "Proxy"

The default name for the Proxy.

Accessors

Methods

  • Initialize this Notifier instance.

    This is how a Notifier gets its multitonKey. Calls to sendNotification or to access the facade will fail until after this method has been called.

    Mediators, Commands or Proxies may override this method in order to send notifications or access the Multiton Facade instance as soon as possible. They CANNOT access the facade in their constructors, since this method will not yet have been called.

    Parameters

    • key: string

      the multitonKey for this Notifier to use

    Returns void

  • Create and send an Notification.

    Keeps us from having to construct new Notification instances in our implementation code.

    Parameters

    • notificationName: string

      The name of the notification to be sent.

    • Optionalbody: any

      Optional data to be included with the notification.

    • Optionaltype: string

      Optional type of the notification.

    Returns void