add extjs 6.0.1 sources

[extjs.git] / extjs / packages / amf / Readme.md

# Sencha Touch AMF\r
\r
Sencha Touch AMF is an implementation of the [Action Message Format](http://en.wikipedia.org/wiki/Action_Message_Format) (AMF and AMFX) protocols for use with the Sencha Touch Ext.direct class. AMF \r
is a compact binary format used by Adobe Flash/Flex to serialize ActionScript\r
object graphs.  AMF is typically used to encode messages that are sent between\r
an Adobe Flash client and a remote service.  AMF is only a serialization\r
technology, not a transport, so AMF encoded binary data can be used with any\r
transport such as HTTP or HTTPS.\r
\r
You can use the AmfRemotingProvider to make remote method invocation (RMI) calls \r
to a server, or as a way to provide APIs for a Direct Store to connect a data \r
source to a ListView or DataView.\r
\r
For more information, please see the documentation for `Ext.direct.AmfRemotingProvider`.\r
\r
**Note:** Sencha AMF is only distributed as part of [Sencha Touch Bundle](http://www.sencha.com/products/touch-bundle/) and [Sencha Complete](http://www.sencha.com/products/complete).\r
\r
## Requiring AMF\r
\r
The AMF class is not part of the core Sencha Touch framework, rather it is distributed as a package. As such, AMF is not immediately available for use within your Touch application and needs to be added as a required package. \r
\r
Requiring the AMF package is a simple 3-step procedure\r
\r
1. Edit your application's **app.json** file and add the `amf` package to the requires section:\r
\r
    <code>\r
        requires: [ 'amf' ]\r
    </code>\r
\r
2. If not already present, add the following property to the file **.sencha/app/sencha.cfg**:\r
    \r
    <code>\r
        framework.packages.dir=${framework.dir}/packages\r
    </code>\r
\r
3. Refresh your application:\r
\r
    sencha app refresh \r
\r
The AMF classes are now available for use within your application.\r
\r