com.kaltura.client.services.DocumentsService Maven / Gradle / Ivy
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;
import com.kaltura.client.FileHolder;
import com.kaltura.client.Files;
import com.kaltura.client.types.ConversionAttribute;
import com.kaltura.client.types.DocumentEntry;
import com.kaltura.client.types.DocumentEntryFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.Resource;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import com.kaltura.client.utils.request.ServeRequestBuilder;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.List;
/**
* This class was generated using exec.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/**
* Document service lets you upload and manage document files
*
* @param entryId
* @param resource
* @param sourceEntryId Document entry id to copy from
* @param documentEntry Document entry metadata
* @param sourceFlavorParamsId The flavor to be used as the new entry source, source flavor will be used if not
* specified
* @param sourceFlavorAssetId Flavor asset id to be used as the new entry source
* @param documentEntry Document entry metadata
* @param documentEntry Document entry metadata
* @param uploadTokenId Upload token id
* @param entryId document entry id to replace
* @param entryId Document entry id to cancel
* @param entryId Document entry id
* @param conversionProfileId
* @param dynamicConversionAttributes
* @param entryId
* @param entryId Document entry id to delete
* @param entryId Document entry id
* @param version Desired version of the data
* @param filter Document entry filter
* @param pager Pager
* @param entryId Document entry id
* @param flavorAssetId Flavor asset id
* @param forceProxy force to get the content without redirect
* @param entryId Document entry id
* @param flavorParamsId Flavor params id
* @param forceProxy force to get the content without redirect
* @param entryId Document entry id to update
* @param documentEntry Document entry metadata to update
* @param entryId document entry id to update
* @param resource Resource to be used to replace entry doc content
* @param conversionProfileId The conversion profile id to be used on the entry
* @param fileData The file data
*/
public class DocumentsService {
public static class AddContentDocumentsBuilder extends RequestBuilder {
public AddContentDocumentsBuilder(String entryId, Resource resource) {
super(DocumentEntry.class, "document_documents", "addContent");
params.add("entryId", entryId);
params.add("resource", resource);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
public static AddContentDocumentsBuilder addContent(String entryId) {
return addContent(entryId, null);
}
/**
* Add content to document entry which is not yet associated with content
(therefore is in status NO_CONTENT). If the requirement is to replace the
entry's associated content, use action updateContent.
*
* @param entryId
* @param resource
*/
public static AddContentDocumentsBuilder addContent(String entryId, Resource resource) {
return new AddContentDocumentsBuilder(entryId, resource);
}
public static class AddFromEntryDocumentsBuilder extends RequestBuilder {
public AddFromEntryDocumentsBuilder(String sourceEntryId, DocumentEntry documentEntry, int sourceFlavorParamsId) {
super(DocumentEntry.class, "document_documents", "addFromEntry");
params.add("sourceEntryId", sourceEntryId);
params.add("documentEntry", documentEntry);
params.add("sourceFlavorParamsId", sourceFlavorParamsId);
}
public void sourceEntryId(String multirequestToken) {
params.add("sourceEntryId", multirequestToken);
}
public void sourceFlavorParamsId(String multirequestToken) {
params.add("sourceFlavorParamsId", multirequestToken);
}
}
public static AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId) {
return addFromEntry(sourceEntryId, null);
}
public static AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId, DocumentEntry documentEntry) {
return addFromEntry(sourceEntryId, documentEntry, Integer.MIN_VALUE);
}
/**
* Copy entry into new entry
*
* @param sourceEntryId Document entry id to copy from
* @param documentEntry Document entry metadata
* @param sourceFlavorParamsId The flavor to be used as the new entry source, source flavor will be used if not
* specified
*/
public static AddFromEntryDocumentsBuilder addFromEntry(String sourceEntryId, DocumentEntry documentEntry, int sourceFlavorParamsId) {
return new AddFromEntryDocumentsBuilder(sourceEntryId, documentEntry, sourceFlavorParamsId);
}
public static class AddFromFlavorAssetDocumentsBuilder extends RequestBuilder {
public AddFromFlavorAssetDocumentsBuilder(String sourceFlavorAssetId, DocumentEntry documentEntry) {
super(DocumentEntry.class, "document_documents", "addFromFlavorAsset");
params.add("sourceFlavorAssetId", sourceFlavorAssetId);
params.add("documentEntry", documentEntry);
}
public void sourceFlavorAssetId(String multirequestToken) {
params.add("sourceFlavorAssetId", multirequestToken);
}
}
public static AddFromFlavorAssetDocumentsBuilder addFromFlavorAsset(String sourceFlavorAssetId) {
return addFromFlavorAsset(sourceFlavorAssetId, null);
}
/**
* Copy flavor asset into new entry
*
* @param sourceFlavorAssetId Flavor asset id to be used as the new entry source
* @param documentEntry Document entry metadata
*/
public static AddFromFlavorAssetDocumentsBuilder addFromFlavorAsset(String sourceFlavorAssetId, DocumentEntry documentEntry) {
return new AddFromFlavorAssetDocumentsBuilder(sourceFlavorAssetId, documentEntry);
}
public static class AddFromUploadedFileDocumentsBuilder extends RequestBuilder {
public AddFromUploadedFileDocumentsBuilder(DocumentEntry documentEntry, String uploadTokenId) {
super(DocumentEntry.class, "document_documents", "addFromUploadedFile");
params.add("documentEntry", documentEntry);
params.add("uploadTokenId", uploadTokenId);
}
public void uploadTokenId(String multirequestToken) {
params.add("uploadTokenId", multirequestToken);
}
}
/**
* Add new document entry after the specific document file was uploaded and the
upload token id exists
*
* @param documentEntry Document entry metadata
* @param uploadTokenId Upload token id
*/
public static AddFromUploadedFileDocumentsBuilder addFromUploadedFile(DocumentEntry documentEntry, String uploadTokenId) {
return new AddFromUploadedFileDocumentsBuilder(documentEntry, uploadTokenId);
}
public static class ApproveReplaceDocumentsBuilder extends RequestBuilder {
public ApproveReplaceDocumentsBuilder(String entryId) {
super(DocumentEntry.class, "document_documents", "approveReplace");
params.add("entryId", entryId);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
/**
* Approves document replacement
*
* @param entryId document entry id to replace
*/
public static ApproveReplaceDocumentsBuilder approveReplace(String entryId) {
return new ApproveReplaceDocumentsBuilder(entryId);
}
public static class CancelReplaceDocumentsBuilder extends RequestBuilder {
public CancelReplaceDocumentsBuilder(String entryId) {
super(DocumentEntry.class, "document_documents", "cancelReplace");
params.add("entryId", entryId);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
/**
* Cancels document replacement
*
* @param entryId Document entry id to cancel
*/
public static CancelReplaceDocumentsBuilder cancelReplace(String entryId) {
return new CancelReplaceDocumentsBuilder(entryId);
}
public static class ConvertDocumentsBuilder extends RequestBuilder {
public ConvertDocumentsBuilder(String entryId, int conversionProfileId, List dynamicConversionAttributes) {
super(Long.class, "document_documents", "convert");
params.add("entryId", entryId);
params.add("conversionProfileId", conversionProfileId);
params.add("dynamicConversionAttributes", dynamicConversionAttributes);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
public void conversionProfileId(String multirequestToken) {
params.add("conversionProfileId", multirequestToken);
}
}
public static ConvertDocumentsBuilder convert(String entryId) {
return convert(entryId, Integer.MIN_VALUE);
}
public static ConvertDocumentsBuilder convert(String entryId, int conversionProfileId) {
return convert(entryId, conversionProfileId, null);
}
/**
* Convert entry
*
* @param entryId Document entry id
* @param conversionProfileId
* @param dynamicConversionAttributes
*/
public static ConvertDocumentsBuilder convert(String entryId, int conversionProfileId, List dynamicConversionAttributes) {
return new ConvertDocumentsBuilder(entryId, conversionProfileId, dynamicConversionAttributes);
}
public static class ConvertPptToSwfDocumentsBuilder extends RequestBuilder {
public ConvertPptToSwfDocumentsBuilder(String entryId) {
super(String.class, "document_documents", "convertPptToSwf");
params.add("entryId", entryId);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
/**
* This will queue a batch job for converting the document file to swf Returns
the URL where the new swf will be available
*
* @param entryId
*/
public static ConvertPptToSwfDocumentsBuilder convertPptToSwf(String entryId) {
return new ConvertPptToSwfDocumentsBuilder(entryId);
}
public static class DeleteDocumentsBuilder extends NullRequestBuilder {
public DeleteDocumentsBuilder(String entryId) {
super("document_documents", "delete");
params.add("entryId", entryId);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
/**
* Delete a document entry.
*
* @param entryId Document entry id to delete
*/
public static DeleteDocumentsBuilder delete(String entryId) {
return new DeleteDocumentsBuilder(entryId);
}
public static class GetDocumentsBuilder extends RequestBuilder {
public GetDocumentsBuilder(String entryId, int version) {
super(DocumentEntry.class, "document_documents", "get");
params.add("entryId", entryId);
params.add("version", version);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
public void version(String multirequestToken) {
params.add("version", multirequestToken);
}
}
public static GetDocumentsBuilder get(String entryId) {
return get(entryId, -1);
}
/**
* Get document entry by ID.
*
* @param entryId Document entry id
* @param version Desired version of the data
*/
public static GetDocumentsBuilder get(String entryId, int version) {
return new GetDocumentsBuilder(entryId, version);
}
public static class ListDocumentsBuilder extends ListResponseRequestBuilder {
public ListDocumentsBuilder(DocumentEntryFilter filter, FilterPager pager) {
super(DocumentEntry.class, "document_documents", "list");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListDocumentsBuilder list() {
return list(null);
}
public static ListDocumentsBuilder list(DocumentEntryFilter filter) {
return list(filter, null);
}
/**
* List document entries by filter with paging support.
*
* @param filter Document entry filter
* @param pager Pager
*/
public static ListDocumentsBuilder list(DocumentEntryFilter filter, FilterPager pager) {
return new ListDocumentsBuilder(filter, pager);
}
public static class ServeDocumentsBuilder extends ServeRequestBuilder {
public ServeDocumentsBuilder(String entryId, String flavorAssetId, boolean forceProxy) {
super("document_documents", "serve");
params.add("entryId", entryId);
params.add("flavorAssetId", flavorAssetId);
params.add("forceProxy", forceProxy);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
public void flavorAssetId(String multirequestToken) {
params.add("flavorAssetId", multirequestToken);
}
public void forceProxy(String multirequestToken) {
params.add("forceProxy", multirequestToken);
}
}
public static ServeDocumentsBuilder serve(String entryId) {
return serve(entryId, null);
}
public static ServeDocumentsBuilder serve(String entryId, String flavorAssetId) {
return serve(entryId, flavorAssetId, false);
}
/**
* Serves the file content
*
* @param entryId Document entry id
* @param flavorAssetId Flavor asset id
* @param forceProxy force to get the content without redirect
*/
public static ServeDocumentsBuilder serve(String entryId, String flavorAssetId, boolean forceProxy) {
return new ServeDocumentsBuilder(entryId, flavorAssetId, forceProxy);
}
public static class ServeByFlavorParamsIdDocumentsBuilder extends ServeRequestBuilder {
public ServeByFlavorParamsIdDocumentsBuilder(String entryId, String flavorParamsId, boolean forceProxy) {
super("document_documents", "serveByFlavorParamsId");
params.add("entryId", entryId);
params.add("flavorParamsId", flavorParamsId);
params.add("forceProxy", forceProxy);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
public void flavorParamsId(String multirequestToken) {
params.add("flavorParamsId", multirequestToken);
}
public void forceProxy(String multirequestToken) {
params.add("forceProxy", multirequestToken);
}
}
public static ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId) {
return serveByFlavorParamsId(entryId, null);
}
public static ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId, String flavorParamsId) {
return serveByFlavorParamsId(entryId, flavorParamsId, false);
}
/**
* Serves the file content
*
* @param entryId Document entry id
* @param flavorParamsId Flavor params id
* @param forceProxy force to get the content without redirect
*/
public static ServeByFlavorParamsIdDocumentsBuilder serveByFlavorParamsId(String entryId, String flavorParamsId, boolean forceProxy) {
return new ServeByFlavorParamsIdDocumentsBuilder(entryId, flavorParamsId, forceProxy);
}
public static class UpdateDocumentsBuilder extends RequestBuilder {
public UpdateDocumentsBuilder(String entryId, DocumentEntry documentEntry) {
super(DocumentEntry.class, "document_documents", "update");
params.add("entryId", entryId);
params.add("documentEntry", documentEntry);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
}
/**
* Update document entry. Only the properties that were set will be updated.
*
* @param entryId Document entry id to update
* @param documentEntry Document entry metadata to update
*/
public static UpdateDocumentsBuilder update(String entryId, DocumentEntry documentEntry) {
return new UpdateDocumentsBuilder(entryId, documentEntry);
}
public static class UpdateContentDocumentsBuilder extends RequestBuilder {
public UpdateContentDocumentsBuilder(String entryId, Resource resource, int conversionProfileId) {
super(DocumentEntry.class, "document_documents", "updateContent");
params.add("entryId", entryId);
params.add("resource", resource);
params.add("conversionProfileId", conversionProfileId);
}
public void entryId(String multirequestToken) {
params.add("entryId", multirequestToken);
}
public void conversionProfileId(String multirequestToken) {
params.add("conversionProfileId", multirequestToken);
}
}
public static UpdateContentDocumentsBuilder updateContent(String entryId, Resource resource) {
return updateContent(entryId, resource, Integer.MIN_VALUE);
}
/**
* Replace content associated with the given document entry.
*
* @param entryId document entry id to update
* @param resource Resource to be used to replace entry doc content
* @param conversionProfileId The conversion profile id to be used on the entry
*/
public static UpdateContentDocumentsBuilder updateContent(String entryId, Resource resource, int conversionProfileId) {
return new UpdateContentDocumentsBuilder(entryId, resource, conversionProfileId);
}
public static class UploadDocumentsBuilder extends RequestBuilder {
public UploadDocumentsBuilder(FileHolder fileData) {
super(String.class, "document_documents", "upload");
files = new Files();
files.add("fileData", fileData);
}
}
public static UploadDocumentsBuilder upload(File fileData) {
return upload(new FileHolder(fileData));
}
public static UploadDocumentsBuilder upload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize) {
return upload(new FileHolder(fileData, fileDataMimeType, fileDataName, fileDataSize));
}
public static UploadDocumentsBuilder upload(FileInputStream fileData, String fileDataMimeType, String fileDataName) {
return upload(new FileHolder(fileData, fileDataMimeType, fileDataName));
}
/**
* Upload a document file to Kaltura, then the file can be used to create a
document entry.
*
* @param fileData The file data
*/
public static UploadDocumentsBuilder upload(FileHolder fileData) {
return new UploadDocumentsBuilder(fileData);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy