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.



3258
3259
3260
 
# File 'lib/kaltura_client.rb', line 3258

def initialize(client)
  super(client)
end

Instance Method Details

#count(filter = KalturaNotImplemented) ⇒ Object

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



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

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) ⇒ Object

Retrieve partner object by Id



3292
3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/kaltura_client.rb', line 3292

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 ⇒ Object

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



3319
3320
3321
3322
3323
3324
3325
3326
 
# File 'lib/kaltura_client.rb', line 3319

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_secrets(partner_id, admin_email, cms_password) ⇒ Object

Retrieve partner secret and admin secret



3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/kaltura_client.rb', line 3304

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', 'KalturaPartner', 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



3348
3349
3350
3351
3352
3353
3354
3355
 
# File 'lib/kaltura_client.rb', line 3348

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) ⇒ 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”



3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
 
# File 'lib/kaltura_client.rb', line 3333

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) ⇒ 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.



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

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 ⇒ Object

List partner’s current processes’ statuses



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

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) ⇒ Object

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



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

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) ⇒ Object

Create a new Partner object



3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/kaltura_client.rb', line 3264

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) ⇒ Object

Update details and settings of an existing partner



3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
 
# File 'lib/kaltura_client.rb', line 3279

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