Package com.kaltura.client.services

Class DocumentsService

java.lang.Object

com.kaltura.client.services.DocumentsService

public class DocumentsService
extends Object

Document service lets you upload and manage document files

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsService.AddFromEntryDocumentsBuilder
static class	DocumentsService.AddFromFlavorAssetDocumentsBuilder
static class	DocumentsService.AddFromUploadedFileDocumentsBuilder
static class	DocumentsService.ApproveReplaceDocumentsBuilder
static class	DocumentsService.CancelReplaceDocumentsBuilder
static class	DocumentsService.ConvertDocumentsBuilder
static class	DocumentsService.ConvertPptToSwfDocumentsBuilder
static class	DocumentsService.DeleteDocumentsBuilder
static class	DocumentsService.GetDocumentsBuilder
static class	DocumentsService.ListDocumentsBuilder
static class	DocumentsService.ServeByFlavorParamsIdDocumentsBuilder
static class	DocumentsService.ServeDocumentsBuilder
static class	DocumentsService.UpdateContentDocumentsBuilder
static class	DocumentsService.UpdateDocumentsBuilder
static class	DocumentsService.UploadDocumentsBuilder

Constructor Summary

Constructors

Constructor	Description
DocumentsService()

Method Summary

Modifier and Type	Method	Description
static DocumentsService.AddFromEntryDocumentsBuilder	addFromEntry(String sourceEntryId)
static DocumentsService.AddFromEntryDocumentsBuilder	addFromEntry(String sourceEntryId, DocumentEntry documentEntry)
static DocumentsService.AddFromEntryDocumentsBuilder	addFromEntry(String sourceEntryId, DocumentEntry documentEntry, int sourceFlavorParamsId)	Copy entry into new entry
static DocumentsService.AddFromFlavorAssetDocumentsBuilder	addFromFlavorAsset(String sourceFlavorAssetId)
static DocumentsService.AddFromFlavorAssetDocumentsBuilder	addFromFlavorAsset(String sourceFlavorAssetId, DocumentEntry documentEntry)	Copy flavor asset into new entry
static DocumentsService.AddFromUploadedFileDocumentsBuilder	addFromUploadedFile(DocumentEntry documentEntry, String uploadTokenId)	Add new document entry after the specific document file was uploaded and the upload token id exists
static DocumentsService.ApproveReplaceDocumentsBuilder	approveReplace(String entryId)	Approves document replacement
static DocumentsService.CancelReplaceDocumentsBuilder	cancelReplace(String entryId)	Cancels document replacement
static DocumentsService.ConvertDocumentsBuilder	convert(String entryId)
static DocumentsService.ConvertDocumentsBuilder	convert(String entryId, int conversionProfileId)
static DocumentsService.ConvertDocumentsBuilder	convert(String entryId, int conversionProfileId, List<ConversionAttribute> dynamicConversionAttributes)	Convert entry
static DocumentsService.ConvertPptToSwfDocumentsBuilder	convertPptToSwf(String entryId)	This will queue a batch job for converting the document file to swf Returns the URL where the new swf will be available
static DocumentsService.DeleteDocumentsBuilder	delete(String entryId)	Delete a document entry.
static DocumentsService.GetDocumentsBuilder	get(String entryId)
static DocumentsService.GetDocumentsBuilder	get(String entryId, int version)	Get document entry by ID.
static DocumentsService.ListDocumentsBuilder	list()
static DocumentsService.ListDocumentsBuilder	list(DocumentEntryFilter filter)
static DocumentsService.ListDocumentsBuilder	list(DocumentEntryFilter filter, FilterPager pager)	List document entries by filter with paging support.
static DocumentsService.ServeDocumentsBuilder	serve(String entryId)
static DocumentsService.ServeDocumentsBuilder	serve(String entryId, String flavorAssetId)
static DocumentsService.ServeDocumentsBuilder	serve(String entryId, String flavorAssetId, boolean forceProxy)	Serves the file content
static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder	serveByFlavorParamsId(String entryId)
static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder	serveByFlavorParamsId(String entryId, String flavorParamsId)
static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder	serveByFlavorParamsId(String entryId, String flavorParamsId, boolean forceProxy)	Serves the file content
static DocumentsService.UpdateDocumentsBuilder	update(String entryId, DocumentEntry documentEntry)	Update document entry.
static DocumentsService.UpdateContentDocumentsBuilder	updateContent(String entryId, Resource resource)
static DocumentsService.UpdateContentDocumentsBuilder	updateContent(String entryId, Resource resource, int conversionProfileId)	Replace content associated with the given document entry.
static DocumentsService.UploadDocumentsBuilder	upload(FileHolder fileData)	Upload a document file to Kaltura, then the file can be used to create a document entry.
static DocumentsService.UploadDocumentsBuilder	upload(File fileData)
static DocumentsService.UploadDocumentsBuilder	upload(FileInputStream fileData, String fileDataMimeType, String fileDataName)
static DocumentsService.UploadDocumentsBuilder	upload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentsService

public DocumentsService()

Method Detail

addFromEntry

public static DocumentsService.AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId)

addFromEntry

public static DocumentsService.AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId,
                                                                         DocumentEntry documentEntry)

addFromEntry

public static DocumentsService.AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId,
                                                                         DocumentEntry documentEntry,
                                                                         int sourceFlavorParamsId)

