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.



3355
3356
3357
 
# File 'lib/kaltura_client.rb', line 3355

def initialize(client)
	super(client)
end

Instance Method Details

#count(filter = KalturaNotImplemented) ⇒ int

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

Returns:

  • (int) 


3361
3362
3363
3364
3365
3366
3367
3368
3369
 
# File 'lib/kaltura_client.rb', line 3361

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

#get(id = KalturaNotImplemented) ⇒ KalturaPartner

Retrieve partner object by Id

Returns:



3373
3374
3375
3376
3377
3378
3379
3380
3381
 
# File 'lib/kaltura_client.rb', line 3373

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

#get_info ⇒ KalturaPartner

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

Returns:



3386
3387
3388
3389
3390
3391
3392
3393
 
# File 'lib/kaltura_client.rb', line 3386

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

#get_public_info(id = KalturaNotImplemented) ⇒ KalturaPartnerPublicInfo

Returns partner public info by Id

Returns:



3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'lib/kaltura_client.rb', line 3397

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

#get_secrets(partner_id, admin_email, cms_password, otp = KalturaNotImplemented) ⇒ KalturaPartner

Retrieve partner secret and admin secret

Returns:



3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/kaltura_client.rb', line 3409

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

#get_statistics ⇒ KalturaPartnerStatistics

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

Returns:



3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/kaltura_client.rb', line 3425

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

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

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 time frame The resolution can be “days” or “months”

Returns:



3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
 
# File 'lib/kaltura_client.rb', line 3439

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', 'KalturaPartnerUsage', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

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.

Returns:



3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
 
# File 'lib/kaltura_client.rb', line 3455

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', 'KalturaPartnerListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list_feature_status ⇒ KalturaFeatureStatusListResponse

List partner’s current processes’ statuses

Returns:



3468
3469
3470
3471
3472
3473
3474
3475
 
# File 'lib/kaltura_client.rb', line 3468

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

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

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

Returns:



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
 
# File 'lib/kaltura_client.rb', line 3479

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', 'KalturaPartnerListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

Create a new Partner object

Returns:



3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
 
# File 'lib/kaltura_client.rb', line 3492

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', 'KalturaPartner', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(partner, allow_empty = false) ⇒ KalturaPartner

Update details and settings of an existing partner

Returns:



3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
 
# File 'lib/kaltura_client.rb', line 3507

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', 'KalturaPartner', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end