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

Returns a new instance of KalturaPermissionService.



3656
3657
3658
 
# File 'lib/kaltura_client.rb', line 3656

def initialize(client)
  super(client)
end

Instance Method Details

#add(permission) ⇒ KalturaPermission

Adds a new permission object to the account.

Returns:



3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/kaltura_client.rb', line 3662

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.

Returns:



3674
3675
3676
3677
3678
3679
3680
3681
3682
 
# File 'lib/kaltura_client.rb', line 3674

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.

Returns:



3686
3687
3688
3689
3690
3691
3692
3693
3694
 
# File 'lib/kaltura_client.rb', line 3686

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.

Returns:

  • (string) 


3698
3699
3700
3701
3702
3703
3704
3705
 
# File 'lib/kaltura_client.rb', line 3698

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.

Returns:



3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
 
# File 'lib/kaltura_client.rb', line 3711

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.

Returns:



3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
 
# File 'lib/kaltura_client.rb', line 3724

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