Copy entry into new entry

Parameters:

sourceEntryId - Document entry id to copy from

documentEntry - Document entry metadata

sourceFlavorParamsId - The flavor to be used as the new entry source, source flavor will be used if not specified

addFromFlavorAsset

public static DocumentsService.AddFromFlavorAssetDocumentsBuilder addFromFlavorAsset(String sourceFlavorAssetId)

addFromFlavorAsset

public static DocumentsService.AddFromFlavorAssetDocumentsBuilder addFromFlavorAsset(String sourceFlavorAssetId,
                                                                                     DocumentEntry documentEntry)

Copy flavor asset into new entry

Parameters:

sourceFlavorAssetId - Flavor asset id to be used as the new entry source

documentEntry - Document entry metadata

addFromUploadedFile

public static DocumentsService.AddFromUploadedFileDocumentsBuilder addFromUploadedFile(DocumentEntry documentEntry,
                                                                                       String uploadTokenId)

Add new document entry after the specific document file was uploaded and the upload token id exists

Parameters:

documentEntry - Document entry metadata

uploadTokenId - Upload token id

approveReplace

public static DocumentsService.ApproveReplaceDocumentsBuilder approveReplace(String entryId)

Approves document replacement

Parameters:

entryId - document entry id to replace

cancelReplace

public static DocumentsService.CancelReplaceDocumentsBuilder cancelReplace(String entryId)

Cancels document replacement

Parameters:

entryId - Document entry id to cancel

convert

public static DocumentsService.ConvertDocumentsBuilder convert(String entryId)

convert

public static DocumentsService.ConvertDocumentsBuilder convert(String entryId,
                                                               int conversionProfileId)

convert

public static DocumentsService.ConvertDocumentsBuilder convert(String entryId,
                                                               int conversionProfileId,
                                                               List<ConversionAttribute> dynamicConversionAttributes)

Convert entry

Parameters:

entryId - Document entry id

conversionProfileId -

dynamicConversionAttributes -

convertPptToSwf

public static DocumentsService.ConvertPptToSwfDocumentsBuilder convertPptToSwf(String entryId)

This will queue a batch job for converting the document file to swf Returns the URL where the new swf will be available

Parameters:

entryId -

delete

public static DocumentsService.DeleteDocumentsBuilder delete(String entryId)

Delete a document entry.

Parameters:

entryId - Document entry id to delete

get

public static DocumentsService.GetDocumentsBuilder get(String entryId)

get

public static DocumentsService.GetDocumentsBuilder get(String entryId,
                                                       int version)

Get document entry by ID.

Parameters:

entryId - Document entry id

version - Desired version of the data

list

public static DocumentsService.ListDocumentsBuilder list()

list

public static DocumentsService.ListDocumentsBuilder list(DocumentEntryFilter filter)

list

public static DocumentsService.ListDocumentsBuilder list(DocumentEntryFilter filter,
                                                         FilterPager pager)

List document entries by filter with paging support.

Parameters:

filter - Document entry filter

pager - Pager

serve

public static DocumentsService.ServeDocumentsBuilder serve(String entryId)

serve

public static DocumentsService.ServeDocumentsBuilder serve(String entryId,
                                                           String flavorAssetId)

serve

public static DocumentsService.ServeDocumentsBuilder serve(String entryId,
                                                           String flavorAssetId,
                                                           boolean forceProxy)

Serves the file content

Parameters:

entryId - Document entry id

flavorAssetId - Flavor asset id

forceProxy - force to get the content without redirect

serveByFlavorParamsId

public static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId)

serveByFlavorParamsId

public static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId,
                                                                                           String flavorParamsId)

serveByFlavorParamsId

public static DocumentsService.ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId,
                                                                                           String flavorParamsId,
                                                                                           boolean forceProxy)

Serves the file content

Parameters:

entryId - Document entry id

flavorParamsId - Flavor params id

forceProxy - force to get the content without redirect

update

public static DocumentsService.UpdateDocumentsBuilder update(String entryId,
                                                             DocumentEntry documentEntry)

Update document entry. Only the properties that were set will be updated.

Parameters:

entryId - Document entry id to update

documentEntry - Document entry metadata to update

updateContent

public static DocumentsService.UpdateContentDocumentsBuilder updateContent(String entryId,
                                                                           Resource resource)

updateContent

public static DocumentsService.UpdateContentDocumentsBuilder updateContent(String entryId,
                                                                           Resource resource,
                                                                           int conversionProfileId)

Replace content associated with the given document entry.

Parameters:

entryId - document entry id to update

resource - Resource to be used to replace entry doc content

conversionProfileId - The conversion profile id to be used on the entry

upload

public static DocumentsService.UploadDocumentsBuilder upload(File fileData)

upload

public static DocumentsService.UploadDocumentsBuilder upload(InputStream fileData,
                                                             String fileDataMimeType,
                                                             String fileDataName,
                                                             long fileDataSize)

upload

public static DocumentsService.UploadDocumentsBuilder upload(FileInputStream fileData,
                                                             String fileDataMimeType,
                                                             String fileDataName)

upload

public static DocumentsService.UploadDocumentsBuilder upload(FileHolder fileData)

Upload a document file to Kaltura, then the file can be used to create a document entry.

Parameters:

fileData - The file data