用户工具

即时消息接口_ios

差别

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

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
即时消息接口_ios [2015/02/08 06:13]
gonghuojin
即时消息接口_ios [2017/08/23 08:44] (当前版本)
行 9: 行 9:
 <code java> ​         ​ <code java> ​         ​
 /** /**
- *函数名: Ucs_sendInstanceMessage + ​*发送IM消息 
- ​*功 ​ 能: 发送即时消息。支持文本消息或者附件消息,text与filePath不能同时为空 + ​* ​@param receiver ​ ​接收方的Client账号或者是群组id 
- *参  数: [IN]receiver:​ 接收者,接收方的VoIP账号或者是群组Id,不能为NULL + ​* ​@param ​text  ​发送文本内容。最大长度500 
- *  [IN]text文本消息内容,​text与attached不能同时NULL + ​* ​@param filePath ​ 发送的附件全路径 
- ​*  ​[IN]filePath: ​附件文件名称,全路径 + ​* ​@param ​msgType ​ ​开发者自定义消息类型1:文本,支持最大文本长度500 
- *  [IN]msgType消息类型 +                                         ​2:图片,支持jpg、jpeg、png、bmp格式 
- ​* ​             ​1:文本,支持最大文本长度500 +                                         ​3:音频,只支持amr格式  
- *              ​2:图片,支持jpg、jpeg、png、bmp格式 +                                         ​4:视频 
- *              ​3:音频,只支持wav格式  +                                         ​10-19:自定义文本 
- *              ​4:视频 +                                         ​20-29:自定义附件) 
- *              ​10-19:自定义文本 +@return NSString  ​消息id 
- *              ​20-29:自定义附件) +*/ 
- *返回值: ​消息id +(NSString) sendUcsMessage:​(NSString*receiver ​ ​andText:​(NSString*text andFilePath:​(NSString*filePath ​ ​andExpandData:​( NSInterger ​msgType
- */ +
-UCSCLIENT_API int Ucs_sendInstanceMessage(const char *receiver, const char *text, char *filePath, const int msgType);+
 </​code> ​       </​code> ​      
  
行 30: 行 28:
 <code java> ​         ​ <code java> ​         ​
 /** /**
- *函数名: Ucs_startVoiceRecord + ​*开始录制音 
- ​*功 ​ 能: 开始录制音 + ​* ​@param ​filePath ​ ​保存文件的全路径 
- *参  数: [IN]filePath: 录音文件保存的全路径 + ​* ​@return BOOL  YES录制语音成功;NO录制语音失败
- *返回值: 是否成功 0:成功; ​非0失败+
  */  */
-UCSCLIENT_API int Ucs_startVoiceRecord(const char *filePath)+(BOOL*) startVoiceRecord:​ (NSString*) filePath ​
 </​code> ​       ​ </​code> ​       ​
  
行 42: 行 39:
 <code java> ​         ​ <code java> ​         ​
 /** /**
- *函数名: Ucs_stopVoiceRecord + ​*停止录制音 
- ​*功 ​ 能: 停止录制音 + ​* ​@param ​ 
- *参  数: 无 + ​* ​@return void 
- *返回值: 是否成功 0:成功; 非0失败 + */ 
-*/ +-(voidstopVoiceRecord ​; 
-UCSCLIENT_API int Ucs_stopVoiceRecord();</​code> ​  +</​code> ​  
     ​     ​
 ==== 4. 播放语音 ==== ==== 4. 播放语音 ====
行 53: 行 50:
 <code java> ​         ​ <code java> ​         ​
 /** /**
- *函数名: Ucs_playVoice + ​*播放语音 
- ​*功 ​ 能: 播放语音 + ​* ​@param filePath ​ 播放文件的全路径 
- *参  数: [IN]filePath:​ 录音文件保存的全路径 + ​* ​@return void
- *返回值: 是否成功 0:成功; 非0失败+
  */  */
-UCSCLIENT_API ​ int Ucs_playVoice(const char *filePath);</​code> ​  +-(void) playVoice :(NSString*) filePath 
 +</​code> ​  
            
 ==== 5. 停止播放语音 ==== ==== 5. 停止播放语音 ====
行 65: 行 62:
 <code java> ​         <code java> ​        
 /** /**
- *函数名: Ucs_stopVoice + ​*停止播放语音 
- ​*功 ​ 能: 停止播放语音 + ​* ​@param ​ 
- *参  数: 无 + ​* ​@return void
- *返回值: 是否成功 0:成功; 非0失败+
  */  */
-UCSCLIENT_API int Ucs_stopVoice();+-(voidstopVoice;
 </​code> ​       </​code> ​      
    
-==== 6. 下载附件API ====+==== 6. 获取语音时长 ==== 
 + 
 + 
 +<code java> ​        
 +/** 
 + ​*获取语音时长 
 + * @param filePath ​ 音频文件的全路径 
 + * @return long  秒级别的文件时长 
 + */ 
 +-(long) getVoiceDuration:​(String filePath) 
 +</​code> ​     
 +    
 +==== 7. 下载附件API ====
  
  
 <code java> <code java>
 /** /**
- *函数名: Ucs_downloadFile + *下载附件 
- *功  能: 根据传入的url下载多媒体言文件 + ​* ​@param fileUrl ​ ​下载文件的Url 
- *参  数: [IN]downloadInfo:​ 下载结构体指针,下载url,msgID,​ type, filePath文件保存路径一个结构体中 + ​* ​@param ​filePath ​ 文件保存的本地路径 
- *返回值: 是否成功 0:成功; 非0失败+ * @param msgId  接收消息的id,与UcsMessage相关的消息 
 + ​* ​@return void  ​
  */  */
-UCSCLIENT_API ​ int  Ucs_downloadFile(UCS_DOWNLOADINFO downloadInfo);+- (void) downloadAttached:​(NSString*) fileUrl andFilePath:​(NSString*) filePath ​ andMsgId:(NSString*msgId
 </​code>​ </​code>​
  
  
  
-===== IM能力回调接口 =====+===== IM能力代理接口 =====
  
 ---- ----
行 98: 行 107:
 <code java> ​         <code java> ​        
 /** /**
- *函数名: onReceiveIMessage + *收到IM消息代理 
- *功  能: 收到IM消息回调 + ​* ​@param reason ​ ​收到的消息状态码 
- *参  数: [OUT]data: ​消息UCS_INSTANTMESSAGE结构体 + ​* ​@param msg  ​消息结构体 
- *返回值: 无+ ​* ​@return void  ​
  */  */
-void (*onReceiveIMessage)(UCS_INSTANTMESSAGE ​*data);+-(void)onReceiveUcsMessage:​(UCSReason ​*)reason withMsg:UCSMessage ​*)msg
 </​code> ​       </​code> ​      
 ==== 2. 发送IM消息 ==== ==== 2. 发送IM消息 ====
行 110: 行 119:
 <code java> ​     ​ <code java> ​     ​
 /** /**
- *函数名: onSendIMessage + *发送IM消息代理 
- *功  能: 发送即时消息回调 + ​* ​@param reason ​ ​发送消息的状态码 
- *参  数: [OUT]data: ​消息结构体 + ​* ​@param data  ​消息结构体 
- ​* ​       ​[OUT]reason:​ 状态值 + ​* ​@return void  ​ 
- ​*返回值:​ 无 + */ 
-*/ +-(void)onSendUcsMessage:​(UCSReason*)reason ​ ​withData:​( UCSMessage  ​*)data
-void (*onSendIMessage)(int reason, UCS_INSTANTMESSAGE ​*data);+
 </​code> ​     </​code> ​    
  
行 124: 行 132:
 <code java> ​         <code java> ​        
 /** /**
- *函数名: onDownloadFile + *下载IM附件代理 
- *功  能: 下载附件回调 + ​* ​@param reason ​ ​下载IM附件的状态码 
- *参  数: [OUT]data: ​下载结构体UCS_DOWNLOADINFO首指针 + ​* ​@param filePath ​ ​下载IM附件的本地路径 
- ​* ​      [OUT]reason:​ 状态值 + ​* ​@param msgId  接收到的消息id 
- *返回值: 无+ ​* ​@return void  ​
  */  */
-void (*onDownloadFile)(int reason, UCS_DOWNLOADINFO ​*data);+-(void)onDownloadAttached:​ 
 +(UCSReason*)reason ​withFilePath:​(NSString*)filePath ​ andMsgId:​(NSString*) msgId
 </​code> ​     ​ </​code> ​     ​
 +==== 4. 播放录音结束 ====
  
 +
 +<code java> ​      
 +/**
 + ​*播放语音结束代理
 + * @param ​
 + * @return void
 + */
 +-(void) onFinishedPlayingVoice
 +</​code> ​      
 +
 +==== 5. 停止录音 ====
 +
 +
 +<code java> ​       ​
 +/**
 + ​*停止录音代理
 + * @param duration 录制语音的时长
 + * @return void
 + */
 +-(void)onStopVoiceRecord:​ (NSInterger) duration
 +</​code>​
最后更改: 2017/08/23 08:44

页面工具