CDMA无线定位业务应用编程接口(API)技术规范(中兴)(5)

Interface>> IpAppUserLocationNetwork (from uln) locationReportRes() locationReportErr() periodicLocationReport() periodicLocationReportErr() triggeredLocationReport() triggeredLocationReportEr...
<> IpUserLocationNetwork (from uln) locationReportReq() periodicLocationReportingStartReq() periodicLocationReportingStop() triggeredLocationReportingStartRe... triggeredLocationReportingStop() 图７ － ２ 基于网络的用户定位接口类层次图　
　　
7.3 用户状态接口类层次图 下图给出了用户状态业务接口类之间的关系图 　
19 / 19
无线定位业务应用编程接口
API
技术规范
<> IpAppUserStatus (from us) statusReportRes() statusReportErr() triggeredStatusReport() triggeredStatusReportErr()
<> IpUserStatus (from us) statusReportReq() triggeredStatusReportingStartReq() triggeredStatusReportingStop() 图７ － ３ 　 　 用户状态接口类层次图　
　
20 / 20
无线定位业务应用编程接口 　
API
技术规范
8 业务接口规范 8.1 接口规范格式 本节定义与 ＡＰＩ 规范相关的接口 以下是接口规范的一般格式描述 　 方法和参数格式 对接口类的描述采用统一建模语言（ＵＭＬ）
8.1.1
接口类
这部分给出了接口类的 ＵＭＬ 描述 包括此接口类支持的方法 相关参数及其类型 支持客户应 用的业务 Ｓｅｒｖｉｃｅ 和框架（Ｆｒａｍｅｗｏｒｋ）接 口 类 由　Ｉｐ＜ｎａｍｅ＞标识 用于回调的应用接口类由 ＩｐＡｐｐ＜ｎａｍｅ＞标识 对于业务和框架间的接口 业务接口典型地由 ＩｐＳｖｃ　＜ｎａｍｅ＞标识 而框架接口 由 ＩｐＦｗ＜ｎａｍｅ＞标识 　
8.1.2
方法描述
这部分将描述接口类中的每个 ＡＰＩ 方法 如果 ＡＰＩ 方法返回一个类型为 ＴｐＲｅｓｕｌｔ 值 则是对调 用执行成功或失败的标识 不允许取其它值 　 在 ＡＰＩ 中 分同步调用和和异步调用两类方法 对于一个请求而言 异步调用方法用一个 Ｒｅｑ 后缀标识 如果对该请求存在对应的异步方法 则分别用 Ｒｅｓ 和 Ｅｒｒ 后缀标识返回结果和错 误 为了处理响应和报告 应用或业务开发商必须实现相关的 ＩｐＡｐｐ＜ｎａｍｅ＞或 ＩｐＳｖｃ＜ｎａｍｅ＞接口以提 供回调机制 　
8.1.3
参数描述
这部分将描述每个方法的参数及其可能取值 带有 ｉｎ 　描述的参数表示在调用此方法时应给 该参数赋值 那些带有 ｏｕｔ 　描述的参数在调用此方法后必须返回执行结果 　
8.1.4
状态模型 则在实现此接口对象时应给出其状态模型 　
如果一个接口对象与状态相关
21 / 21
无线定位业务应用编程接口
API
技术规范
8.2 基本接口
8.2.1
IpInterface 接口类
所有应用 ａｐｐｌｉｃａｔｉｏｎ 框架（ｆｒａｍｅｗｏｒｋ）和业务

