Class: Kaltura::KalturaPermissionService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Permission service lets you create and manage user permissions

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaPermissionService 



3591
3592
3593
 
# File 'lib/kaltura_client.rb', line 3591

def initialize(client)
  super(client)
end

Instance Method Details

#add(permission) ⇒ KalturaPermission

Adds a new permission object to the account.



3597
3598
3599
3600
3601
3602
3603
3604
3605
 
# File 'lib/kaltura_client.rb', line 3597

def add(permission)
  kparams = {}
  client.add_param(kparams, 'permission', permission)
  client.queue_service_action_call('permission', 'add', 'KalturaPermission', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(permission_name) ⇒ KalturaPermission

Deletes an existing permission object.



3609
3610
3611
3612
3613
3614
3615
3616
3617
 
# File 'lib/kaltura_client.rb', line 3609

def delete(permission_name)
  kparams = {}
  client.add_param(kparams, 'permissionName', permission_name)
  client.queue_service_action_call('permission', 'delete', 'KalturaPermission', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(permission_name) ⇒ KalturaPermission

Retrieves a permission object using its ID.



3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'lib/kaltura_client.rb', line 3621

def get(permission_name)
  kparams = {}
  client.add_param(kparams, 'permissionName', permission_name)
  client.queue_service_action_call('permission', 'get', 'KalturaPermission', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_current_permissions ⇒ string

Retrieves a list of permissions that apply to the current KS.



3633
3634
3635
3636
3637
3638
3639
3640
 
# File 'lib/kaltura_client.rb', line 3633

def get_current_permissions()
  kparams = {}
  client.queue_service_action_call('permission', 'getCurrentPermissions', 'string', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

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

Lists permission objects that are associated with an account. Blocked permissions are listed unless you use a filter to exclude them. Blocked permissions are listed unless you use a filter to exclude them.



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
 
# File 'lib/kaltura_client.rb', line 3646

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('permission', 'list', 'KalturaPermissionListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(permission_name, permission) ⇒ KalturaPermission

Updates an existing permission object.



3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
 
# File 'lib/kaltura_client.rb', line 3659

def update(permission_name, permission)
  kparams = {}
  client.add_param(kparams, 'permissionName', permission_name)
  client.add_param(kparams, 'permission', permission)
  client.queue_service_action_call('permission', 'update', 'KalturaPermission', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end