Class: Kaltura::KalturaPartnerService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

partner service allows you to change/manage your partner personal details and settings as well

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaPartnerService

Returns a new instance of KalturaPartnerService.



12049
12050
12051
 
# File 'lib/kaltura_client.rb', line 12049

def initialize(client)
	super(client)
end

Instance Method Details

#count(filter = KalturaNotImplemented) ⇒ Object

Count partner’s existing sub-publishers (count includes the partner itself).



12189
12190
12191
12192
12193
12194
12195
12196
12197
 
# File 'lib/kaltura_client.rb', line 12189

def count(filter=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.queue_service_action_call('partner', 'count', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(id = KalturaNotImplemented) ⇒ Object

Retrieve partner object by Id



12083
12084
12085
12086
12087
12088
12089
12090
12091
 
# File 'lib/kaltura_client.rb', line 12083

def get(id=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('partner', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_info ⇒ Object

Retrieve all info attributed to the partner This action expects no parameters. It returns information for the current KS partnerId.



12110
12111
12112
12113
12114
12115
12116
12117
 
# File 'lib/kaltura_client.rb', line 12110

def get_info()
	kparams = {}
	client.queue_service_action_call('partner', 'getInfo', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_secrets(partner_id, admin_email, cms_password) ⇒ Object

Retrieve partner secret and admin secret



12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
 
# File 'lib/kaltura_client.rb', line 12095

def get_secrets(partner_id, admin_email, cms_password)
	kparams = {}
	client.add_param(kparams, 'partnerId', partner_id);
	client.add_param(kparams, 'adminEmail', admin_email);
	client.add_param(kparams, 'cmsPassword', cms_password);
	client.queue_service_action_call('partner', 'getSecrets', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_statistics ⇒ Object

Get usage statistics for a partner Calculation is done according to partner’s package



12139
12140
12141
12142
12143
12144
12145
12146
 
# File 'lib/kaltura_client.rb', line 12139

def get_statistics()
	kparams = {}
	client.queue_service_action_call('partner', 'getStatistics', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get_usage(year = '', month = 1, resolution = KalturaNotImplemented) ⇒ Object

Get usage statistics for a partner Calculation is done according to partner’s package Additional data returned is a graph points of streaming usage in a timeframe The resolution can be “days” or “months”



12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
 
# File 'lib/kaltura_client.rb', line 12124

def get_usage(year='', month=1, resolution=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'year', year);
	client.add_param(kparams, 'month', month);
	client.add_param(kparams, 'resolution', resolution);
	client.queue_service_action_call('partner', 'getUsage', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

List partners by filter with paging support Current implementation will only list the sub partners of the partner initiating the api call (using the current KS). This action is only partially implemented to support listing sub partners of a VAR partner.



12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
 
# File 'lib/kaltura_client.rb', line 12165

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('partner', 'list', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list_feature_status ⇒ Object

List partner’s current processes’ statuses



12178
12179
12180
12181
12182
12183
12184
12185
 
# File 'lib/kaltura_client.rb', line 12178

def list_feature_status()
	kparams = {}
	client.queue_service_action_call('partner', 'listFeatureStatus', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list_partners_for_user(partner_filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

Retrieve a list of partner objects which the current user is allowed to access.



12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
 
# File 'lib/kaltura_client.rb', line 12150

def list_partners_for_user(partner_filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'partnerFilter', partner_filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('partner', 'listPartnersForUser', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#register(partner, cms_password = '', template_partner_id = KalturaNotImplemented, silent = false) ⇒ Object

Create a new Partner object



12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
 
# File 'lib/kaltura_client.rb', line 12055

def register(partner, cms_password='', template_partner_id=KalturaNotImplemented, silent=false)
	kparams = {}
	client.add_param(kparams, 'partner', partner);
	client.add_param(kparams, 'cmsPassword', cms_password);
	client.add_param(kparams, 'templatePartnerId', template_partner_id);
	client.add_param(kparams, 'silent', silent);
	client.queue_service_action_call('partner', 'register', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update(partner, allow_empty = false) ⇒ Object

Update details and settings of an existing partner



12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
 
# File 'lib/kaltura_client.rb', line 12070

def update(partner, allow_empty=false)
	kparams = {}
	client.add_param(kparams, 'partner', partner);
	client.add_param(kparams, 'allowEmpty', allow_empty);
	client.queue_service_action_call('partner', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end