　（ｓｅｒｖｉｃｅ）　 接口均继承下面的接口 此 ＡＰＩ 基本接口不提供任何额外的方法 　 ＜＜Ｉｎｔｅｒｆａｃｅ＞＞　 ＩｐＩｎｔｅｒｆａｃｅ　 　 　
8.3 业务接口
8.3.1
概览
业务接口 Ｓｅｒｖｉｃｅ　Ｉｎｔｅｒｆａｃｓ 提供下层网络能力的接口　 　诸如移动性（ｍｏｂｉｌｉｔｙ） 呼叫控 制 ｃａｌｌ　ｃｏｎｔｒｏｌ 用户交互（ｕｓｅｒ　ｉｎｔｅｒａｃｔｉｏｎ） 消息 ｍｅｓｓａｇｉｎｇ 以及互通性管理 ｃｏｎｎｅｃｔｉｖｉｔｙ　 ｍａｎａｇｅｍｅｎｔ 　 由业务实现的接口被标记为 业务接口 与之对应的由应用实现的接口（如 ＡＰＩ 回调）被标记为 应用接口 　
8.4 一般业务接口
8.4.1
Ｉ ｐ Ｓ ｅ ｒ ｖ ｉ ｃ ｅ 接口类 　　 ＜＜Ｉｎｔｅｒｆａｃｅ＞＞　 ＩｐＳｅｒｖｉｃｅ　
继承自 ＩｐＩｎｔｅｒｆａｃｅ 　 所有业务接口均继承下面的接口
　 ｓｅｔＣａｌｌｂａｃｋ　（ａｐｐＩｎｔｅｒｆａｃｅ ｉｎ　ＩｐＩｎｔｅｒｆａｃｅＲｅｆ） ｖｏｉｄ　 ｉｎ　ＴｐＳｅｓｓｉｏｎＩＤ） ｖｏｉｄ　
ｓｅｔＣａｌｌｂａｃｋＷｉｔｈＳｅｓｓｉｏｎＩＤ　（ａｐｐＩｎｔｅｒｆａｃｅ
ｉｎ　ＩｐＩｎｔｅｒｆａｃｅＲｅｆ，　ｓｅｓｓｉｏｎＩＤ
方法　 ｓｅｔＣａｌｌｂａｃｋ（）　 此方法提供业务回调应用接口的地址 对于须使用对话标识 ＳｅｓｓｉｏｎＩＤ 参数的情形 禁止调 22 / 22
无线定位业务应用编程接口 用此方法 　
API
技术规范
参数　 appInterface in IpInterfaceRef 此参数提供业务回调应用接口的地址 　
异常　 TpCommonExceptions
方法　 ｓｅｔＣａｌｌｂａｃｋＷｉｔｈＳｅｓｓｉｏｎＩＤ（）　 此方法提供与对话标识 ｓｅｓｓｉｏｎ　ＩＤ 参数相关的业务回调应用接口的地址 标识 ＳｅｓｓｉｏｎＩＤ 参数的情形 禁止调用此方法 　 对于不使用对话
参数　 appInterface in IpInterfaceRef 此参数提供业务回调应用接口的地址 　 　
sessionID in TpSessionID 此参数标识业务回调应用接口的对话
异常　 TpCommonExceptions
23 / 23
无线定位业务应用编程接口 　
API
技术规范
9 移动性接口类 9.1 用户定位接口类 用户定位　（ＵＬ）　 业务为用户提供了一般的地理位置信息服务 ＵＬ 具备允许应用 Ａｐｐｌｉｃａｔｉｏｎ 获得用户地理位置以及固定用户 移动用户和基于 ＩＰ 的电话用户状态信息的能力 　　 基于网络的用户定位 ＵＬＮ 业务是 ＵＬ 业务的一种补充 用以提供与网络相关的信息 也有一 些专门的功能处理用户紧急定位业务 ＵＬＥ Ｕｓｅｒ　Ｌｏｃａｔｉｏｎ　Ｅｍｅｒｇｅｎｃｙ　

