用户工具

im_android_ui组件开发指南

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
im_android_ui组件开发指南 [2016/01/20 08:08]
liuxia
im_android_ui组件开发指南 [2017/08/23 08:44] (当前版本)
行 3: 行 3:
 说明:本指南是Android平台的接入说明,方便有Android研发基础的开发者快速了解整合云之讯即时通讯界面组件。本指南只包含paas服务器连接和IM界面组件的使用操作。如需开发出针对企业和开发者所需的个性化应用,仍然需要具备一定的Android开发经验。 说明:本指南是Android平台的接入说明,方便有Android研发基础的开发者快速了解整合云之讯即时通讯界面组件。本指南只包含paas服务器连接和IM界面组件的使用操作。如需开发出针对企业和开发者所需的个性化应用,仍然需要具备一定的Android开发经验。
  
-===== 一、IMKit界面组件介绍 ===== +===== 一、UIKit界面组件介绍 ===== 
-IMKit界面组件是集成云之讯的登录登出云平台、IM会话列表、好友列表、聊天界面等,​可快速集成和高度自定义界面的开发包。 \\ +云之讯IM UIKit是在原子SDK基础上封装了IM相关的上层业务和UI,开发者无须处理复杂IM业务及UI,只需启动已封装好的界面就能拥有IM功能。包括:IM会话列表界面、好友列表界面、聊天界面等。 \\ 
  
