A-XLinkSDK

一、XLinkSDK

XLinkSDK是 SDK 的入口，SDK 相关的操作方法会在此类中定义，如 SDK 初始化、启动、停止或者是任务的执行等方法。

  1. 以下方法说明中明确提供不推荐使用的方法，即为不建议开发者调用或者是开发者不应该进行任何数据修改。
  2. 以下文档中未提及的方法均属于不推荐使用的方法

二、Reference

以下为此类中关联的Class及相关说明

类名 类型 说明
XLinkConfig 实体类 SDK 配置信息对象，详情请查看API-XLinkConfig.Builder
XLinkUser 实体类 用户信息对象，详情请查看API-XLinkUser
XLinkUserManager 实体类 用户管理对象，详情请查看API-XLinkUserManager
XLinkDeviceManager 实体类 设备管理对象，详情请查看API-XLinkDeviceManager

三、Methods

以下方法为开发过程常用的方法说明，参数说明及返回值说明。此处仅提供了推荐开发者使用及可能需要使用的方法，部分未列出方法请根据实际情况评估调用。

默认情况下，不推荐未列出的其它方法，即使是开放的方法，因为部分方法可能仅 SDK 内部使用。

3.1、init

public static void init(XLinkConfig config)
  • 方法说明

静态方法，使用 SDK 配置对象初始化 SDK，这是使用 SDK 的前提条件，SDK 只有初始化之后才能启动并正常使用，在 SDK 未进行初始化和启动时调用 SDK 相关的操作将会抛出异常。注意 SDK 应该只能初始化一次，如果进行多次初始化，目前并不会抛出异常，但是后续的初始化操作都将无效。不推荐使用

//注意尽管这里有SDK的初始化方法，但是在实际使用中，应该通过以下方式进行初始化，否则可能导致SDK无法正确使用到某些Android平台的特性，或者引起SDK异常
XLinkAndroidSDK.init(config);
 
//调用此方法后不再需要再调用其它初始化方法了
  • 参数说明
参数名 类型 说明
config XLinkConfig SDK 初始化的配置信息，不允许为空

注意事项：初始化 SDK 时，应该使用XLinkAndroidSDK.init(config)

3.2、deinit——自v6.2版本起

public static void deinit()
  • 方法说明

静态方法，自v6.2版本起支持，SDK 的反初始化方法，通过此方法可以终止 SDK 并且将当前 SDK 所有使用的配置清除和资源都释放，将 SDK 还原到未进行任何初始化时的状态，部分已初始化过的无状态数据将会保留。当需要切换 SDK 配置信息或者是完全终止并释放 SDK 占用的资源时，则可以使用调用此方法。

3.3、start

public static void start()
  • 方法说明

静态方法，启动 SDK，初始化 SDK 时仅仅只是设置了配置信息，而实际上未运行任何 SDK 的操作或者后台功能。正常使用 SDK 的功能必须启动 SDK，包括任务执行、XLinkRestful相关封装接口的使用都需要在启动 SDK 之后才能使用。允许多次启动 SDK，不会有任何影响。

注意事项：请注意任何调用 SDK 的位置，特别是执行任务必须启动 SDK 之后才能使用。

3.4、stop

public static void stop()
  • 方法说明

静态方法，停止 SDK，在启动 SDK 之后如果需要停止 SDK 的运行，则可以调用此方法。注意一旦停止了 SDK，则 SDK 的所有功能将不能再使用，如需要使用需要再次启动 SDK。调用此方法时，目前不会清除掉当前已登录的用户信息。

3.5、logoutAndStop

public static void logoutAndStop()
  • 方法说明

静态方法，退出当前用户的登录状态，清除用户信息并停止 SDK 的运行。相当于停止 SDK 并清除掉用户信息。调用此方法时，如果设置了用户登录状态监听回调，则会接收到用户退出登录的事件。

3.6、isStarted

public static boolean isStarted()
  • 方法说明

静态方法，判断当前 SDK 是否已经启动。

  • 返回值：boolean，布尔值；若 SDK 已经启动返回 true，否则返回 false

3.7、isInitialized

public static boolean isInitialized()
  • 方法说明

静态方法，判断当前 SDK 是否已经进行了初始化。由于 SDK 初始化操作不支持多次初始化，当多次初始化时会抛出异常信息，所以此方法可以用来确认 SDK 是否已初始化再确定是否需要进行初始化的处理。

  • 返回值：boolean，布尔值；若 SDK 已经初始化返回 true，否则返回 false

3.8、startTask

public static void startTask(Task task)
  • 方法说明

静态方法，执行一个 SDK 任务，任务不应该为空，若任务对象不存在，则不会执行任务操作。注意任务对象执行需要保证任务对象是刚初始化的状态，即任务未执行过的。每个任务仅允许执行一次。

  • 参数说明
参数名 类型 说明
task Task 任务对象，用于执行的任务。不应该为空，否则不进行执行任何操作

3.9、stopTask

public static void stopTask(Task task)
  • 方法说明

静态方法，停止一个任务，当任务正在执行中时，通过此方法可以停止一个任务。任务停止时实际上是被取消掉执行，将返回任务取消的错误码。

参数名 类型 说明
task Task 任务对象，需要停止的任务。任务对象不存在时不执行任务操作

3.10、getVersion

public static String getVersion()
  • 方法说明

静态方法，获取当前 SDK 的版本号

  • 返回值：String，SDK 版本号

3.11、connectCloud

public static void connectCloud()
  • 方法说明

静态方法，手动连接云端。不推荐使用

注意事项：
1.调用此方法时，必须确保用户信息是有效的，否则无法正确连接到云端，可能会引起一些错误信息回调，如用户凭证过期
2.调用此方法时会先停止当前的云端连接，再重新进行云端的连接
3.正常情况下都不需要手动调用此方法，通过正常的登录任务和操作 SDK 会自行维护相关的云端连接

3.12、disconnectCloud

public static void disconnectCloud()
  • 方法说明

静态方法，手动断开云端连接。此方法会断开当前的云端连接，会导致所有设备的云端通讯不再可用，用户相关的云端推送消息也将无法获取到。正常情况下都不需要手动调用此方法，SDK 会自行进行相关的维护工作。不推荐使用

3.13、getUser

@Nullable
public static XLinkUser getUser()
  • 方法说明

静态方法，获取当前 SDK 维护的用户信息。推荐直接通过用户管理对象API-XLinkUserManager获取进行相关的用户信息操作，后续可能会废弃此方法

//推荐直接通过XLinkUserManager获取相关用户信息
XLinkUser user = XLinkUserManager.getInstance().getUser()
  • 返回值：XLinkUser，用户信息对象；详情请参考API-XLinkUser

3.14、getDeviceManager

public static XLinkDeviceManager getDeviceManager()
  • 方法说明

静态方法，获取当前 SDK 的设备管理对象。推荐直接通过设备管理对象API-XLinkDeviceManager执行相关设备操作，后续可能会废弃此方法

//直接获取设备管理对象
XLinkDeviceManager DevMgr = XLinkDeviceManager.getInstance();

3.15、getUserManager

public static XLinkUserManager getUserManager()
  • 方法说明

静态方法，获取当前 SDK 的用户管理对象。推荐直接通过用户管理对象API-XLinkUserManager执行相关的用户操作，后续可能会废弃此方法

//直接获取用户管理对象
XLinkUserManager userMgr = XLinkUserManager.getInstance();

四、更新日志

日期 更新内容
2018-09-10 初稿，自 X-MQTT SDK v6.2版本起
没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题