[TOC]

跳过导航链接

cn.jpush.im.android.api.content

类 FileContent

    • 所有已实现的接口:
    • java.lang.Cloneable 
public class FileContent
extends MediaContent
  • 从以下版本开始:
  • 1.4.0

构造器概要

构造器 构造器和说明 FileContent(java.io.File file) 创建一个file类型的message content。 FileContent(java.io.File file, java.lang.String fileName) 创建一个file类型的message content。

方法概要

所有方法 实例方法;) 具体方法;) 限定符和类型 方法和说明 void cancelDownload(Message message) 取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消

是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED void downloadFile(Message message, DownloadCompletionCallback callback) 下载消息中文件。 java.lang.String getFileName() 获取文件名称 boolean needAutoDownloadWhenRecv() 

-

从类继承的方法 cn.jpush.im.android.api.content.MediaContent

getCrc, getFileSize, getFormat, getHash, getLocalPath, getMediaID, getResourceId, isFileUploaded, setFileUploaded, setFormat, setLocalPath, setMediaID 

-

从类继承的方法 cn.jpush.im.android.api.content.MessageContent

clone, fromJson, getBooleanExtra, getBooleanExtras, getContentType, getNumberExtra, getNumberExtras, getStringExtra, getStringExtras, setBooleanExtra, setExtras, setNumberExtra, setStringExtra, toJson, toJsonElement 

-

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

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

构造器详细资料

-

FileContent

public FileContent(java.io.File file)
            throws java.io.FileNotFoundException,
                   JMFileSizeExceedException

创建一个file类型的message content。使用文件原名填充消息协议中的fname字段。

  - 参数: 
  - <code>file</code> - 发送的文件对象 
  - 抛出: 
  - <code>java.io.FileNotFoundException</code> 
  - <code>JMFileSizeExceedException</code>        
-

FileContent

public FileContent(java.io.File file,
                   java.lang.String fileName)
            throws java.io.FileNotFoundException,
                   JMFileSizeExceedException

创建一个file类型的message content。使用指定的fileName填充消息协议中的fname字段。

  - 参数: 
  - <code>file</code> - 发送的文件对象 
  - <code>fileName</code> - 指定发送的文件名称,如果不填或为空，则默认使用文件原名。 
  - 抛出: 
  - <code>java.io.FileNotFoundException</code> 
  - <code>JMFileSizeExceedException</code>

方法详细资料

-

needAutoDownloadWhenRecv

public boolean needAutoDownloadWhenRecv()
  - 指定者: 
  - <code>needAutoDownloadWhenRecv</code> 在类中 <code>MessageContent</code>        
-

getFileName

public java.lang.String getFileName()

获取文件名称

  - 返回: 
  - 文件名称        
-

downloadFile

public void downloadFile(Message message,
                         DownloadCompletionCallback callback)

下载消息中文件。注意：sdk收到文件消息后，不会自动下载文件附件，

需要用户手动调用此接口完成下载。

如果想取消下载文件，调用cancelDownload(Message)

  - 参数: 
  - <code>message</code> - 文件消息对象 
  - <code>callback</code> - 下载完成时的回调接口        
-

cancelDownload

public void cancelDownload(Message message)

从类复制的说明: MessageContent

取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消

是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED

  - 指定者: 
  - <code>cancelDownload</code> 在类中 <code>MessageContent</code> 
  - 参数: 
  - <code>message</code> - 该Content所对应的消息对象

跳过导航链接