kaltura
Version:
Kaltura NodeJS clientlibs
1,448 lines (1,282 loc) • 517 kB
JavaScript
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' </ _` | | _| || | '_/ _` |
// |_|\_\__,_|_|\__|\_,_|_| \__,_|
//
// This file is part of the Kaltura Collaborative Media Suite which allows users
// to do with audio, video, and animation what Wiki platfroms allow them to do with
// text.
//
// Copyright (C) 2006-2016 Kaltura Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// @ignore
// ===================================================================================================
var util = require('util');
var kaltura = require('./KalturaClientBase');
/**
* @param totalCount int (readOnly).
*/
function KalturaListResponse(){
KalturaListResponse.super_.call(this);
this.totalCount = null;
}
module.exports.KalturaListResponse = KalturaListResponse;
util.inherits(KalturaListResponse, kaltura.KalturaObjectBase);
/**
*/
function KalturaBaseRestriction(){
KalturaBaseRestriction.super_.call(this);
}
module.exports.KalturaBaseRestriction = KalturaBaseRestriction;
util.inherits(KalturaBaseRestriction, kaltura.KalturaObjectBase);
/**
* @param id int The id of the Access Control Profile (readOnly).
* @param partnerId int (readOnly).
* @param name string The name of the Access Control Profile.
* @param systemName string System name of the Access Control Profile.
* @param description string The description of the Access Control Profile.
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param isDefault int True if this Conversion Profile is the default.
* @param restrictions array Array of Access Control Restrictions.
* @param containsUnsuportedRestrictions bool Indicates that the access control profile is new and should be handled using KalturaAccessControlProfile object and accessControlProfile service (readOnly).
*/
function KalturaAccessControl(){
KalturaAccessControl.super_.call(this);
this.id = null;
this.partnerId = null;
this.name = null;
this.systemName = null;
this.description = null;
this.createdAt = null;
this.isDefault = null;
this.restrictions = null;
this.containsUnsuportedRestrictions = null;
}
module.exports.KalturaAccessControl = KalturaAccessControl;
util.inherits(KalturaAccessControl, kaltura.KalturaObjectBase);
/**
* @param type string The type of the condition context.
*/
function KalturaContextTypeHolder(){
KalturaContextTypeHolder.super_.call(this);
this.type = null;
}
module.exports.KalturaContextTypeHolder = KalturaContextTypeHolder;
util.inherits(KalturaContextTypeHolder, kaltura.KalturaObjectBase);
/**
*/
function KalturaAccessControlContextTypeHolder(){
KalturaAccessControlContextTypeHolder.super_.call(this);
}
module.exports.KalturaAccessControlContextTypeHolder = KalturaAccessControlContextTypeHolder;
util.inherits(KalturaAccessControlContextTypeHolder, KalturaContextTypeHolder);
/**
* @param type string The type of the action (readOnly).
*/
function KalturaRuleAction(){
KalturaRuleAction.super_.call(this);
this.type = null;
}
module.exports.KalturaRuleAction = KalturaRuleAction;
util.inherits(KalturaRuleAction, kaltura.KalturaObjectBase);
/**
* @param type string The type of the access control condition (readOnly).
* @param description string .
* @param not bool .
*/
function KalturaCondition(){
KalturaCondition.super_.call(this);
this.type = null;
this.description = null;
this.not = null;
}
module.exports.KalturaCondition = KalturaCondition;
util.inherits(KalturaCondition, kaltura.KalturaObjectBase);
/**
* @param description string Short Rule Description.
* @param ruleData string Rule Custom Data to allow saving rule specific information.
* @param message string Message to be thrown to the player in case the rule is fulfilled.
* @param actions array Actions to be performed by the player in case the rule is fulfilled.
* @param conditions array Conditions to validate the rule.
* @param contexts array Indicates what contexts should be tested by this rule.
* @param stopProcessing bool Indicates that this rule is enough and no need to continue checking the rest of the rules.
* @param forceAdminValidation int Indicates if we should force ks validation for admin ks users as well.
*/
function KalturaRule(){
KalturaRule.super_.call(this);
this.description = null;
this.ruleData = null;
this.message = null;
this.actions = null;
this.conditions = null;
this.contexts = null;
this.stopProcessing = null;
this.forceAdminValidation = null;
}
module.exports.KalturaRule = KalturaRule;
util.inherits(KalturaRule, kaltura.KalturaObjectBase);
/**
* @param id int The id of the Access Control Profile (readOnly).
* @param partnerId int (readOnly).
* @param name string The name of the Access Control Profile.
* @param systemName string System name of the Access Control Profile.
* @param description string The description of the Access Control Profile.
* @param createdAt int Creation time as Unix timestamp (In seconds) (readOnly).
* @param updatedAt int Update time as Unix timestamp (In seconds) (readOnly).
* @param isDefault int True if this access control profile is the partner default.
* @param rules array Array of access control rules.
*/
function KalturaAccessControlProfile(){
KalturaAccessControlProfile.super_.call(this);
this.id = null;
this.partnerId = null;
this.name = null;
this.systemName = null;
this.description = null;
this.createdAt = null;
this.updatedAt = null;
this.isDefault = null;
this.rules = null;
}
module.exports.KalturaAccessControlProfile = KalturaAccessControlProfile;
util.inherits(KalturaAccessControlProfile, kaltura.KalturaObjectBase);
/**
* @param key string .
* @param value string .
*/
function KalturaKeyValue(){
KalturaKeyValue.super_.call(this);
this.key = null;
this.value = null;
}
module.exports.KalturaKeyValue = KalturaKeyValue;
util.inherits(KalturaKeyValue, kaltura.KalturaObjectBase);
/**
* @param referrer string URL to be used to test domain conditions.
* @param ip string IP to be used to test geographic location conditions.
* @param ks string Kaltura session to be used to test session and user conditions.
* @param userAgent string Browser or client application to be used to test agent conditions.
* @param time int Unix timestamp (In seconds) to be used to test entry scheduling, keep null to use now.
* @param contexts array Indicates what contexts should be tested. No contexts means any context.
* @param hashes array Array of hashes to pass to the access control profile scope.
*/
function KalturaAccessControlScope(){
KalturaAccessControlScope.super_.call(this);
this.referrer = null;
this.ip = null;
this.ks = null;
this.userAgent = null;
this.time = null;
this.contexts = null;
this.hashes = null;
}
module.exports.KalturaAccessControlScope = KalturaAccessControlScope;
util.inherits(KalturaAccessControlScope, kaltura.KalturaObjectBase);
/**
* @param dimension string The dimension whose values should be filtered.
* @param values string The (comma separated) values to include in the filter.
*/
function KalturaReportFilter(){
KalturaReportFilter.super_.call(this);
this.dimension = null;
this.values = null;
}
module.exports.KalturaReportFilter = KalturaReportFilter;
util.inherits(KalturaReportFilter, kaltura.KalturaObjectBase);
/**
* @param from_time string Query start time (in local time).
* @param to_time string Query end time (in local time).
* @param metrics string Comma separated metrics list.
* @param utcOffset float Timezone offset from UTC (in minutes).
* @param dimensions string Comma separated dimensions list.
* @param filters array Array of filters.
*/
function KalturaAnalyticsFilter(){
KalturaAnalyticsFilter.super_.call(this);
this.from_time = null;
this.to_time = null;
this.metrics = null;
this.utcOffset = null;
this.dimensions = null;
this.filters = null;
}
module.exports.KalturaAnalyticsFilter = KalturaAnalyticsFilter;
util.inherits(KalturaAnalyticsFilter, kaltura.KalturaObjectBase);
/**
* @param id string (readOnly).
* @param cuePointType string (readOnly).
* @param status int (readOnly).
* @param entryId string (insertOnly).
* @param partnerId int (readOnly).
* @param createdAt int (readOnly).
* @param updatedAt int (readOnly).
* @param triggeredAt int .
* @param tags string .
* @param startTime int Start time in milliseconds.
* @param userId string (readOnly).
* @param partnerData string .
* @param partnerSortValue int .
* @param forceStop int .
* @param thumbOffset int .
* @param systemName string .
*/
function KalturaCuePoint(){
KalturaCuePoint.super_.call(this);
this.id = null;
this.cuePointType = null;
this.status = null;
this.entryId = null;
this.partnerId = null;
this.createdAt = null;
this.updatedAt = null;
this.triggeredAt = null;
this.tags = null;
this.startTime = null;
this.userId = null;
this.partnerData = null;
this.partnerSortValue = null;
this.forceStop = null;
this.thumbOffset = null;
this.systemName = null;
}
module.exports.KalturaCuePoint = KalturaCuePoint;
util.inherits(KalturaCuePoint, kaltura.KalturaObjectBase);
/**
* @param parentId string (insertOnly).
* @param text string .
* @param endTime int End time in milliseconds.
* @param duration int Duration in milliseconds (readOnly).
* @param depth int Depth in the tree (readOnly).
* @param childrenCount int Number of all descendants (readOnly).
* @param directChildrenCount int Number of children, first generation only (readOnly).
* @param isPublic int Is the annotation public.
* @param searchableOnEntry int Should the cue point get indexed on the entry.
*/
function KalturaAnnotation(){
KalturaAnnotation.super_.call(this);
this.parentId = null;
this.text = null;
this.endTime = null;
this.duration = null;
this.depth = null;
this.childrenCount = null;
this.directChildrenCount = null;
this.isPublic = null;
this.searchableOnEntry = null;
}
module.exports.KalturaAnnotation = KalturaAnnotation;
util.inherits(KalturaAnnotation, KalturaCuePoint);
/**
* @param name string .
* @param value string .
*/
function KalturaApiExceptionArg(){
KalturaApiExceptionArg.super_.call(this);
this.name = null;
this.value = null;
}
module.exports.KalturaApiExceptionArg = KalturaApiExceptionArg;
util.inherits(KalturaApiExceptionArg, kaltura.KalturaObjectBase);
/**
* @param id string The id of the application token (readOnly).
* @param token string The application token (readOnly).
* @param partnerId int (readOnly).
* @param createdAt int Creation time as Unix timestamp (In seconds) (readOnly).
* @param updatedAt int Update time as Unix timestamp (In seconds) (readOnly).
* @param status int Application token status (readOnly).
* @param expiry int Expiry time of current token (unix timestamp in seconds).
* @param sessionType int Type of KS (Kaltura Session) that created using the current token.
* @param sessionUserId string User id of KS (Kaltura Session) that created using the current token.
* @param sessionDuration int Expiry duration of KS (Kaltura Session) that created using the current token (in seconds).
* @param sessionPrivileges string Comma separated privileges to be applied on KS (Kaltura Session) that created using the current token.
* @param hashType string .
*/
function KalturaAppToken(){
KalturaAppToken.super_.call(this);
this.id = null;
this.token = null;
this.partnerId = null;
this.createdAt = null;
this.updatedAt = null;
this.status = null;
this.expiry = null;
this.sessionType = null;
this.sessionUserId = null;
this.sessionDuration = null;
this.sessionPrivileges = null;
this.hashType = null;
}
module.exports.KalturaAppToken = KalturaAppToken;
util.inherits(KalturaAppToken, kaltura.KalturaObjectBase);
/**
* @param id string The ID of the Flavor Asset (readOnly).
* @param entryId string The entry ID of the Flavor Asset (readOnly).
* @param partnerId int (readOnly).
* @param version int The version of the Flavor Asset (readOnly).
* @param size int The size (in KBytes) of the Flavor Asset (readOnly).
* @param tags string Tags used to identify the Flavor Asset in various scenarios.
* @param fileExt string The file extension (insertOnly).
* @param createdAt int (readOnly).
* @param updatedAt int (readOnly).
* @param deletedAt int (readOnly).
* @param description string System description, error message, warnings and failure cause (readOnly).
* @param partnerData string Partner private data.
* @param partnerDescription string Partner friendly description.
* @param actualSourceAssetParamsIds string Comma separated list of source flavor params ids.
*/
function KalturaAsset(){
KalturaAsset.super_.call(this);
this.id = null;
this.entryId = null;
this.partnerId = null;
this.version = null;
this.size = null;
this.tags = null;
this.fileExt = null;
this.createdAt = null;
this.updatedAt = null;
this.deletedAt = null;
this.description = null;
this.partnerData = null;
this.partnerDescription = null;
this.actualSourceAssetParamsIds = null;
}
module.exports.KalturaAsset = KalturaAsset;
util.inherits(KalturaAsset, kaltura.KalturaObjectBase);
/**
*/
function KalturaAssetDistributionCondition(){
KalturaAssetDistributionCondition.super_.call(this);
}
module.exports.KalturaAssetDistributionCondition = KalturaAssetDistributionCondition;
util.inherits(KalturaAssetDistributionCondition, kaltura.KalturaObjectBase);
/**
* @param validationError string The validation error description that will be set on the "data" property on KalturaDistributionValidationErrorMissingAsset if rule was not fulfilled.
* @param assetDistributionConditions array An array of asset distribution conditions.
*/
function KalturaAssetDistributionRule(){
KalturaAssetDistributionRule.super_.call(this);
this.validationError = null;
this.assetDistributionConditions = null;
}
module.exports.KalturaAssetDistributionRule = KalturaAssetDistributionRule;
util.inherits(KalturaAssetDistributionRule, kaltura.KalturaObjectBase);
/**
* @param value string .
*/
function KalturaString(){
KalturaString.super_.call(this);
this.value = null;
}
module.exports.KalturaString = KalturaString;
util.inherits(KalturaString, kaltura.KalturaObjectBase);
/**
* @param id int The id of the Flavor Params (readOnly).
* @param partnerId int .
* @param name string The name of the Flavor Params.
* @param systemName string System name of the Flavor Params.
* @param description string The description of the Flavor Params.
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param isSystemDefault int True if those Flavor Params are part of system defaults (readOnly).
* @param tags string The Flavor Params tags are used to identify the flavor for different usage (e.g. web, hd, mobile).
* @param requiredPermissions array Array of partner permisison names that required for using this asset params.
* @param sourceRemoteStorageProfileId int Id of remote storage profile that used to get the source, zero indicates Kaltura data center.
* @param remoteStorageProfileIds int Comma seperated ids of remote storage profiles that the flavor distributed to, the distribution done by the conversion engine.
* @param mediaParserType string Media parser type to be used for post-conversion validation.
* @param sourceAssetParamsIds string Comma seperated ids of source flavor params this flavor is created from.
*/
function KalturaAssetParams(){
KalturaAssetParams.super_.call(this);
this.id = null;
this.partnerId = null;
this.name = null;
this.systemName = null;
this.description = null;
this.createdAt = null;
this.isSystemDefault = null;
this.tags = null;
this.requiredPermissions = null;
this.sourceRemoteStorageProfileId = null;
this.remoteStorageProfileIds = null;
this.mediaParserType = null;
this.sourceAssetParamsIds = null;
}
module.exports.KalturaAssetParams = KalturaAssetParams;
util.inherits(KalturaAssetParams, kaltura.KalturaObjectBase);
/**
*/
function KalturaResource(){
KalturaResource.super_.call(this);
}
module.exports.KalturaResource = KalturaResource;
util.inherits(KalturaResource, kaltura.KalturaObjectBase);
/**
*/
function KalturaContentResource(){
KalturaContentResource.super_.call(this);
}
module.exports.KalturaContentResource = KalturaContentResource;
util.inherits(KalturaContentResource, KalturaResource);
/**
* @param resource KalturaContentResource The content resource to associate with asset params.
* @param assetParamsId int The asset params to associate with the reaource.
*/
function KalturaAssetParamsResourceContainer(){
KalturaAssetParamsResourceContainer.super_.call(this);
this.resource = null;
this.assetParamsId = null;
}
module.exports.KalturaAssetParamsResourceContainer = KalturaAssetParamsResourceContainer;
util.inherits(KalturaAssetParamsResourceContainer, KalturaResource);
/**
* @param filename string The filename of the attachment asset content.
* @param title string Attachment asset title.
* @param format string The attachment format.
* @param status int The status of the asset (readOnly).
*/
function KalturaAttachmentAsset(){
KalturaAttachmentAsset.super_.call(this);
this.filename = null;
this.title = null;
this.format = null;
this.status = null;
}
module.exports.KalturaAttachmentAsset = KalturaAttachmentAsset;
util.inherits(KalturaAttachmentAsset, KalturaAsset);
/**
*/
function KalturaOperationAttributes(){
KalturaOperationAttributes.super_.call(this);
}
module.exports.KalturaOperationAttributes = KalturaOperationAttributes;
util.inherits(KalturaOperationAttributes, kaltura.KalturaObjectBase);
/**
* @param id string Auto generated 10 characters alphanumeric string (readOnly).
* @param name string Entry name (Min 1 chars).
* @param description string Entry description.
* @param partnerId int (readOnly).
* @param userId string The ID of the user who is the owner of this entry.
* @param creatorId string The ID of the user who created this entry (insertOnly).
* @param tags string Entry tags.
* @param adminTags string Entry admin tags can be updated only by administrators.
* @param categories string Comma separated list of full names of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.
* @param categoriesIds string Comma separated list of ids of categories to which this entry belongs. Only categories that don't have entitlement (privacy context) are listed, to retrieve the full list of categories, use the categoryEntry.list action.
* @param status string (readOnly).
* @param moderationStatus int Entry moderation status (readOnly).
* @param moderationCount int Number of moderation requests waiting for this entry (readOnly).
* @param type string The type of the entry, this is auto filled by the derived entry object.
* @param createdAt int Entry creation date as Unix timestamp (In seconds) (readOnly).
* @param updatedAt int Entry update date as Unix timestamp (In seconds) (readOnly).
* @param rank float The calculated average rank. rank = totalRank / votes (readOnly).
* @param totalRank int The sum of all rank values submitted to the baseEntry.anonymousRank action (readOnly).
* @param votes int A count of all requests made to the baseEntry.anonymousRank action (readOnly).
* @param groupId int .
* @param partnerData string Can be used to store various partner related data as a string.
* @param downloadUrl string Download URL for the entry (readOnly).
* @param searchText string Indexed search text for full text search (readOnly).
* @param licenseType int License type used for this entry.
* @param version int Version of the entry data (readOnly).
* @param thumbnailUrl string Thumbnail URL (readOnly).
* @param accessControlId int The Access Control ID assigned to this entry (null when not set, send -1 to remove).
* @param startDate int Entry scheduling start date (null when not set, send -1 to remove).
* @param endDate int Entry scheduling end date (null when not set, send -1 to remove).
* @param referenceId string Entry external reference id.
* @param replacingEntryId string ID of temporary entry that will replace this entry when it's approved and ready for replacement (readOnly).
* @param replacedEntryId string ID of the entry that will be replaced when the replacement approved and this entry is ready (readOnly).
* @param replacementStatus string Status of the replacement readiness and approval (readOnly).
* @param partnerSortValue int Can be used to store various partner related data as a numeric value.
* @param conversionProfileId int Override the default ingestion profile.
* @param redirectEntryId string IF not empty, points to an entry ID the should replace this current entry's id.
* @param rootEntryId string ID of source root entry, used for clipped, skipped and cropped entries that created from another entry (readOnly).
* @param parentEntryId string ID of source root entry, used for defining entires association.
* @param operationAttributes array clipping, skipping and cropping attributes that used to create this entry.
* @param entitledUsersEdit string list of user ids that are entitled to edit the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only.
* @param entitledUsersPublish string list of user ids that are entitled to publish the entry (no server enforcement) The difference between entitledUsersEdit and entitledUsersPublish is applicative only.
* @param capabilities string Comma seperated string of the capabilities of the entry. Any capability needed can be added to this list (readOnly).
* @param templateEntryId string Template entry id (insertOnly).
* @param displayInSearch int should we display this entry in search.
*/
function KalturaBaseEntry(){
KalturaBaseEntry.super_.call(this);
this.id = null;
this.name = null;
this.description = null;
this.partnerId = null;
this.userId = null;
this.creatorId = null;
this.tags = null;
this.adminTags = null;
this.categories = null;
this.categoriesIds = null;
this.status = null;
this.moderationStatus = null;
this.moderationCount = null;
this.type = null;
this.createdAt = null;
this.updatedAt = null;
this.rank = null;
this.totalRank = null;
this.votes = null;
this.groupId = null;
this.partnerData = null;
this.downloadUrl = null;
this.searchText = null;
this.licenseType = null;
this.version = null;
this.thumbnailUrl = null;
this.accessControlId = null;
this.startDate = null;
this.endDate = null;
this.referenceId = null;
this.replacingEntryId = null;
this.replacedEntryId = null;
this.replacementStatus = null;
this.partnerSortValue = null;
this.conversionProfileId = null;
this.redirectEntryId = null;
this.rootEntryId = null;
this.parentEntryId = null;
this.operationAttributes = null;
this.entitledUsersEdit = null;
this.entitledUsersPublish = null;
this.capabilities = null;
this.templateEntryId = null;
this.displayInSearch = null;
}
module.exports.KalturaBaseEntry = KalturaBaseEntry;
util.inherits(KalturaBaseEntry, kaltura.KalturaObjectBase);
/**
*/
function KalturaBaseEntryCloneOptionItem(){
KalturaBaseEntryCloneOptionItem.super_.call(this);
}
module.exports.KalturaBaseEntryCloneOptionItem = KalturaBaseEntryCloneOptionItem;
util.inherits(KalturaBaseEntryCloneOptionItem, kaltura.KalturaObjectBase);
/**
*/
function KalturaBaseResponseProfile(){
KalturaBaseResponseProfile.super_.call(this);
}
module.exports.KalturaBaseResponseProfile = KalturaBaseResponseProfile;
util.inherits(KalturaBaseResponseProfile, kaltura.KalturaObjectBase);
/**
* @param id string (readOnly).
* @param feedUrl string (readOnly).
* @param partnerId int (readOnly).
* @param playlistId string link a playlist that will set what content the feed will include
* if empty, all content will be included in feed.
* @param name string feed name.
* @param status int feed status (readOnly).
* @param type int feed type (insertOnly).
* @param landingPage string Base URL for each video, on the partners site
* This is required by all syndication types.
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param allowEmbed bool allow_embed tells google OR yahoo weather to allow embedding the video on google OR yahoo video results
* or just to provide a link to the landing page.
* it is applied on the video-player_loc property in the XML (google)
* and addes media-player tag (yahoo).
* @param playerUiconfId int Select a uiconf ID as player skin to include in the kwidget url.
* @param flavorParamId int .
* @param transcodeExistingContent bool .
* @param addToDefaultConversionProfile bool .
* @param categories string .
* @param storageId int .
* @param entriesOrderBy string .
* @param enforceEntitlement bool Should enforce entitlement on feed entries.
* @param privacyContext string Set privacy context for search entries that assiged to private and public categories within a category privacy context.
* @param updatedAt int Update date as Unix timestamp (In seconds) (readOnly).
* @param useCategoryEntries bool .
* @param feedContentTypeHeader string Feed content-type header value.
*/
function KalturaBaseSyndicationFeed(){
KalturaBaseSyndicationFeed.super_.call(this);
this.id = null;
this.feedUrl = null;
this.partnerId = null;
this.playlistId = null;
this.name = null;
this.status = null;
this.type = null;
this.landingPage = null;
this.createdAt = null;
this.allowEmbed = null;
this.playerUiconfId = null;
this.flavorParamId = null;
this.transcodeExistingContent = null;
this.addToDefaultConversionProfile = null;
this.categories = null;
this.storageId = null;
this.entriesOrderBy = null;
this.enforceEntitlement = null;
this.privacyContext = null;
this.updatedAt = null;
this.useCategoryEntries = null;
this.feedContentTypeHeader = null;
}
module.exports.KalturaBaseSyndicationFeed = KalturaBaseSyndicationFeed;
util.inherits(KalturaBaseSyndicationFeed, kaltura.KalturaObjectBase);
/**
*/
function KalturaJobData(){
KalturaJobData.super_.call(this);
}
module.exports.KalturaJobData = KalturaJobData;
util.inherits(KalturaJobData, kaltura.KalturaObjectBase);
/**
* @param schedulerId int .
* @param workerId int .
* @param batchIndex int .
* @param timeStamp int .
* @param message string .
* @param errType int .
* @param errNumber int .
* @param hostName string .
* @param sessionId string .
*/
function KalturaBatchHistoryData(){
KalturaBatchHistoryData.super_.call(this);
this.schedulerId = null;
this.workerId = null;
this.batchIndex = null;
this.timeStamp = null;
this.message = null;
this.errType = null;
this.errNumber = null;
this.hostName = null;
this.sessionId = null;
}
module.exports.KalturaBatchHistoryData = KalturaBatchHistoryData;
util.inherits(KalturaBatchHistoryData, kaltura.KalturaObjectBase);
/**
* @param id int (readOnly).
* @param partnerId int (readOnly).
* @param createdAt int (readOnly).
* @param updatedAt int (readOnly).
* @param deletedAt int (readOnly).
* @param lockExpiration int (readOnly).
* @param executionAttempts int (readOnly).
* @param lockVersion int (readOnly).
* @param entryId string .
* @param entryName string .
* @param jobType string (readOnly).
* @param jobSubType int .
* @param data KalturaJobData .
* @param status int .
* @param abort int .
* @param checkAgainTimeout int .
* @param message string .
* @param description string .
* @param priority int .
* @param history array .
* @param bulkJobId int The id of the bulk upload job that initiated this job.
* @param batchVersion int .
* @param parentJobId int When one job creates another - the parent should set this parentJobId to be its own id.
* @param rootJobId int The id of the root parent job.
* @param queueTime int The time that the job was pulled from the queue.
* @param finishTime int The time that the job was finished or closed as failed.
* @param errType int .
* @param errNumber int .
* @param estimatedEffort int .
* @param urgency int .
* @param schedulerId int .
* @param workerId int .
* @param batchIndex int .
* @param lastSchedulerId int .
* @param lastWorkerId int .
* @param dc int .
* @param jobObjectId string .
* @param jobObjectType int .
*/
function KalturaBatchJob(){
KalturaBatchJob.super_.call(this);
this.id = null;
this.partnerId = null;
this.createdAt = null;
this.updatedAt = null;
this.deletedAt = null;
this.lockExpiration = null;
this.executionAttempts = null;
this.lockVersion = null;
this.entryId = null;
this.entryName = null;
this.jobType = null;
this.jobSubType = null;
this.data = null;
this.status = null;
this.abort = null;
this.checkAgainTimeout = null;
this.message = null;
this.description = null;
this.priority = null;
this.history = null;
this.bulkJobId = null;
this.batchVersion = null;
this.parentJobId = null;
this.rootJobId = null;
this.queueTime = null;
this.finishTime = null;
this.errType = null;
this.errNumber = null;
this.estimatedEffort = null;
this.urgency = null;
this.schedulerId = null;
this.workerId = null;
this.batchIndex = null;
this.lastSchedulerId = null;
this.lastWorkerId = null;
this.dc = null;
this.jobObjectId = null;
this.jobObjectType = null;
}
module.exports.KalturaBatchJob = KalturaBatchJob;
util.inherits(KalturaBatchJob, kaltura.KalturaObjectBase);
/**
* @param id string .
* @param label string .
* @param flashvars array .
* @param minVersion string .
* @param enabledByDefault bool .
*/
function KalturaPlayerDeliveryType(){
KalturaPlayerDeliveryType.super_.call(this);
this.id = null;
this.label = null;
this.flashvars = null;
this.minVersion = null;
this.enabledByDefault = null;
}
module.exports.KalturaPlayerDeliveryType = KalturaPlayerDeliveryType;
util.inherits(KalturaPlayerDeliveryType, kaltura.KalturaObjectBase);
/**
* @param id string .
* @param label string .
* @param entryOnly bool .
* @param minVersion string .
*/
function KalturaPlayerEmbedCodeType(){
KalturaPlayerEmbedCodeType.super_.call(this);
this.id = null;
this.label = null;
this.entryOnly = null;
this.minVersion = null;
}
module.exports.KalturaPlayerEmbedCodeType = KalturaPlayerEmbedCodeType;
util.inherits(KalturaPlayerEmbedCodeType, kaltura.KalturaObjectBase);
/**
* @param id int (readOnly).
* @param name string .
* @param website string .
* @param notificationUrl string .
* @param appearInSearch int .
* @param createdAt int (readOnly).
* @param adminName string deprecated - lastName and firstName replaces this field.
* @param adminEmail string .
* @param description string .
* @param commercialUse int .
* @param landingPage string .
* @param userLandingPage string .
* @param contentCategories string .
* @param type int .
* @param phone string .
* @param describeYourself string .
* @param adultContent bool .
* @param defConversionProfileType string .
* @param notify int .
* @param status int (readOnly).
* @param allowQuickEdit int .
* @param mergeEntryLists int .
* @param notificationsConfig string .
* @param maxUploadSize int .
* @param partnerPackage int (readOnly).
* @param secret string (readOnly).
* @param adminSecret string (readOnly).
* @param cmsPassword string (readOnly).
* @param allowMultiNotification int .
* @param adminLoginUsersQuota int (readOnly).
* @param adminUserId string .
* @param firstName string firstName and lastName replace the old (deprecated) adminName.
* @param lastName string lastName and firstName replace the old (deprecated) adminName.
* @param country string country code (2char) - this field is optional.
* @param state string state code (2char) - this field is optional.
* @param additionalParams array (insertOnly).
* @param publishersQuota int (readOnly).
* @param partnerGroupType int (readOnly).
* @param defaultEntitlementEnforcement bool (readOnly).
* @param defaultDeliveryType string (readOnly).
* @param defaultEmbedCodeType string (readOnly).
* @param deliveryTypes array (readOnly).
* @param embedCodeTypes array (readOnly).
* @param templatePartnerId int (readOnly).
* @param ignoreSeoLinks bool (readOnly).
* @param host string (readOnly).
* @param cdnHost string (readOnly).
* @param isFirstLogin bool (readOnly).
* @param logoutUrl string (readOnly).
* @param partnerParentId int (readOnly).
* @param crmId string (readOnly).
* @param referenceId string .
* @param timeAlignedRenditions bool (readOnly).
*/
function KalturaPartner(){
KalturaPartner.super_.call(this);
this.id = null;
this.name = null;
this.website = null;
this.notificationUrl = null;
this.appearInSearch = null;
this.createdAt = null;
this.adminName = null;
this.adminEmail = null;
this.description = null;
this.commercialUse = null;
this.landingPage = null;
this.userLandingPage = null;
this.contentCategories = null;
this.type = null;
this.phone = null;
this.describeYourself = null;
this.adultContent = null;
this.defConversionProfileType = null;
this.notify = null;
this.status = null;
this.allowQuickEdit = null;
this.mergeEntryLists = null;
this.notificationsConfig = null;
this.maxUploadSize = null;
this.partnerPackage = null;
this.secret = null;
this.adminSecret = null;
this.cmsPassword = null;
this.allowMultiNotification = null;
this.adminLoginUsersQuota = null;
this.adminUserId = null;
this.firstName = null;
this.lastName = null;
this.country = null;
this.state = null;
this.additionalParams = null;
this.publishersQuota = null;
this.partnerGroupType = null;
this.defaultEntitlementEnforcement = null;
this.defaultDeliveryType = null;
this.defaultEmbedCodeType = null;
this.deliveryTypes = null;
this.embedCodeTypes = null;
this.templatePartnerId = null;
this.ignoreSeoLinks = null;
this.host = null;
this.cdnHost = null;
this.isFirstLogin = null;
this.logoutUrl = null;
this.partnerParentId = null;
this.crmId = null;
this.referenceId = null;
this.timeAlignedRenditions = null;
}
module.exports.KalturaPartner = KalturaPartner;
util.inherits(KalturaPartner, kaltura.KalturaObjectBase);
/**
* @param description string .
*/
function KalturaValue(){
KalturaValue.super_.call(this);
this.description = null;
}
module.exports.KalturaValue = KalturaValue;
util.inherits(KalturaValue, kaltura.KalturaObjectBase);
/**
* @param value bool .
*/
function KalturaBooleanValue(){
KalturaBooleanValue.super_.call(this);
this.value = null;
}
module.exports.KalturaBooleanValue = KalturaBooleanValue;
util.inherits(KalturaBooleanValue, KalturaValue);
/**
*/
function KalturaBulkServiceData(){
KalturaBulkServiceData.super_.call(this);
}
module.exports.KalturaBulkServiceData = KalturaBulkServiceData;
util.inherits(KalturaBulkServiceData, kaltura.KalturaObjectBase);
/**
* @param field string .
* @param value string .
*/
function KalturaBulkUploadPluginData(){
KalturaBulkUploadPluginData.super_.call(this);
this.field = null;
this.value = null;
}
module.exports.KalturaBulkUploadPluginData = KalturaBulkUploadPluginData;
util.inherits(KalturaBulkUploadPluginData, kaltura.KalturaObjectBase);
/**
* @param id int The id of the result (readOnly).
* @param bulkUploadJobId int The id of the parent job.
* @param lineIndex int The index of the line in the CSV.
* @param partnerId int .
* @param status string .
* @param action string .
* @param objectId string .
* @param objectStatus int .
* @param bulkUploadResultObjectType string .
* @param rowData string The data as recieved in the csv.
* @param partnerData string .
* @param objectErrorDescription string .
* @param pluginsData array .
* @param errorDescription string .
* @param errorCode string .
* @param errorType int .
*/
function KalturaBulkUploadResult(){
KalturaBulkUploadResult.super_.call(this);
this.id = null;
this.bulkUploadJobId = null;
this.lineIndex = null;
this.partnerId = null;
this.status = null;
this.action = null;
this.objectId = null;
this.objectStatus = null;
this.bulkUploadResultObjectType = null;
this.rowData = null;
this.partnerData = null;
this.objectErrorDescription = null;
this.pluginsData = null;
this.errorDescription = null;
this.errorCode = null;
this.errorType = null;
}
module.exports.KalturaBulkUploadResult = KalturaBulkUploadResult;
util.inherits(KalturaBulkUploadResult, kaltura.KalturaObjectBase);
/**
* @param id int .
* @param uploadedBy string .
* @param uploadedByUserId string .
* @param uploadedOn int .
* @param numOfEntries int .
* @param status int .
* @param logFileUrl string .
* @param csvFileUrl string .
* @param bulkFileUrl string .
* @param bulkUploadType string .
* @param results array .
* @param error string .
* @param errorType int .
* @param errorNumber int .
* @param fileName string .
* @param description string .
* @param numOfObjects int .
* @param bulkUploadObjectType string .
*/
function KalturaBulkUpload(){
KalturaBulkUpload.super_.call(this);
this.id = null;
this.uploadedBy = null;
this.uploadedByUserId = null;
this.uploadedOn = null;
this.numOfEntries = null;
this.status = null;
this.logFileUrl = null;
this.csvFileUrl = null;
this.bulkFileUrl = null;
this.bulkUploadType = null;
this.results = null;
this.error = null;
this.errorType = null;
this.errorNumber = null;
this.fileName = null;
this.description = null;
this.numOfObjects = null;
this.bulkUploadObjectType = null;
}
module.exports.KalturaBulkUpload = KalturaBulkUpload;
util.inherits(KalturaBulkUpload, kaltura.KalturaObjectBase);
/**
*/
function KalturaBulkUploadObjectData(){
KalturaBulkUploadObjectData.super_.call(this);
}
module.exports.KalturaBulkUploadObjectData = KalturaBulkUploadObjectData;
util.inherits(KalturaBulkUploadObjectData, kaltura.KalturaObjectBase);
/**
* @param id string (readOnly).
* @param partnerId int .
* @param browser string .
* @param serverIp string .
* @param serverOs string .
* @param phpVersion string .
* @param ceAdminEmail string .
* @param type string .
* @param description string .
* @param data string .
*/
function KalturaCEError(){
KalturaCEError.super_.call(this);
this.id = null;
this.partnerId = null;
this.browser = null;
this.serverIp = null;
this.serverOs = null;
this.phpVersion = null;
this.ceAdminEmail = null;
this.type = null;
this.description = null;
this.data = null;
}
module.exports.KalturaCEError = KalturaCEError;
util.inherits(KalturaCEError, kaltura.KalturaObjectBase);
/**
* @param captionParamsId int The Caption Params used to create this Caption Asset (insertOnly).
* @param language string The language of the caption asset content.
* @param languageCode string The language of the caption asset content (readOnly).
* @param isDefault int Is default caption asset of the entry.
* @param label string Friendly label.
* @param format string The caption format (insertOnly).
* @param status int The status of the asset (readOnly).
* @param parentId string The parent id of the asset (insertOnly).
* @param accuracy int The Accuracy of the caption content.
*/
function KalturaCaptionAsset(){
KalturaCaptionAsset.super_.call(this);
this.captionParamsId = null;
this.language = null;
this.languageCode = null;
this.isDefault = null;
this.label = null;
this.format = null;
this.status = null;
this.parentId = null;
this.accuracy = null;
}
module.exports.KalturaCaptionAsset = KalturaCaptionAsset;
util.inherits(KalturaCaptionAsset, KalturaAsset);
/**
* @param asset KalturaCaptionAsset The Caption Asset object.
* @param entry KalturaBaseEntry The entry object.
* @param startTime int .
* @param endTime int .
* @param content string .
*/
function KalturaCaptionAssetItem(){
KalturaCaptionAssetItem.super_.call(this);
this.asset = null;
this.entry = null;
this.startTime = null;
this.endTime = null;
this.content = null;
}
module.exports.KalturaCaptionAssetItem = KalturaCaptionAssetItem;
util.inherits(KalturaCaptionAssetItem, kaltura.KalturaObjectBase);
/**
* @param language string The language of the caption content (insertOnly).
* @param isDefault int Is default caption asset of the entry.
* @param label string Friendly label.
* @param format string The caption format (insertOnly).
* @param sourceParamsId int Id of the caption params or the flavor params to be used as source for the caption creation.
*/
function KalturaCaptionParams(){
KalturaCaptionParams.super_.call(this);
this.language = null;
this.isDefault = null;
this.label = null;
this.format = null;
this.sourceParamsId = null;
}
module.exports.KalturaCaptionParams = KalturaCaptionParams;
util.inherits(KalturaCaptionParams, KalturaAssetParams);
/**
* @param id int The id of the Category (readOnly).
* @param parentId int .
* @param depth int (readOnly).
* @param partnerId int (readOnly).
* @param name string The name of the Category.
* The following characters are not allowed: '<', '>', ','.
* @param fullName string The full name of the Category (readOnly).
* @param fullIds string The full ids of the Category (readOnly).
* @param entriesCount int Number of entries in this Category (including child categories) (readOnly).
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param updatedAt int Update date as Unix timestamp (In seconds) (readOnly).
* @param description string Category description.
* @param tags string Category tags.
* @param appearInList int If category will be returned for list action.
* @param privacy int defines the privacy of the entries that assigned to this category.
* @param inheritanceType int If Category members are inherited from parent category or set manualy.
* @param userJoinPolicy int Who can ask to join this category (readOnly).
* @param defaultPermissionLevel int Default permissionLevel for new users.
* @param owner string Category Owner (User id).
* @param directEntriesCount int Number of entries that belong to this category directly (readOnly).
* @param referenceId string Category external id, controlled and managed by the partner.
* @param contributionPolicy int who can assign entries to this category.
* @param membersCount int Number of active members for this category (readOnly).
* @param pendingMembersCount int Number of pending members for this category (readOnly).
* @param privacyContext string Set privacy context for search entries that assiged to private and public categories. the entries will be private if the search context is set with those categories.
* @param privacyContexts string comma separated parents that defines a privacyContext for search (readOnly).
* @param status int Status (readOnly).
* @param inheritedParentId int The category id that this category inherit its members and members permission (for contribution and join) (readOnly).
* @param partnerSortValue int Can be used to store various partner related data as a numeric value.
* @param partnerData string Can be used to store various partner related data as a string.
* @param defaultOrderBy string Enable client side applications to define how to sort the category child categories.
* @param directSubCategoriesCount int Number of direct children categories (readOnly).
* @param moderation int Moderation to add entries to this category by users that are not of permission level Manager or Moderator.
* @param pendingEntriesCount int Nunber of pending moderation entries (readOnly).
* @param isAggregationCategory int Flag indicating that the category is an aggregation category.
* @param aggregationCategories string List of aggregation channels the category belongs to.
*/
function KalturaCategory(){
KalturaCategory.super_.call(this);
this.id = null;
this.parentId = null;
this.depth = null;
this.partnerId = null;
this.name = null;
this.fullName = null;
this.fullIds = null;
this.entriesCount = null;
this.createdAt = null;
this.updatedAt = null;
this.description = null;
this.tags = null;
this.appearInList = null;
this.privacy = null;
this.inheritanceType = null;
this.userJoinPolicy = null;
this.defaultPermissionLevel = null;
this.owner = null;
this.directEntriesCount = null;
this.referenceId = null;
this.contributionPolicy = null;
this.membersCount = null;
this.pendingMembersCount = null;
this.privacyContext = null;
this.privacyContexts = null;
this.status = null;
this.inheritedParentId = null;
this.partnerSortValue = null;
this.partnerData = null;
this.defaultOrderBy = null;
this.directSubCategoriesCount = null;
this.moderation = null;
this.pendingEntriesCount = null;
this.isAggregationCategory = null;
this.aggregationCategories = null;
}
module.exports.KalturaCategory = KalturaCategory;
util.inherits(KalturaCategory, kaltura.KalturaObjectBase);
/**
* @param categoryId int .
* @param entryId string entry id.
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param categoryFullIds string The full ids of the Category (readOnly).
* @param status int CategroyEntry status (readOnly).
*/
function KalturaCategoryEntry(){
KalturaCategoryEntry.super_.call(this);
this.categoryId = null;
this.entryId = null;
this.createdAt = null;
this.categoryFullIds = null;
this.status = null;
}
module.exports.KalturaCategoryEntry = KalturaCategoryEntry;
util.inherits(KalturaCategoryEntry, kaltura.KalturaObjectBase);
/**
* @param categoryId int (insertOnly).
* @param userId string User id (insertOnly).
* @param partnerId int Partner id (readOnly).
* @param permissionLevel int Permission level.
* @param status int Status (readOnly).
* @param createdAt int CategoryUser creation date as Unix timestamp (In seconds) (readOnly).
* @param updatedAt int CategoryUser update date as Unix timestamp (In seconds) (readOnly).
* @param updateMethod int Update method can be either manual or automatic to distinguish between manual operations (for example in KMC) on automatic - using bulk upload.
* @param categoryFullIds string The full ids of the Category (readOnly).
* @param permissionNames string Set of category-related permissions for the current category user.
*/
function KalturaCategoryUser(){
KalturaCategoryUser.super_.call(this);
this.categoryId = null;
this.userId = null;
this.partnerId = null;
this.permissionLevel = null;
this.status = null;
this.createdAt = null;
this.updatedAt = null;
this.updateMethod = null;
this.categoryFullIds = null;
this.permissionNames = null;
}
module.exports.KalturaCategoryUser = KalturaCategoryUser;
util.inherits(KalturaCategoryUser, kaltura.KalturaObjectBase);
/**
* @param clientTag string .
* @param apiVersion string .
*/
function KalturaClientConfiguration(){
KalturaClientConfiguration.super_.call(this);
this.clientTag = null;
this.apiVersion = null;
}
module.exports.KalturaClientConfiguration = KalturaClientConfiguration;
util.inherits(KalturaClientConfiguration, kaltura.KalturaObjectBase);
/**
* @param url string The URL where the notification should be sent to.
* @param data string The serialized notification data to send.
*/
function KalturaClientNotification(){
KalturaClientNotification.super_.call(this);
this.url = null;
this.data = null;
}
module.exports.KalturaClientNotification = KalturaClientNotification;
util.inherits(KalturaClientNotification, kaltura.KalturaObjectBase);
/**
*/
function KalturaContext(){
KalturaContext.super_.call(this);
}
module.exports.KalturaContext = KalturaContext;
util.inherits(KalturaContext, kaltura.KalturaObjectBase);
/**
* @param messages array Array of messages as received from the rules that invalidated.
* @param actions array Array of actions as received from the rules that invalidated.
*/
function KalturaContextDataResult(){
KalturaContextDataResult.super_.call(this);
this.messages = null;
this.actions = null;
}
module.exports.KalturaContextDataResult = KalturaContextDataResult;
util.inherits(KalturaContextDataResult, kaltura.KalturaObjectBase);
/**
* @param id int The id of the Category (readOnly).
* @param createdAt int Creation date as Unix timestamp (In seconds) (readOnly).
* @param createdBy string Creator name.
* @param updatedAt int Update date as Unix timestamp (In seconds) (readOnly).
* @param updatedBy string Updater name.
* @param createdById int Creator id.
* @param schedulerId int The id of the scheduler that the command refers to.
* @param workerId int The id of the scheduler worker that the command refers to.
* @param workerConfiguredId int The id of the scheduler worker as configured in the ini file.
* @param workerName int The name of the scheduler worker that the command refers to.
* @param batchIndex int The index of the batch process that the command refers to.
* @param type int The command type - stop / start / config.
* @param targetType int The command target type - data center / scheduler / job / job type.
* @param status int The command status.
* @param cause string The reason for the command.
* @param description string Command description.
* @param