com.juphoon.lemon.MtcCli 类参考
详细描述
MtcCli 接口
静态 Public 成员函数
static int | Mtc_CliInit (String pcProfDir) |
初始化客户端资源。 更多 | |
static void | Mtc_CliDestroy () |
销毁客户端资源。 更多 | |
static int | Mtc_CliOpen (String pcUserName) |
打开一个账户。 更多 | |
static void | Mtc_CliClose () |
关闭当前账户。 更多 | |
static int | Mtc_CliStart () |
开启客户端业务。 更多 | |
static void | Mtc_CliStop () |
停止客户端业务。 更多 | |
static int | Mtc_CliLogin (int iAccNetType, String pcAccNetIp) |
开始登陆客户端。 更多 | |
static int | Mtc_CliEnterAkaRsp (int iCookie, String pcRsp, String pcCk, String pcIk, String pcAuts) |
输入 aka 的应答再次登陆客户端。 更多 | |
static int | Mtc_CliEnterDgstPwd (int iCookie, String pcPwd) |
输入摘要密码再次登陆客户端。 更多 | |
static int | Mtc_CliRefresh () |
刷新注册。 更多 | |
static int | Mtc_CliLogout () |
开始注销客户端。 更多 | |
static int | Mtc_CliInfo (String pcType, String pcInfo) |
发送信息消息。 更多 | |
static int | Mtc_CliGetRegState () |
获取用户注册状态。 更多 | |
static int | Mtc_CliDrive (int zEvntId) |
客户端驱动业务。 更多 | |
static int | Mtc_CliDetLclIp () |
发现可用本地IP地址。 注册模式下可用。 更多 | |
static int | Mtc_CliDetLclIp2 () |
根据注册和集合代理发现可用本地IP地址。 在注册模式下可用。 更多 | |
static String | Mtc_CliGetDevId () |
获取设备ID字符串。 更多 |
额外继承的成员函数
静态 Public 属性 继承自 com.juphoon.lemon.MtcCliConstants
static final int | MTC_REG_STATE_IDLE = 0 |
注册静止状态 | |
static final int | MTC_REG_STATE_REGING = 1 |
注册正在注册状态 | |
static final int | MTC_REG_STATE_REGED = 2 |
注册已注册状态 | |
static final int | MTC_REG_STATE_REREGING = 3 |
注册已注册正在注册状态 | |
static final int | MTC_REG_STATE_UNREGING = 4 |
注册取消注册状态 | |
static final int | MTC_EBASE_CP = 0xE000 |
CP 错误库 | |
static final int | MTC_EBASE_REG = 0xE100 |
REG 错误库 | |
static final int | MTC_EBASE_CALL = 0xE200 |
CALL 错误库 | |
static final int | MTC_EBASE_VSHARE = 0xE300 |
VSHARE 错误库 | |
static final int | MTC_EBASE_CAP = 0xE400 |
CAP 错误库 | |
static final int | MTC_EBASE_BUDDY = 0xE500 |
BUDDY 错误库 | |
static final int | MTC_EBASE_GRP = 0xE600 |
GRP 错误库 | |
static final int | MTC_EBASE_CONF = 0xE700 |
CONF 错误库 | |
static final int | MTC_EBASE_GS = 0xE800 |
GS 错误库 | |
static final int | MTC_EBASE_PRES = 0xE900 |
PRES 错误库 | |
static final int | MTC_EBASE_IM = 0xEA00 |
IM 错误库 | |
static final int | MTC_EBASE_CONTACT = 0xEB00 |
CONTACT 错误库 | |
static final int | MTC_EBASE_LOG = 0xEC00 |
LOG 错误库 | |
static final int | MTC_EBASE_LCS = 0xED00 |
LCS 错误库 | |
static final int | MTC_CLI_ERR_NO = (0xE100+0) |
没有错误. | |
static final int | MTC_CLI_ERR_LCL_FAILED = (0xE100+1) |
本地请求错误。 | |
static final int | MTC_CLI_REG_ERR_SEND_MSG = (0xE100+2) |
发送消息错误。 | |
static final int | MTC_CLI_REG_ERR_AUTH_FAILED = (0xE100+3) |
注册授权失败,无效用户或密码. | |
static final int | MTC_CLI_REG_ERR_INVALID_USER = (0xE100+4) |
注册使用无效用户。 | |
static final int | MTC_CLI_REG_ERR_TIMEOUT = (0xE100+5) |
注册超时 | |
static final int | MTC_CLI_REG_ERR_SERV_BUSY = (0xE100+6) |
注册服务器正忙。 | |
static final int | MTC_CLI_REG_ERR_SERV_NOT_REACH = (0xE100+7) |
注册服务器不可及。 | |
static final int | MTC_CLI_REG_ERR_SRV_FORBIDDEN = (0xE100+8) |
注册被禁止。 | |
static final int | MTC_CLI_REG_ERR_SRV_UNAVAIL = (0xE100+9) |
注册不可用。 | |
static final int | MTC_CLI_REG_ERR_DNS_QRY = (0xE100+10) |
注册 dns 请求错误。 | |
static final int | MTC_CLI_REG_ERR_NETWORK = (0xE100+11) |
注册网络错误 | |
static final int | MTC_CLI_REG_ERR_DEACTED = (0xE100+12) |
注册不活跃。 | |
static final int | MTC_CLI_REG_ERR_PROBATION = (0xE100+13) |
注册试用 | |
static final int | MTC_CLI_REG_ERR_INTERNAL = (0xE100+14) |
注册内部错误。 | |
static final int | MTC_CLI_REG_ERR_NO_RESOURCE = (0xE100+15) |
注册没有资源 | |
static final int | MTC_CLI_REG_ERR_OTHER = (0xE100+16) |
其他注册错误。 | |
static final int | MTC_ANET_UNAVAILABLE = -2 |
static final int | MTC_ANET_未知 = -1 |
static final int | MTC_ANET_MOBILE = 0x0000 |
static final int | MTC_ANET_MOBILE_GPRS = 0x0001 |
static final int | MTC_ANET_MOBILE_EDGE = 0x0002 |
static final int | MTC_ANET_MOBILE_UMTS = 0x0003 |
static final int | MTC_ANET_MOBILE_CDMA = 0x0004 |
static final int | MTC_ANET_MOBILE_EVDO_0 = 0x0005 |
static final int | MTC_ANET_MOBILE_EVDO_A = 0x0006 |
static final int | MTC_ANET_MOBILE_1XRTT = 0x0007 |
static final int | MTC_ANET_MOBILE_HSDPA = 0x0008 |
static final int | MTC_ANET_MOBILE_HSUPA = 0x0009 |
static final int | MTC_ANET_MOBILE_HSPA = 0x000A |
static final int | MTC_ANET_MOBILE_IDEN = 0x000B |
static final int | MTC_ANET_MOBILE_EVDO_B = 0x000C |
static final int | MTC_ANET_MOBILE_LTE = 0x000D |
static final int | MTC_ANET_MOBILE_EHRPD = 0x000E |
static final int | MTC_ANET_MOBILE_HSPAP = 0x000F |
static final int | MTC_ANET_WIFI = 0x0100 |
static final int | MTC_ANET_WIMAX = 0x0600 |
static final int | MTC_ANET_BLUETOOTH = 0x0700 |
static final int | MTC_ANET_ETHERNET = 0x0900 |
static final int | MTC_ANET_MASK_CATEGORY = 0xFF00 |
成员函数说明
static void com.juphoon.lemon.MtcCli.Mtc_CliClose () static
关闭当前账户。
static void com.juphoon.lemon.MtcCli.Mtc_CliDestroy () static
销毁客户端资源。
static int com.juphoon.lemon.MtcCli.Mtc_CliDetLclIp () static
发现可用本地IP地址。 注册模式下可用。
若用户通过 MtcCliCfg.Mtc_CliCfgSetUseDetLclIp 开启,客户端将自动 在开启业务并登录前调用它。
- 返回值
-
MtcCommonConstants::ZOK 发现可用本地 IP 成功。 MtcCommonConstants::ZFAILED 发现可用本地 IP 失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliDetLclIp2 () static
根据注册和集合代理发现可用本地IP地址。 在注册模式下可用。
若用户通过 MtcCliCfg.Mtc_CliCfgSetUseDetLclIp, 开启,客户端将自动, 在开启服务器前调用它,并且仅当集合代理存在时才会登陆。
- 返回值
-
MtcCommonConstants::ZOK 发现可用本地 IP 成功。 MtcCommonConstants::ZFAILED 发现可用本地 IP 失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliDrive (int zEvntId) static
客户端驱动业务。
MTC 业务由MSF执行,用以多线程模式, MSF 在独立线程下运行,RUI在另一线程下运行。 MTC 应用业务登陆GUI,因此在GUI中运行。 当MSF需要通知状态到GUI,事件需要在两个线程下转移。 为了线程安全,业务事件将由 GUI 回调 mtcCliCbEvnt 从 MSF 发送到 GUI。 GUI 将通过此业务时间驱动 MTC。
- 参数
-
[in] zEvntId 来自 RSD 的业务事件。
- 返回值
-
MtcCommonConstants::ZOK 驱动业务成功。 MtcCommonConstants::ZFAILED 驱动业务失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliEnterAkaRsp (int iCookie, String pcRsp, String pcCk, String pcIk, String pcAuts ) static
输入 aka 的应答再次登陆客户端。
若 MtcCliDb.Mtc_CliDbGetAuthType 返回 EN_MTC_IMS_AUTH_IMS_AKA, 登陆结果将由 mtcCliCbAuthInd 所设置的回调通知,客户端必须输入 aka 的应答再次登陆。
- 返回值
-
MtcCommonConstants::ZOK 客户端正在登陆。 MtcCommonConstants::ZFAILED 客户端登录失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliEnterDgstPwd (int iCookie, String pcPwd ) static
输入摘要密码再次登陆客户端。
若 MtcCliDb.Mtc_CliDbGetAuthType 返回 EN_MTC_IMS_AUTH_SIP_DIGEST, 登陆结果将由 mtcCliCbAuthInd 所设置的回调通知。若之前没有可用密码, 客户端必须输入摘要密码再次登陆。
- 返回值
-
MtcCommonConstants::ZOK 客户端正在登陆。 MtcCommonConstants::ZFAILED 客户端登录失败。
static String com.juphoon.lemon.MtcCli.Mtc_CliGetDevId () static
获取设备ID字符串。
- 返回
- 设备ID字符串。
static int com.juphoon.lemon.MtcCli.Mtc_CliGetRegState () static
获取用户注册状态。
- 返回
- 注册状态。状态见 MTC_REG_STATE_IDLE...
static int com.juphoon.lemon.MtcCli.Mtc_CliInfo (String pcType, String pcInfo ) static
发送信息消息。
- 参数
-
[in] pcType 内容类型字符串,“纯文本”为 ZNULL。 [in] pcInfo 信息消息内容字符串。
- 返回值
-
MtcCommonConstants::ZOK 发送信息成功。 MtcCommonConstants::ZFAILED 发送信息失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliInit (String pcProfDir) static
初始化客户端资源。
- 参数
-
[in] pcProfDir Profile directory
- 返回值
-
MtcCommonConstants::ZOK 初始化客户端资源成功。 MTC_LCS_ERR_NEED_ACT_LICSEN,初始化客户端资源失败, 你应该调用 Mtc_lcsActivate 活跃认证人。 &retval MtcCommonConstants::ZFAILED,初始化客户端资源失败。
- 参见
- MtcCli.Mtc_CliDestroy Mtc_CliCfgSetLicenseFileName first
static int com.juphoon.lemon.MtcCli.Mtc_CliLogin (int iAccNetType, String pcAccNetIp ) static
开始登陆客户端。
- 参数
-
[in] iAccNetType 接入网络类型 MtcCliDbConstants::EN_MTC_ACC_NET_UNKNOWN。 [in] pcAccNetIp 接入网络IP字符串。 If MtcCliDb.Mtc_CliDbGetUserReg 返回 true, 登陆结果将由 mtcCliCbRegOk, mtcCliCbRegFailed, mtcCliCbServLoginOk 或 mtcCliCbLclLoginOk 或 mtcCliCbLoginFailed 或 mtcCliCbAuthInd 所设置的回调通知。 否则,说明客户端不需要登陆到远程服务器, 并且将不需要任何GUI回调,立即返回。
- 返回值
-
MtcCommonConstants::ZOK 客户端正在登陆。 MtcCommonConstants::ZFAILED 客户端登录失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliLogout () static
开始注销客户端。
若 Mtc_DbGetUserReg 返回 true,注销结果将由 mtcCliCbLclLogout 和 mtcCliCbServLogout 所设置的回调通知。
- 返回值
-
MtcCommonConstants::ZOK 客户端正在注销。 MtcCommonConstants::ZFAILED 客户端注销失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliOpen (String pcUserName) static
打开一个账户。
- 参数
-
[in] pcUserName 账户名称。 若账户名称为 ZNULL, 它将加载默认账户信息。 更改参数,调用 MtcCliDb.Mtc_CliDbSetLocalIp 等函数。
- 返回值
-
MtcCommonConstants::ZOK 开启一个账户成功。 MtcCommonConstants::ZFAILED 初始化账户失败。
static int com.juphoon.lemon.MtcCli.Mtc_CliRefresh () static
刷新注册。
这一接口用于发送重新注册消息以刷新 服务器上的注册信息。尽管SDK将根据到期时长 自动发送重新注册消息,但在某些情况下客户当想要发送 重新注册消息以保持有效的 注册信息。如在手机平台, SDK将不会根据背景模式及时发送重新注册消息。 这一情况下,应用应该调用此接口手动发送 重新注册消息,发现背景模式吓可能出现的错误。 这一接口只有在客户端登陆后才能被调用。 mtcCliCbLclLoginOk.
- 返回值
-
MtcCommonConstants::ZOK 客户端发送重新注册消息成功。 MtcCommonConstants::ZFAILED 客户端发送重新注册消息失败。