程序包 Seng.Shi.Hou.Duan.Yun.SDK

类 后端云对接类

java.lang.Object
Seng.Shi.Hou.Duan.Yun.SDK.后端云对接类
所有已实现的接口:
API, Seng.Shi.Hou.Duan.Yun.SDK.常量池.POST
public class 后端云对接类 extends Object implements API, Seng.Shi.Hou.Duan.Yun.SDK.常量池.POST
API接口的具体实现。 此类需要有访问网络的权限，您需要在AndroidManifest.xml中声明网络权限。 要使用此类，您需要在圣使后端云系统中拥有账号！
作者:
驻魂圣使

  • 嵌套类概要

    从接口继承的嵌套类/接口 Seng.Shi.Hou.Duan.Yun.SDK.API

    API.登录回调, API.读取公告回调, API.检查更新回调, API.解除绑定回调, API.卡密登录回调, API.使用卡密回调, API.收到数据, API.修改密码回调, API.注册回调

  • 字段概要

    从接口继承的字段 Seng.Shi.Hou.Duan.Yun.SDK.常量池.POST

    __PASS, __POWER, __UID, __UIDName, __UPDATE_PASS, __USER, __USER_ID, __XM_ID

  • 构造器概要

    构造器
    构造器
    说明
    后端云对接类​(android.content.Context context, int 项目ID)
    已过时。
    后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值)
    此构造函数生成的对象可以显式规定签名校验和签名密钥的值
    后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值, int 允许时间误差)
    此构造函数生成的对象可以显式规定签名校验和签名密钥的值
    后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值, int 允许时间误差, String 服务器地址)
    此构造函数生成的对象可以显式规定签名校验和签名密钥的值

  • 方法概要

    修饰符和类型
    方法
    说明
    long
    get服务器时间()
    执行判断会员等影响计费的敏感操作时，不要使用客户端本地时间。
    String
    get原始数据()
    读取服务器上一次响应的数据
    void
    setPinning​(boolean pinning)
    设置是否启用证书固定 启用证书固定之后，SDK会验证服务器的公钥证书是否可信，可有效防范中间人攻击。
    void
    setServerPublicKey​(String publicKey)
    设置服务器的公钥，SDK中已经内置了公钥证书，一般情况下您无需改动。
    void
    setSign​(boolean Sign)
    是否开启数字签名，启用此设置后，SDK会校验服务器响应数据的数字签名，用以保证数据安全
    void
    set证书链​(ling.android.操作.okhttp.证书 证书链)
    SDK内部已经设置好了服务器的公钥证书，如果服务器更换了公钥证书而没有及时提供新的SDK 那么您可以通过此方法来设置新的公钥证书。
    void
    登录账号​(String 账号, String 密码, API.登录回调 回调)
    登录账号
    void
    读取公告​(API.读取公告回调 回调)
    读取公告
    void
    检查更新​(int 当前版本号, API.检查更新回调 回调)
    检查服务器是否有更新版本
    void
    解绑卡密​(String 卡号, API.解除绑定回调 回调)
    解除一张卡密绑定的设备，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置且启用设备绑定功能。
    void
    解绑账号​(String user, String pass, API.解除绑定回调 回调)
    如果您的项目启用了绑定设备功能
    那么您将会需要这个API
    此API可以解除账号和设备的绑定
    请注意！
    void
    卡密登录​(String 卡号, API.卡密登录回调 回调)
    使用卡密直接登录，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置。
    void
    使用卡密​(int 账户ID, String 卡号, String 授权码, API.使用卡密回调 回调)
    此方法用于使用卡密 后端云的卡密绑定账户，既卡密的面额在使用之后就加到账户的会员时间之中 使用卡密过后，账户的会员时间会增加，您只需要在登录时判断会员时间戳是否大于当前时间戳即可 无需重复使用卡密 卡密使用过后既销毁，无法重复使用 请注意！
    void
    修改密码​(账户数据类 user_data, String 原始密码, String 修改后的密码, API.修改密码回调 回调)
    修改账户的密码
    void
    注册账号​(String 账号, String 密码, String 昵称, String 邮箱, API.注册回调 回调)
    注册一个账户到后端云中 您无需检查邮箱格式是否正确 服务器会代您执行检查 或者您可以调用验证码接口验证邮箱合法性
    void
    注册账号​(String 账号, String 密码, String 昵称, API.注册回调 回调)
    注册一个账户到后端云中，此如果您的项目设置了必须输入邮箱，那么此方法调不通。
    void
    注册账号​(String 账号, String 密码, API.注册回调 回调)
    注册一个账户到后端云中 此方法用于不需要邮箱的项目，如果您的项目设置了必须输入邮箱，那么此方法调不通 此方法注册的账户会使用默认昵称 使用默认昵称时，后台可能不好区分账户，所以不建议使用此方法

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

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 构造器详细资料

    • 后端云对接类

      public 后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值)
      此构造函数生成的对象可以显式规定签名校验和签名密钥的值
      参数:
      context - 当前上下文环境
      项目ID - 此处为你要对接的项目ID，可以在圣使后端云客户端中查看。 API靠项目ID来区分不同项目， 这个值不会改变。
      摘要校验 - 这个值用来确定要不要开启数据包摘要检查，开启之后服务器会对下行数据附加摘要，会检查上行数据的摘要。 客户端会对上行数据附加摘要，会检查下行数据的摘要， 以此来保证数据没有被篡改。 如果启用此设置，服务器会强制要求所有上行数据必须附加摘要， 如果关闭此设置，则以上效果都不会生效。 这个值要和项目的设置一致才能正常工作。
      摘要盐值 - 摘要校验的盐值，后端云通过这个盐值来保证通信安全。 在摘要校验启用时，数据包的摘要和校验都通过这个盐值进行， 盐值可以在APP内更换，但是更换盐值之后，没有同步更新的APP就无法和服务器建立连接了。 摘要要和项目的设置值一致才能正常工作。

    • 后端云对接类

      public 后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值, int 允许时间误差)
      此构造函数生成的对象可以显式规定签名校验和签名密钥的值
      参数:
      context - 当前上下文环境
      项目ID - 此处为你要对接的项目ID，可以在圣使后端云客户端中查看 API靠项目ID来区分不同项目 这个值不会改变
      摘要校验 - 这个值用来确定要不要开启数据包摘要检查，开启之后服务器会对下行数据附加摘要，会检查上行数据的摘要。 客户端会对上行数据附加摘要，会检查下行数据的摘要， 以此来保证数据没有被篡改。 如果启用此设置，服务器会强制要求所有上行数据必须附加摘要， 如果关闭此设置，则以上效果都不会生效。 这个值要和项目的设置一致才能正常工作。
      摘要盐值 - 摘要校验的盐值，后端云通过这个盐值来保证通信安全。 在摘要校验启用时，数据包的摘要和校验都通过这个盐值进行， 盐值可以在APP内更换，但是更换盐值之后，没有同步更新的APP就无法和服务器建立连接了。 摘要要和项目的设置值一致才能正常工作。
      允许时间误差 - SDK将检查收到的数据包中携带的时间戳，如果时间戳相对当前时间差距超过此阈值（单位秒），则不接受此数据包。 如果你的用户距离服务器（上海）比较远，或者网络波动较大，那么这个阈值需要设置的长一些。默认值30秒。

    • 后端云对接类

      public 后端云对接类​(android.content.Context context, int 项目ID, boolean 摘要校验, String 摘要盐值, int 允许时间误差, String 服务器地址)
      此构造函数生成的对象可以显式规定签名校验和签名密钥的值
      参数:
      context - 当前上下文环境。
      项目ID - 此处为你要对接的项目ID，可以在圣使后端云客户端中查看。 API靠项目ID来区分不同项目， 这个值不会改变。
      摘要校验 - 这个值用来确定要不要开启数据包摘要检查，开启之后服务器会对下行数据附加摘要，会检查上行数据的摘要。 客户端会对上行数据附加摘要，会检查下行数据的摘要， 以此来保证数据没有被篡改。 如果启用此设置，服务器会强制要求所有上行数据必须附加摘要， 如果关闭此设置，则以上效果都不会生效。 这个值要和项目的设置一致才能正常工作。
      摘要盐值 - 摘要校验的盐值，后端云通过这个盐值来保证通信安全。 在摘要校验启用时，数据包的摘要和校验都通过这个盐值进行， 盐值可以在APP内更换，但是更换盐值之后，没有同步更新的APP就无法和服务器建立连接了。 摘要要和项目的设置值一致才能正常工作。
      允许时间误差 - SDK将检查收到的数据包中携带的时间戳，如果时间戳相对当前时间差距超过此阈值（单位秒），则不接受此数据包。 如果你的用户距离服务器（上海）比较远，或者网络波动较大，那么这个阈值需要设置的长一些。默认值30秒。
      服务器地址 - 此处用于指定服务器的地址，一般情况下您无需关心。

    • 后端云对接类

      @Deprecated public 后端云对接类​(android.content.Context context, int 项目ID)
      已过时。
      此构造函数生成的对象不会启用签名校验，这非常危险！
      参数:
      context - 当前上下文环境。
      项目ID - 此处为你要对接的项目ID，可以在圣使后端云客户端中查看。 API靠项目ID来区分不同项目， 这个值不会改变。

  • 方法详细资料

    • 读取公告

      public void 读取公告​(@NotNull API.读取公告回调 回调)
      读取公告
      指定者:
      读取公告 在接口中 API
      参数:
      回调 - 回调方法

    • 检查更新

      public void 检查更新​(int 当前版本号, @NotNull API.检查更新回调 回调)
      从接口复制的说明: API
      检查服务器是否有更新版本
      指定者:
      检查更新 在接口中 API
      参数:
      当前版本号 - 服务器依靠版本号来判断当前请求的客户端版本和服务器上的众多版本之间的新旧关系。 当您在管理端发布新版本时，版本号一栏请务必填写和APP一样的版本号，且新的版本号必须比历史所有版本都大。 此参数建议和您项目的versionCode的值相同。
      回调 - 回调方法，此值为null时，检查更新的请求不会实际提交到服务器。

    • 使用卡密

      public void 使用卡密​(int 账户ID, String 卡号, String 授权码, @NotNull API.使用卡密回调 回调)
      从接口复制的说明: API
      此方法用于使用卡密 后端云的卡密绑定账户，既卡密的面额在使用之后就加到账户的会员时间之中 使用卡密过后，账户的会员时间会增加，您只需要在登录时判断会员时间戳是否大于当前时间戳即可 无需重复使用卡密 卡密使用过后既销毁，无法重复使用 请注意！使用卡密之后您需要重新调用登录接口获取账户最新数据！！
      指定者:
      使用卡密 在接口中 API

    • 登录账号

      public void 登录账号​(String 账号, String 密码, @NotNull API.登录回调 回调)
      登录账号
      指定者:
      登录账号 在接口中 API
      参数:
      账号 - 登录账户的账号。
      密码 - 登录账户的密码。
      回调 - 回调方法，请注意！回调方法为null时，登录请求并不会真的提交到服务器！

    • 注册账号

      public void 注册账号​(String 账号, String 密码, API.注册回调 回调)
      从接口复制的说明: API
      注册一个账户到后端云中 此方法用于不需要邮箱的项目，如果您的项目设置了必须输入邮箱，那么此方法调不通 此方法注册的账户会使用默认昵称 使用默认昵称时，后台可能不好区分账户，所以不建议使用此方法
      指定者:
      注册账号 在接口中 API

    • 注册账号

      public void 注册账号​(String 账号, String 密码, String 昵称, API.注册回调 回调)
      从接口复制的说明: API
      注册一个账户到后端云中，此如果您的项目设置了必须输入邮箱，那么此方法调不通。
      指定者:
      注册账号 在接口中 API

    • 注册账号

      public void 注册账号​(String 账号, String 密码, String 昵称, String 邮箱, @NotNull API.注册回调 回调)
      从接口复制的说明: API
      注册一个账户到后端云中 您无需检查邮箱格式是否正确 服务器会代您执行检查 或者您可以调用验证码接口验证邮箱合法性
      指定者:
      注册账号 在接口中 API

    • 卡密登录

      public void 卡密登录​(String 卡号, @NotNull API.卡密登录回调 回调)
      使用卡密直接登录，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置。
      请注意，切换单码登录设置的值，将会导致您项目中的卡密数据定义模糊，污染卡密。
      如果您必须切换登录模式，系统会代您删除所有脏污数据，无法撤销！
      指定者:
      卡密登录 在接口中 API
      参数:
      卡号 - 卡号
      回调 - 回调

    • 解绑卡密

      public void 解绑卡密​(String 卡号, @NotNull API.解除绑定回调 回调)
      解除一张卡密绑定的设备，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置且启用设备绑定功能。
      请注意，切换单码登录设置的值，将会导致您项目中的卡密数据定义模糊，污染卡密。
      如果您必须切换登录模式，系统会代您删除所有脏污数据，无法撤销！
      指定者:
      解绑卡密 在接口中 API
      参数:
      卡号 - 卡号
      回调 - 回调

    • 解绑账号

      public void 解绑账号​(String user, String pass, @NotNull API.解除绑定回调 回调)
      如果您的项目启用了绑定设备功能
      那么您将会需要这个API
      此API可以解除账号和设备的绑定
      请注意！
      解除绑定不会验证请求的设备是否是绑定的设备
      既只要拥有账号和密码，且账号解绑间隔时间内没有解除过绑定，就可以请求解除绑定！
      指定者:
      解绑账号 在接口中 API
      参数:
      user - 用户账号
      pass - 账号密码
      回调 - 回调方法

    • setPinning

      public void setPinning​(boolean pinning)
      设置是否启用证书固定 启用证书固定之后，SDK会验证服务器的公钥证书是否可信，可有效防范中间人攻击。 请注意！服务器提供商可能在任何时候更换证书，证书更换之后APP将无法连接至服务器！ 更换证书将会提前在APP内通知开发者
      指定者:
      setPinning 在接口中 API
      参数:
      pinning - 是否启用？

    • set证书链

      public void set证书链​(ling.android.操作.okhttp.证书 证书链)
      SDK内部已经设置好了服务器的公钥证书，如果服务器更换了公钥证书而没有及时提供新的SDK 那么您可以通过此方法来设置新的公钥证书。 证书链所有对象共享。
      指定者:
      set证书链 在接口中 API
      参数:
      证书链 -

    • get服务器时间

      public long get服务器时间()
      执行判断会员等影响计费的敏感操作时，不要使用客户端本地时间。
      因为简单的修改系统时间就能绕过。
      您可以利用此方法来获取服务器时间。
      不过，您需要注意，调用此方法并不会真的请求服务器。
      而是将上一次请求服务器时服务器响应的时间戳返回给您。
      换句话说，此方法获取到的时间是客户端上次请求服务器时的时间。
      如果客户端在本次运行期间没有请求过服务器的任何API，那么此方法的返回值将会是0！
      返回:
      上次请求服务器时服务器返回的时间戳

    • get原始数据

      public String get原始数据()
      读取服务器上一次响应的数据
      指定者:
      get原始数据 在接口中 API
      返回:
      上一次响应

    • 修改密码

      public void 修改密码​(账户数据类 user_data, String 原始密码, String 修改后的密码, @NotNull API.修改密码回调 回调)
      修改账户的密码
      指定者:
      修改密码 在接口中 API
      参数:
      user_data - 登录API返回的账户数据对象
      原始密码 - 账号的原始密码
      修改后的密码 - 修改后的密码

    • setSign

      public void setSign​(boolean Sign)
      是否开启数字签名，启用此设置后，SDK会校验服务器响应数据的数字签名，用以保证数据安全
      指定者:
      setSign 在接口中 API
      参数:
      Sign - 是否启用数字签名

    • setServerPublicKey

      public void setServerPublicKey​(String publicKey) throws Exception
      设置服务器的公钥，SDK中已经内置了公钥证书，一般情况下您无需改动。
      指定者:
      setServerPublicKey 在接口中 API
      参数:
      publicKey - 公钥
      抛出:
      Exception - 公钥格式错误