中的紧急呼叫 　　 ＵＬ 业务提供 ＩｐＵｓｅｒＬｏｃａｔｉｏｎ 和 ＩｐＴｒｉｇｇｅｒｅｄＵｓｅｒＬｏｃａｔｉｏｎ 两个接口类 接口类中的多数方法 是异步的 在调用这些方法时 不必为了等待执行结果而锁定一个线程 在这种情况下 与同步方 法相比 客户机就可以处理更多的异步调用 为了对业务的请求做出响应和报告用户的位置信息 开发商必须在应用侧实现 ＩｐＡｐｐＵｓｅｒＬｏｃａｔｉｏｎ 和　ＩｐＡｐｐＴｒｉｇｇｅｒｅｄＵｓｅｒＬｏｃａｔｉｏｎ 接口类 以提供业 务的回调机制 　 当使用定期或触发式位置信息报告请求时 错误报告分两种 一是与请求中单个用户有关的错 误报告 二是涉及请求中所有用户时 调用相关的错误处理方法 　
9.1.1
IpUserLocation 接口类
继承自 ＩｐＳｅｒｖｉｃｅ 　 此接口是用户定位业务 Ｕｓｅｒ　Ｌｏｃａｔｉｏｎ　Ｓｅｒｖｉｃｅ 的 业务管理者 接口 　 用户定位接口向用户定位业务提供管理功能 应用开发商可以调用此接口来获得用户的地理位 置信息 　　 ＜＜Ｉｎｔｅｒｆａｃｅ＞＞　 ＩｐＵｓｅｒＬｏｃａｔｉｏｎ　 　 ｌｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｑ　（ａｐｐＬｏｃａｔｉｏｎ ｉｎ　ＩｐＡｐｐＵｓｅｒＬｏｃａｔｉｏｎＲｅｆ，　ｕｓｅｒｓ ｉｎ　ＴｐＡｄｄｒｅｓｓＳｅｔ） ＴｐＳｅｓｓｉｏｎＩＤ　
ｅｘｔｅｎｄｅｄＬｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｑ　（ａｐｐＬｏｃａｔｉｏｎ ｉｎ　ＩｐＡｐｐＵｓｅｒＬｏｃａｔｉｏｎＲｅｆ，　ｕｓｅｒｓ ｉｎ　ＴｐＡｄｄｒｅｓｓＳｅｔ，　ｒｅｑｕｅｓｔ ｉｎ　ＴｐＬｏｃａｔｉｏｎＲｅｑｕｅｓｔ） ＴｐＳｅｓｓｉｏｎＩＤ　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔａｒｔＲｅｑ　（ａｐｐＬｏｃａｔｉｏｎ ｉｎ　ＩｐＡｐｐＵｓｅｒＬｏｃａｔｉｏｎＲｅｆ，　ｕｓｅｒｓ ｉｎ　ＴｐＡｄｄｒｅｓｓＳｅｔ，　 ｒｅｑｕｅｓｔ ｉｎ　ＴｐＬｏｃａｔｉｏｎＲｅｑｕｅｓｔ，　ｒｅｐｏｒｔｉｎｇＩｎｔｅｒｖａｌ ｉｎ　ＴｐＤｕｒａｔｉｏｎ） ＴｐＳｅｓｓｉｏｎＩＤ　 ｐｅｒｉｏｄｉｃＬｏｃａｔｉｏｎＲｅｐｏｒｔｉｎｇＳｔｏｐ　（ｓｔｏｐＲｅｑｕｅｓｔ ｉｎ　ＴｐＭｏｂｉｌｉｔｙＳｔｏｐＡｓｓｉｇｎｍｅｎｔＤａｔａ） ｖｏｉｄ　
方法　 ｌｏｃａｔｉｏｎＲｅｐｏｒｔＲｅｑ（）　 应用使用此方法向业务请求报告一个或几个用户的位置信息 对调用此方法可能产生的异常说明如下 　 P_NO_CALLBACK_ADDRESS_SET 拒绝执行此方法 因为方法中没有设置回调地址 　
2

4 / 24
无线定位业务应用编程接口 Ｐ＿ＲＥＳＯＵＲＣＥＳ＿ＵＮＡＶＡＩＬＡＢＬＥ　 所要求的网络资源不可用 应用可以尝试在稍后调用此方法 P_UNKNOWN_SUBSCRIBER 终端用户未签约此应用 P_APPLICATION_NOT_ACTIVATED 终端用户已去激活此应用 P_INFORMATION_NOT_AVAILABLE 不允许查询此终端用户位置信息