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.



3433
3434
3435
 
# File 'lib/kaltura_client.rb', line 3433

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) 


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

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:



3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/kaltura_client.rb', line 3451

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:



3464
3465
3466
3467
3468
3469
3470
3471
 
# File 'lib/kaltura_client.rb', line 3464

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:



3475
3476
3477
3478
3479
3480
3481
3482
3483
 
# File 'lib/kaltura_client.rb', line 3475

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:



3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
 
# File 'lib/kaltura_client.rb', line 3487

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:



3503
3504
3505
3506
3507
3508
3509
3510
 
# File 'lib/kaltura_client.rb', line 3503

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:



3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
 
# File 'lib/kaltura_client.rb', line 3517

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:



3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
 
# File 'lib/kaltura_client.rb', line 3533

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:



3546
3547
3548
3549
3550
3551
3552
3553
 
# File 'lib/kaltura_client.rb', line 3546

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:



3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'lib/kaltura_client.rb', line 3557

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:



3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
 
# File 'lib/kaltura_client.rb', line 3570

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:



3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
 
# File 'lib/kaltura_client.rb', line 3585

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