com.kaltura.client.Client Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation

KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php

There is a newer version: 19.3.0

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client;

import com.kaltura.client.utils.request.ConnectionConfiguration;
import com.kaltura.client.types.BaseResponseProfile;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

@SuppressWarnings("serial")
public class Client extends ClientBase {
	
	public Client(ConnectionConfiguration config) {
		super(config);
		
		this.setClientTag("java:19-06-24");
		this.setApiVersion("15.1.0");
		this.clientConfiguration.put("format", 1); // JSON
	}
	
	/**
	 * @param clientTag 
	 */
	public void setClientTag(String clientTag){
		this.clientConfiguration.put("clientTag", clientTag);
	}
	
	/**
	 * @return String
	 */
	public String getClientTag(){
		if(this.clientConfiguration.containsKey("clientTag")){
			return(String) this.clientConfiguration.get("clientTag");
		}
		
		return null;
	}
	
	/**
	 * @param apiVersion 
	 */
	public void setApiVersion(String apiVersion){
		this.clientConfiguration.put("apiVersion", apiVersion);
	}
	
	/**
	 * @return String
	 */
	public String getApiVersion(){
		if(this.clientConfiguration.containsKey("apiVersion")){
			return(String) this.clientConfiguration.get("apiVersion");
		}
		
		return null;
	}
	
	/**
	 * @param partnerId Impersonated partner id
	 */
	public void setPartnerId(Integer partnerId){
		this.requestConfiguration.put("partnerId", partnerId);
	}
	
	/**
	 * Impersonated partner id
	 * 
	 * @return Integer
	 */
	public Integer getPartnerId(){
		if(this.requestConfiguration.containsKey("partnerId")){
			return(Integer) this.requestConfiguration.get("partnerId");
		}
		
		return 0;
	}
	
	/**
	 * @param ks Kaltura API session
	 */
	public void setKs(String ks){
		this.requestConfiguration.put("ks", ks);
	}
	
	/**
	 * Kaltura API session
	 * 
	 * @return String
	 */
	public String getKs(){
		if(this.requestConfiguration.containsKey("ks")){
			return(String) this.requestConfiguration.get("ks");
		}
		
		return null;
	}
	
	/**
	 * @param sessionId Kaltura API session
	 */
	public void setSessionId(String sessionId){
		this.requestConfiguration.put("ks", sessionId);
	}
	
	/**
	 * Kaltura API session
	 * 
	 * @return String
	 */
	public String getSessionId(){
		if(this.requestConfiguration.containsKey("ks")){
			return(String) this.requestConfiguration.get("ks");
		}
		
		return null;
	}
	
	/**
	 * @param responseProfile Response profile - this attribute will be automatically unset after every API call.
	 */
	public void setResponseProfile(BaseResponseProfile responseProfile){
		this.requestConfiguration.put("responseProfile", responseProfile);
	}
	
	/**
	 * Response profile - this attribute will be automatically unset after every API call.
	 * 
	 * @return BaseResponseProfile
	 */
	public BaseResponseProfile getResponseProfile(){
		if(this.requestConfiguration.containsKey("responseProfile")){
			return(BaseResponseProfile) this.requestConfiguration.get("responseProfile");
		}
		
		return null;
	}
	
}