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.



14121
14122
14123
 
# File 'lib/kaltura_client.rb', line 14121

def initialize(client)
	super(client)
end

Instance Method Details

#count(filter = KalturaNotImplemented) ⇒ Object

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



14261
14262
14263
14264
14265
14266
14267
14268
14269
 
# File 'lib/kaltura_client.rb', line 14261

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



14155
14156
14157
14158
14159
14160
14161
14162
14163
 
# File 'lib/kaltura_client.rb', line 14155

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.



14182
14183
14184
14185
14186
14187
14188
14189
 
# File 'lib/kaltura_client.rb', line 14182

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



14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
 
# File 'lib/kaltura_client.rb', line 14167

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



14211
14212
14213
14214
14215
14216
14217
14218
 
# File 'lib/kaltura_client.rb', line 14211

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”



14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
 
# File 'lib/kaltura_client.rb', line 14196

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.



14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
 
# File 'lib/kaltura_client.rb', line 14237

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



14250
14251
14252
14253
14254
14255
14256
14257
 
# File 'lib/kaltura_client.rb', line 14250

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.



14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
 
# File 'lib/kaltura_client.rb', line 14222

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



14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
 
# File 'lib/kaltura_client.rb', line 14127

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



14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
 
# File 'lib/kaltura_client.rb', line 14142

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