手机客户端及服务端通信接口说明文档.docx

手机客户端和服务端通信接口说明文档 1、接口概述 客户端和服务端交互是通过MAServerAdaptor这个类来完成的，其中提供一个MAServerAdaptorDelegateProtocol接口用来完成对服务端响应结果。 2、MAServerAdaptor 2.1、+ (MAServerAdaptor *)instance 获取和服务端交互类的实例方法。 2.2、- (void)doActionAsync:(int)viewInstanceId withAction:(NSString*)actionName withParameters:(id)parameters withDelegate:(idMAServerAdaptorDelegateProtocol)delegate 方法描述：主要负责和服务端交互的方法，执行服务端相关业务逻辑，比如：登陆、对数据增删改查等。 参数描述： 1、viewInstanceId:模板界面唯一标示的ID。 2、actionName:需要调用服务端的业务逻辑方法， 格式如下：“test.TestDoAction$sayHelloWithJsonArray”,其中test.TestDoAction 表示服务端的包名和类名，sayHelloWithJsonArray表示服务端方法，$包和方法间的分割符。 3、parameters：表示传递给服务端的参数，其中该参数支持多种格式，格式如下： 数字类型、字符串类型、bool类型、json类型、jsonArray类型 4、delegate：执行完这个方法后的回调类。该类需要实现该MAServerAdaptorDelegateProtocol 接口的doFinished方法，来处理服务端响应结果。 2.3、- (void)downloadFileAsync:(int)viewInstanceId withUrl:(NSString*)url withDelegate:(idMAServerAdaptorDelegateProtocol)delegate; 方法描述：该方法处理和服务器交互，下载附件方法 参数描述： 1、viewInstanceId:模板界面唯一标示的ID。 2、url：需要下载文件的URL，其中url格式如下：”remote：test.doc”,其中remote表示需要下载的标示，其他格式：“mserver:{“name”:”test.doc”}. 3、delegate：执行完这个方法后的回调类。该类需要实现该MAServerAdaptorDelegateProtocol 接口的doFinished方法，来处理服务端响应结果。 4、下载后文件会默认存放在临时目录下面，其中文件名字由时间戳组成。 2.4、- (NSString*)downloadConfigFile:(NSString*)filePath 方法描述：从服务端下载系统配置文件到本地configCache中，例如：JS、图片等。并返回下载下来的文件在本地configCache中的路径。 参数描述： （1）、filePath：服务端的文件名，同时支持目录结构。如下：main.js、main.png、/ipad/main.js 等 注意： 模拟器configCache默认路径为：/Developer/Documentation/Iphone/ConfigCache 2.5、- (void)previewFileAsync:(int)viewInstanceId withUrl:(NSString*)url withPage:(int)page withFileHandle:(NSFileHandle*)fileHandle withDelegate:(idMAServerAdaptorDelegateProtocol)delegate; 方法描述：文件预览接口 2.6、- (void)uploadFileAsync:(NSString*)filePath withDelegate:(idMAServerAdaptorDelegateProtocol)delegate; 方法描述：和服务端交互上传文件方法。 参数描述： （1）、filePath:上传文件的路径 （2）、delegate：执行完这个方法后的回调类。该类需要实现该MAServerAdaptorDelegateProtocol 接口的doFinished方法，