DMData.java

浏览该文件的文档.

package com.netease.nimlib.sdk.document.model;

import java.io.Serializable;
import java.util.List;

/**
 * 文档转码结果.
 */

public interface DMData extends Serializable {
    /**
     * 获取文档ID，文档ID是文档的唯一标识
     */
    String getDocId();

    /**
     * 获取文档名称
     */
    String getDocName();

    /**
     * 获取文档下载链接前缀
     */
    String getUrlPrefix();

    /**
     * 获取文档大小，单位字节
     */
    long getDocSize() ;

    /**
     * 获取文档类型，PPT表示ppt，PPTX表示pptx，PDF表示pdf
     */
    DocTransFileType getDocType();

    /**
     * 获取文档转码状态，Preparing表示转码准备中，Ongoing表示转码中，Timeout表示转码超时，Completed表示转码成功，Failed表示转码失败
     */
    DocTransState getTransStat();

    /**
     * 获取文档的转码格式，10表示jpg，11表示png
     */
    DocTransImageType getTransType();

    /**
     * 获取转码后的图片总大小，单位字节
     */
    long getTransSize();

    /**
     * 获取文档页数
     */
    int getPageNum() ;

    /**
     * 获取文档转码结果，包含图片的信息
     */
    List<DMPicInfo> getPicInfoList() ;

    /**
     * 获取发起转码请求时上传的扩展字段
     */
    String getExtra();

    /**
     * 获取转码后某清晰度的文件页码对应的下载链接url，页码从1开始一直到getPageNum()的值
     */
    String getTransCodedUrl(int pageNumber, DMDocTransQuality quality);

    /**
     * 获取某清晰度转码后图片的详细信息
     */
    DMPicInfo getTransCodedImageInfo(DMDocTransQuality quality);
}