com.netease.nimlib.sdk.document.model

Interface DMData

All Superinterfaces:

java.io.Serializable

public interface DMData
extends java.io.Serializable

Document converted data

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocId() Get the document ID, which is the unique identifier
java.lang.String	getDocName() Get the document name
long	getDocSize() Get the size of a document in bytes
DocTransFileType	getDocType() Get the type of a document.
java.lang.String	getExtra() Get the extension fields when the convert request is sent
int	getPageNum() Get the number of pages of the converted file
java.util.List<DMPicInfo>	getPicInfoList() Get the image info of the converted files
DMPicInfo	getTransCodedImageInfo(DMDocTransQuality quality) Get the image info of a converted image with a specified resolution.
java.lang.String	getTransCodedUrl(int pageNumber, DMDocTransQuality quality) Get the URL of converted pages with a specified resolution.
long	getTransSize() Get the size of the converted file in bytes
DocTransState	getTransStat() Get the conversion status.
DocTransImageType	getTransType() Get the format of the converted file.
java.lang.String	getUrlPrefix() Get the prefix of the URL for document download

Method Detail

getDocId

java.lang.String getDocId()

Get the document ID, which is the unique identifier

getDocName

java.lang.String getDocName()

Get the document name

getUrlPrefix

java.lang.String getUrlPrefix()

Get the prefix of the URL for document download

getDocSize

long getDocSize()

Get the size of a document in bytes

getDocType

DocTransFileType getDocType()

Get the type of a document. PPT, PPTX, and PDF are supported

getTransStat

DocTransState getTransStat()

Get the conversion status. Preparing: getting prepared: Ongoing: being converted. Timeout: converting timeout, Completed: the document is converted. Failed: conversion failed

getTransType

DocTransImageType getTransType()

Get the format of the converted file. 10: JPG, 11: PNG

getTransSize

long getTransSize()

Get the size of the converted file in bytes

getPageNum

int getPageNum()

Get the number of pages of the converted file

getPicInfoList

java.util.List<DMPicInfo> getPicInfoList()

Get the image info of the converted files

getExtra

java.lang.String getExtra()

Get the extension fields when the convert request is sent

getTransCodedUrl

java.lang.String getTransCodedUrl(int pageNumber,
                                  DMDocTransQuality quality)

Get the URL of converted pages with a specified resolution. The pages starts from 1 to the value of the getPageNumber() parameter.

getTransCodedImageInfo

DMPicInfo getTransCodedImageInfo(DMDocTransQuality quality)

Get the image info of a converted image with a specified resolution.