-前往云之讯官网下载IMKit([[http://​www.ucpaas.com/​product_service/​im#​item4|下载地址]]),IMKit界面组件开发包含以下部分:\\ +如果你还没有下载UIKit开发包,请前往云之讯官网下载IMKit([[http://​www.ucpaas.com/​product_service/​im#​item4|下载地址]]),IMKit界面组件开发包含以下部分:\\ 
-  *1、IMKIT接口文档.rar,介绍了SDK中的类及其方法\\ +  *1、UCS_Android_UIKIT_IM.zip,包含了库文件和资源文件。\\
-  *2、IMUISDK.rar,包含了库文件和资源文件。\\+
  
 ===== 二、IMKit接入工程的准备 ===== ===== 二、IMKit接入工程的准备 =====
行 27: 行 26:
 ==== 3、继承IMKit中的Application ==== ==== 3、继承IMKit中的Application ====
 用户在工程中新建继承自YZXMainApplication的类,并在其onCreate()方法中调用父类的onCreate()方法,类代码如下: ​ 用户在工程中新建继承自YZXMainApplication的类,并在其onCreate()方法中调用父类的onCreate()方法,类代码如下: ​
-  ​import com.yzx.im_UIdemo.YZXMainApplication; ​+  ​
   public class MainApplication extends YZXMainApplication {    public class MainApplication extends YZXMainApplication { 
     @Override     @Override
     public void onCreate() {     public void onCreate() {
-        // TODO Auto-generated method stub 
         super.onCreate();​         super.onCreate();​
     }     }
行 124: 行 122:
     </​application>​     </​application>​
 ===== 三、IMKit快速集成 ===== ===== 三、IMKit快速集成 =====
-IMKit提供的接口都UCS_IMUIManager中以静态函数的形式提供的,使用前需在相应文件中导入com.yzx.im_UIdemo.UCS_IMUIManager,代码为: ​+IMKit提供的接口都在UCS_IMUIManager中以静态函数的形式提供的,使用前需在相应文件中导入com.yzx.im_UIdemo.UCS_IMUIManager,代码为: ​
   import com.yzx.im_UIdemo.UCS_IMUIManager; ​   import com.yzx.im_UIdemo.UCS_IMUIManager; ​
 ==== 1、登录云平台 ==== ==== 1、登录云平台 ====
 IMKit为登录云平台提供了两个接口,一个使用token登录,一个使用账号密码登录 ​ IMKit为登录云平台提供了两个接口,一个使用token登录,一个使用账号密码登录 ​
  
-通过token登录云平台:​  +通过token登录云平台:​ 
-  static void connect(java.lang.String token, ​com.yzxtcp.listener.ILoginListener listener) ​+<code java> 
 +/** 
 + * 
 + * @param token 客户端向接入服务器请求得到的一串字符,新注册的账号只能使用token的方式登录云平台。 
 + * @param listener 登陆回调监听 
 +*/ 
 +static void connect(java.lang.String token,​ILoginListener listener) 
 +</​code>​
 通过账号密码登录云平台: ​ 通过账号密码登录云平台: ​
-  ​static void connect(java.lang.String sid, java.lang.String sidPwd, ​java.lang.String clientId, ​java.lang.String clientPwd, ​com.yzxtcp.listener.ILoginListener listener)  +<code java> 
-token是客户端向接入服务器请求得到的一串字符,新注册的账号只能使用token的方式登录云平台。+/** 
 + * 
 + * @param sid 开发者账号 
 + * @param sidPwd 开发者账号密码 
 + * @param clientId 子账号 
 + * @param clientPwd 子账户密码 
 + * @param loginCallBack 登陆回调 
 +*/ 
 +static void connect(String sid,String sidPwd,​String clientId,​String clientPwd,​ILoginListener listener) 
 +</​code>​
  
 下面以token登录为例说明其用法,在参数中传入token字符串及回调,示例代码如下: ​ 下面以token登录为例说明其用法,在参数中传入token字符串及回调,示例代码如下: ​
行 140: 行 154:
     @Override     @Override
     public void onLogin(UcsReason reason) {     public void onLogin(UcsReason reason) {
-        // TODO Auto-generated method stub 
-        System.out.println("​登陆消息:"​ + reason.getMsg());​ 
         if (reason.getReason() == UcsErrorCode.NET_ERROR_CONNECTOK) {         if (reason.getReason() == UcsErrorCode.NET_ERROR_CONNECTOK) {
-            ​System.out.println("​登陆成功");+            ​//登陆成功
         } else {         } else {
-            ​System.out.println("​登陆失败");+            ​//登陆失败
         }         }
     }     }
行 151: 行 163:
 UCS_IMUIManager.connect("​xxx_token",​ listener); UCS_IMUIManager.connect("​xxx_token",​ listener);
 </​code>​ </​code>​
- 
 ==== 2、退出云平台 ==== ==== 2、退出云平台 ====
-退出接口为:  +退出接口为: 
-  static void disconnect() ​+<code java> 
 +static void disconnect() 
 +</​code>​
 调用UCS_IMUIManager.disconnect()即可断开与云平台的连接,断开后客户端将不再与云平台进行包括心跳包在内的数据交互,该客户端将被服务器视为离线状态。 调用UCS_IMUIManager.disconnect()即可断开与云平台的连接,断开后客户端将不再与云平台进行包括心跳包在内的数据交互,该客户端将被服务器视为离线状态。
-==== 3、设置标题栏风格 ====+ 
 +==== 3、启动会话列表界面 ==== 
 + 
 +跳转到会话列表界面: 
 +<code java>  
 +/** 
 + * 
 + * @param context 上下文 
 + * @param localUser 当前登录账号 
 + * @param nickName 当前登录账号昵称 
 +*/ 
 +static void startIMChatActivity(Context context, java.lang.String localUser, java.lang.String nickName) 
 +</​code>​ 
 + 
 +  
 +==== 4、启动好友列表界面 ==== 
 +跳转到好友列表界面: 
 +<code java> 
 +/** 
 + * 
 + * @param context 上下文 
 + * @param localUser 当前登录账号 
 + * @param nickName 当前登录账号昵称 
 +*/ 
 +static void startIMFriendListActivity(Context context,​String localUser,​String nickName)  
 +</​code>​ 
 +  
 +==== 5、启动聊天界面 ==== 
 +跳转到聊天界面 
 +<code java> 
 +/** 
 + * 
 + * @param context 上下文 
 + * @param localUser 用户账号 
 + * @param nickName 用户昵称 
 + * @param targetID 对方账号 
 + * @param targetNickName 对方昵称 
 + * @param categoryId 聊天种类 
 + * @return 跳转参数是否正确 
 +*/ 
 +  static boolean startIMMsgActivity(Context context,​String localUser,​String nickName,​String targetID, String targetNickName,​ CategoryId categoryId) 
 +</​code>​ 
 +             
 +===== 四、自定义 ===== 
 +==== 1、设置标题栏风格 ====
 IMKit中的界面标题栏有默认风格,用户也可调用下面接口更改界面风格: IMKit中的界面标题栏有默认风格,用户也可调用下面接口更改界面风格:
-  ​static void setActionBarStyle(UCS_IMUIManager.UiType type, ActionBarConfig config) ​+<code java> 
 +/** 
 + * 
 + * @param type 需要设置风格的界面,详情请参考UCS_IMUIManager.UiType说明 
 + * @param config 标题栏配置参数,详情请参考ActionBarConfig类说明 
 +*/ 
 +static void setActionBarStyle(UCS_IMUIManager.UiType type, ActionBarConfig config) 
 +</​code>​
 下面以更改会话列表界面的标题栏的背景色为例来说明该接口的使用: 下面以更改会话列表界面的标题栏的背景色为例来说明该接口的使用:
 <code java> ​ <code java> ​
行 169: 行 233:
 {{ :​im_sdk_3.png?​nolink&​300 |}} {{ :​im_sdk_3.png?​nolink&​300 |}}
 {{ :​im_sdk_4.png?​nolink&​300 |}} {{ :​im_sdk_4.png?​nolink&​300 |}}
-==== 4、设置好友列表成员 ====+==== 2、设置好友列表成员 ====
 设置好友列表成员: ​ 设置好友列表成员: ​
-  ​static void setFriendListContacts(java.util.List<​SortModel>​ contacts)  +<code java> 
-调用该接口后指定的联系人将被添加到好友列表中,代码及效果如下: ​+/** 
 + * 
 + * @param contacts 好友列表 
 +*/ 
 +static void setFriendListContacts(List<​SortModel>​ contacts)
 +</​code>​ 
 +调用该接口后指定的联系人将被添加到好友列表中,并且会话列表中的单聊会话会根据id来匹配头像、title信息。 
 +<code java> 
 +//​设置好友列表成员 
 +List<​SortModel>​ contacts = new ArrayList<​SortModel>​();​ 
 +SortModel sortModel = new SortModel();​ 
 +sortModel.setName("​Marry"​);//​好友昵称 
 +sortModel.setId("​13421340887"​);//​好友ID 
 +sortModel.setUrl("​头像URL"​);//​好友头像URL 
 +contacts.add(sortModel);​ 
 +UCS_IMUIManager.setFriendListContacts(contacts);​ 
 +</​code>​ 
 +好友列表页面效果如下: 
 + {{ :​im_sdk_friends03.png?​nolink&​300 |}} 
 +会话列表页面效果如下: 
 + {{ :​im_sdk_conversitionList02.png?​nolink&​300 |}} 
 +   
 +==== 3、设置群组列表成员 ==== 
 +设置群组列表成员:​ 
 +<code java> 
 +/** 
 + * 
 + * @param groupBeans 群组列表 
 +*/ 
 +static void setGroupBean(List<​GroupBean>​ groups); 
 +</​code>​  
 +调用该接口后,会话列表中的群组会话将会按照设置的群组id来匹配头像、title信息。 ​
  
-  ​//设置好友列表成员 +<code java> 
-  List<SortModelcontacts ​= new ArrayList<​SortModel>(); +//设置群组列表成员 
-  ​SortModel sortModel ​= new SortModel();​ +List<GroupBeangroups ​= new ArrayList<​GroupBean>(); 
-  sortModel.setName("Jack");//​好友昵称 +GroupBean groupBean01 ​= new GroupBean("头像URL","群组id","​体验群1"); 
-  sortModel.setId("13428788888");//好友ID +GroupBean groupBean02 = new GroupBean("​头像URL","​群组id","​体验群2"); 
-  ​sortModel.setUrl("​头像URL"​);​//​好友头像 +groups.add(groupBean01);​ 
-  ​contacts.add(sortModel); +groups.add(groupBean02); 
-  UCS_IMUIManager.setFriendListContacts(contacts); +UCS_IMUIManager.setGroupBean(groups); 
- {{ :im_sdk_5.png?​nolink&​300 |}} +</​code>​ 
- +会话列表效果如下:​ 
- + {{ :im_sdk_group_01.png?​nolink&​300 |}}
-==== 5、跳转到会话列表界面 ==== +
- +
-跳转到会话列表界面:  +
-  static void startIMChatActivity(Context context, java.lang.String localUser, java.lang.String nickName) +
- +
-传入参数包括上下文、本端用户、本端用户昵称 +
-  +
-==== 6、跳转到好友列表界面 ==== +
-跳转到好友列表界面:  +
-  static void startIMFriendListActivity(Context context, java.lang.String localUser, java.lang.String nickName) ​+
  
-传入参数包括上下文、本端用户、本端用户昵称 +==== 4、设置消息通知是否开启 ====
-  +
-==== 7、跳转到聊天界面 ==== +
-  /​***跳转到聊天界面 +
-  * @param context 上下文 +
-  * @param localUser 用户账号 +
-  * @param nickName 用户昵称 +
-  * @param targetID 对方账号 +
-  * @param targetNickName 对方昵称 +
-  * @param categoryId 聊天种类 +
-  * @return 跳转参数是否正确 +
-  */ +
-  static boolean startIMMsgActivity(Context context,​String localUser,​String nickName,​String targetID, String targetNickName,​ CategoryId categoryId)  +
-跳转到指定用户名、昵称、以及聊天类型(单聊、群聊、讨论组)的聊天界面 +
-  +
-==== 8、设置消息通知是否开启 ====+
 设置通知栏消息(包括震动与声音)是否开启: 设置通知栏消息(包括震动与声音)是否开启:
-  ​static void setMsgNotification(Context context, String loalUser,​boolean on); +<code java> 
-传入参数包括上下文及布尔控制值,loalUser当前用户ID,​ on传入布尔值为true则开启,为false则不开启。 ​+/** 
 + *  
 + * @param context 上下文 
 + * @param localUser 当前登录用户 
 + * @param on true为开启,false为关闭 
 + */ 
 +static void setMsgNotification(Context context, String loalUser,​boolean on); 
 +</​code>​
  
  
-====9集成注意事项 ==== +===== 五、属性说明 ===== 
-1,如果使用地图功能时报错误 ​ ​**"​请检查key,​baiduSDK认证错误!"​**+==== 1、UiType ==== 
 +UiType定义了可设置风格的界面 可以使用该枚举指定需要设置的界面,具体定义如下:​ 
 +<code java> 
 +public static enum UiType { 
 +IMChatList,//​会话列表界面 
 +IMMessage,//​聊天界面 
 +IMFriendList,//​好友列表界面 
 +IMPersonInfo,//​单聊设置界面 
 +IMDiscussionInfo,//​讨论组设置界面 
 +IMMSGBackGroud,//​聊天背景 
 +IMSelBackGroud;//​选择背景 
 +
 +</​code>​ 
 +==== 2、ActionBarConfig ==== 
 +配置ActionBar风格类,​支持ActionBar左右两侧图片及点击响应自定义,​支持ActionBar背景颜色及文字颜色自定义。 
 +用户可以通过set方法进行参数的配置如: 
 +<code java> 
 +ActionBarConfig config = new ActionBarConfig();​ 
 +config.setActionBarColor(0xff000000);//​设置actionBar背景色 
 +config.setTitle("​消息"​);//​设置actionBar的title文字 
 +</​code>​ 
 +ActionBarConfig具体属性如下: 
 +<code java> 
 +public class ActionBarConfig{ 
 +public int mLeftImageID,​mRightImageID;//​actionBar左右两边的图标资源id 
 +  
 +public OnClickListener mLeftImageClick,​ mRightImageClick;//​actionBar左右两边的图标点击事件 
 +  
 +public String mActionBarColor,​mTitleColor;//​actionBar背景色和title文字颜色,如:"​blue","​green","​red","​yellow"​等 
 +  
 +public String mTitle;//​actionBar的title文字 
 +  
 +public int mLeftImageVisi,​mRightImageVisib;//​actionBar左右两边的图标可见性,​与View.VISIBLE、View.INVISIBLE、View.GONE一样用法 
 +  
 +public int mActionBarColorInt,​mTitleColorInt;//​actionBar背景色和title文字颜色值,如0xff000000 
 +
 +</​code>​ 
 + 
 +===== 六、注意事项 ​===== 
 +==== 1、百度key认证错误 ==== 
 +如果使用地图功能时报 ​ **"​请检查key,​baiduSDK认证错误!"​**
   需要用户在AndroidManifest.xml文件中修改   需要用户在AndroidManifest.xml文件中修改
   <​meta-data   <​meta-data
             android:​name="​com.baidu.lbsapi.API_KEY"​             android:​name="​com.baidu.lbsapi.API_KEY"​
             android:​value="​用户在百度申请的KEY"​ />             android:​value="​用户在百度申请的KEY"​ />
- 
- 
最后更改: 2017/08/23 08:44

页面工具