class Kaltura::KalturaPartnerService
partner service allows you to change/manage your partner personal details and settings as well
Public Class Methods
# File lib/kaltura_client.rb, line 3433 def initialize(client) super(client) end
Public Instance Methods
Count partner's existing sub-publishers (count includes the partner itself). @return [int]
# 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
Retrieve partner object by Id @return [KalturaPartner]
# 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
Retrieve all info attributed to the partner
This action expects no parameters. It returns information for the current KS partnerId.
@return [KalturaPartner]
# 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
Returns partner public info by Id @return [KalturaPartnerPublicInfo]
# 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
Retrieve partner secret and admin secret @return [KalturaPartner]
# 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 usage statistics for a partner
Calculation is done according to partner's package
@return [KalturaPartnerStatistics]
# 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 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"
@return [KalturaPartnerUsage]
# 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 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.
@return [KalturaPartnerListResponse]
# 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 partner's current processes' statuses @return [KalturaFeatureStatusListResponse]
# 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
Retrieve a list of partner objects which the current user is allowed to access. @return [KalturaPartnerListResponse]
# 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
Create a new Partner object @return [KalturaPartner]
# 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
Create a new Partner object @return [bool]
# File lib/kaltura_client.rb, line 3585 def registration_validation(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', 'registrationValidation', 'bool', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Update details and settings of an existing partner @return [KalturaPartner]
# File lib/kaltura_client.rb, line 3600 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