UZModuleContext

java.lang.Object
- com.uzmap.pkg.uzcore.uzmodule.UZModuleContext

```
public class UZModuleContext
extends java.lang.Object
```
APICloud模块扩展机制中，Javascript与Java之间交互时的上下文。该类是Javascript函数通过UZModule桥接至Java函数时的传参载体，也是Java回调操作结果给Javascript的执行者。

Javascript传递给Java的数据将被解析成JSONObject保存在本对象下，您可以通过本对象的opt*函数进行获取访问。
例如：
```
 var param = {
  key : value,
  key1 : value1,
  key2 : value,
  key n : value n,
  ...
 }
 
```
Javascript中通过：
```
 module.funXXX(param, callback);
 
```
调用时，param将被对应成JSON数据存储在本对象中，可通过本对象的optInt(key)，optString(key)等函数获取Javascript传给你的相应值。

本对象包含操作标准JSONObject的方法。

操作完成后，可将结果通过success或者error函数回调给Javascript callback。
另请参阅:

UZModule, ModuleResult

方法概要

方法
限定符和类型	方法和说明
`boolean`	`empty()` 查询本次API访问中，Javascript是否有传递数据给Java
`void`	`error(JSONObject result, JSONObject error, boolean deleteJsFunction)` 当Java操作过程中发生系统级别，或者自行约定的错误时，需将处理结果通过该函数回调至Javascript，并在模块API文档中做相应声明
`JSONObject`	`get()` 获取本次API访问中，Javascript传递给Java的所有数据
`Context`	`getContext()` 获取Context
`void`	`interrupt()` Java成功处理完操作后，且无结果需要回调Javascript，可调用该函数通知引擎回收Javascript回调函数的引用。
`boolean`	`isNull(java.lang.String name)` 检查本次API访问中，Javascript是否有传递某参数给Java
`java.lang.String`	`makeAbsUrl(java.lang.String link)` 基于当前Html5页面的绝对Url将某相对Url转换为绝对Url.
`java.lang.String`	`makeRealPath(java.lang.String path)` 将一个任意协议的路径，如标准的content://，res://，以及APICloud扩展的widget://，fs://，cache://转换为系统可识别的真实路径如： path: fs://abc/samples.txt 转换后的结果类似于：/sdcard/uzmap/appid/abc/samples.txt的本地SD卡中路径
`boolean`	`optBoolean(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的bool型参数值，该函数类似`JSONObject`的optBoolean操作。
`boolean`	`optBoolean(java.lang.String key, boolean fallback)` 获取本次API访问中，Javascript传递给Java的bool型参数值，该函数类似`JSONObject`的optBoolean操作。
`double`	`optDouble(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的double型参数值，该函数类似`JSONObject`的optDouble操作。
`double`	`optDouble(java.lang.String key, double fallback)` 获取本次API访问中，Javascript传递给Java的double型参数值，该函数类似`JSONObject`的optDouble操作。
`int`	`optInt(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的int型参数值，该函数类似`JSONObject`的optInt操作。
`int`	`optInt(java.lang.String key, int fallback)` 获取本次API访问中，Javascript传递给Java的int型参数值，该函数类似`JSONObject`的optInt操作。
`JSONArray`	`optJSONArray(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的JSON数组型参数值，该函数类似`JSONObject`的optJSONArray操作。
`JSONObject`	`optJSONObject(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的JSON对象型参数值，该函数类似`JSONObject`的optJSONObject操作。
`long`	`optLong(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的long型参数值，该函数类似`JSONObject`的optLong操作。
`long`	`optLong(java.lang.String key, long fallback)` 获取本次API访问中，Javascript传递给Java的long型参数值，该函数类似`JSONObject`的optLong操作。
`java.lang.Object`	`optObject(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的任意类型参数值，该函数类似`JSONObject`的optObject操作。
`java.lang.String`	`optString(java.lang.String key)` 获取本次API访问中，Javascript传递给Java的字符串型参数值，该函数类似`JSONObject`的optString操作。
`java.lang.String`	`optString(java.lang.String key, java.lang.String fallback)` 获取本次API访问中，Javascript传递给Java的字符串型参数值，该函数类似`JSONObject`的optString操作。
`void`	`success(JSONObject result, boolean deleteJsFunction)` Java成功处理完操作后，可将处理结果通过该函数回调至Javascript
`void`	`success(java.lang.String result, boolean transToJson, boolean deleteJsFunction)` Java成功处理完操作后，可将处理结果通过该函数回调至Javascript

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - success
```
public final void success(java.lang.String result,
           boolean transToJson,
           boolean deleteJsFunction)
```
    Java成功处理完操作后，可将处理结果通过该函数回调至Javascript
    
    参数:
    
    result - 回调给Javascript的成功结果数据载体，任意字符串
    
    transToJson - 是否将result转换为JSON对象，方便Javascript操作。如果是，则要求result必须为JSON格式的字符串
    
    deleteJsFunction - 回调成功后通知引擎是否清除对Javascript函数的引用，便于内存回收，通常为true。如果有需要不断回调Javascript，则该参数可传false，直到最后一次回调时传true
  - success
```
public final void success(JSONObject result,
           boolean deleteJsFunction)
```
    Java成功处理完操作后，可将处理结果通过该函数回调至Javascript
    
    参数:
    
    result - 回调给Javascript的成功结果数据载体，JSONObject对象，该对象被传递到Javascript后，将对应为Javascript中的JSON对象
    
    deleteJsFunction - 回调成功后通知引擎是否清除对Javascript函数的引用，便于内存回收，通常为true。如果有需要不断回调Javascript，则该参数可传false，直到最后一次回调时传true
  - error
```
public final void error(JSONObject result,
         JSONObject error,
         boolean deleteJsFunction)
```
    当Java操作过程中发生系统级别，或者自行约定的错误时，需将处理结果通过该函数回调至Javascript，并在模块API文档中做相应声明
    
    参数:
    
    result - 回调给Javascript的成功数据。发生错误时，该参数请传null
    
    error - 回调给Javascript的错误原因数据载体。
    
    deleteJsFunction - 回调成功后通知引擎是否清除对Javascript函数的引用，便于内存回收，通常为true。
  - interrupt
```
public final void interrupt()
```
    Java成功处理完操作后，且无结果需要回调Javascript，可调用该函数通知引擎回收Javascript回调函数的引用。等同于deleteJsFunction的作用
  - getContext
```
public Context getContext()
```
    获取Context
  - empty
```
public final boolean empty()
```
    查询本次API访问中，Javascript是否有传递数据给Java
    
    返回:
    
    true：有，false：无
  - optInt
```
public final int optInt(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的int型参数值，该函数类似JSONObject的optInt操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optInt("duration")，将返回2000
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回0
  - optInt
```
public final int optInt(java.lang.String key,
         int fallback)
```
    获取本次API访问中，Javascript传递给Java的int型参数值，该函数类似JSONObject的optInt操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optInt("duration")，将返回2000
 
```
    参数:
    
    key -
    
    fallback - 当不存在对应的key时，默认的返回值
    
    返回:
    
    key对应的值，如果不存在，则返回fallback
  - optLong
```
public final long optLong(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的long型参数值，该函数类似JSONObject的optLong操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optLong("duration")，将返回2000L
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回0L
  - optLong
```
public final long optLong(java.lang.String key,
           long fallback)
```
    获取本次API访问中，Javascript传递给Java的long型参数值，该函数类似JSONObject的optLong操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optLong("duration")，将返回2000L
 
```
    参数:
    
    key -
    
    fallback - 当不存在对应的key时，默认的返回值
    
    返回:
    
    key对应的值，如果不存在，则返回fallback
  - optString
```
public final java.lang.String optString(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的字符串型参数值，该函数类似JSONObject的optString操作。
    如：
```
 Javascript:
 
 api.openWin({
   url: 'http://developer.yonyou.com'
 });
 
 Java:
 
 optString("url")，将返回"http://developer.yonyou.com"
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回""
  - optString
```
public final java.lang.String optString(java.lang.String key,
                         java.lang.String fallback)
```
    获取本次API访问中，Javascript传递给Java的字符串型参数值，该函数类似JSONObject的optString操作。
    如：
```
 Javascript:
 
 api.openWin({
   url: 'http://developer.yonyou.com'
 });
 
 Java:
 
 optString("url")，将返回"http://developer.yonyou.com"
 
```
    参数:
    
    key -
    
    fallback - 当不存在对应的key时，默认的返回值
    
    返回:
    
    key对应的值，如果不存在，则返回fallback
  - optBoolean
```
public final boolean optBoolean(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的bool型参数值，该函数类似JSONObject的optBoolean操作。
    如：
```
 Javascript:
 
 api.openWin({
   bounces: true
 });
 
 Java:
 
 optBoolean("bounces")，将返回true
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回false
  - optBoolean
```
public final boolean optBoolean(java.lang.String key,
                 boolean fallback)
```
    获取本次API访问中，Javascript传递给Java的bool型参数值，该函数类似JSONObject的optBoolean操作。
    如：
```
 Javascript:
 
 api.openWin({
   bounces: true
 });
 
 Java:
 
 optBoolean("bounces")，将返回true
 
```
    参数:
    
    key -
    
    fallback - 当不存在对应的key时，默认的返回值
    
    返回:
    
    key对应的值，如果不存在，则返回fallback
  - optDouble
```
public final double optDouble(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的double型参数值，该函数类似JSONObject的optDouble操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optDouble("duration")，将返回2000.0
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回0
  - optDouble
```
public final double optDouble(java.lang.String key,
               double fallback)
```
    获取本次API访问中，Javascript传递给Java的double型参数值，该函数类似JSONObject的optDouble操作。
    如：
```
 Javascript:
 
 api.toast({
   duration: 2000
 });
 
 Java:
 
 optDouble("duration")，将返回2000.0
 
```
    参数:
    
    key -
    
    fallback - 当不存在对应的key时，默认的返回值
    
    返回:
    
    key对应的值，如果不存在，则返回fallback
  - optJSONObject
```
public final JSONObject optJSONObject(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的JSON对象型参数值，该函数类似JSONObject的optJSONObject操作。
    如：
```
 Javascript:
 
 api.sendEvent({
  extra: {
   key1: 'value1', 
   key2: 'value2'
  }
 });
 
 Java:
 
 optJSONObject("extra")，将返回携带{"key1":"value1","key2":"value2"}数据的JSONObject对象
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回null
  - optJSONArray
```
public final JSONArray optJSONArray(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的JSON数组型参数值，该函数类似JSONObject的optJSONArray操作。
    如：
```
 Javascript:
 
 api.confirm({
  buttons:['确定','取消']
 });
 
 Java:
 
 optJSONArray("buttons")，将返回携带['确定','取消']数据的optJSONArray对象
 
```
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回null
  - optObject
```
public final java.lang.Object optObject(java.lang.String key)
```
    获取本次API访问中，Javascript传递给Java的任意类型参数值，该函数类似JSONObject的optObject操作。
    该操作涵盖所有opt*操作
    
    参数:
    
    key -
    
    返回:
    
    key对应的值，如果不存在，则返回null
  - get
```
public JSONObject get()
```
    获取本次API访问中，Javascript传递给Java的所有数据
    
    返回:
  - isNull
```
public boolean isNull(java.lang.String name)
```
    检查本次API访问中，Javascript是否有传递某参数给Java
    
    返回:
  - makeAbsUrl
```
public final java.lang.String makeAbsUrl(java.lang.String link)
```
    基于当前Html5页面的绝对Url将某相对Url转换为绝对Url.
    如：
    当前Html5页面URL: http://developer.yonyou.com/index.html
    link: /abc/lmn/samples.html
    运算结果将得到：http://developer.yonyou.com/abc/lmn/samples.html
    
    参数:
    
    link - 相对Url，如：../samples.html
    
    返回:
    
    绝对路径
    
    另请参阅:
    
    UZUtility.makeAbsUrl(String, String)
  - makeRealPath
```
public final java.lang.String makeRealPath(java.lang.String path)
```
    将一个任意协议的路径，如标准的content://，res://，以及APICloud扩展的widget://，fs://，cache://转换为系统可识别的真实路径如：
    path: fs://abc/samples.txt
    转换后的结果类似于：/sdcard/uzmap/appid/abc/samples.txt的本地SD卡中路径
    
    参数:
    
    path - 任意协议的路径，如：fs://abc/samples.txt
    
    返回:
    
    真实的路径
    
    另请参阅:
    
    UZUtility.makeRealPath(String, UZWidgetInfo)

类 UZModuleContext

方法概要

从类继承的方法 java.lang.Object

方法详细资料

success

success

error

interrupt

getContext

empty

optInt

optInt

optLong

optLong

optString

optString

optBoolean

optBoolean

optDouble

optDouble

optJSONObject

optJSONArray

optObject

get

isNull

makeAbsUrl

makeRealPath