Class: Kaltura::KalturaCategoryUserService

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

Overview

Add & Manage CategoryUser - membership of a user in a category

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaCategoryUserService

Returns a new instance of KalturaCategoryUserService.



967
968
969
 
# File 'lib/kaltura_client.rb', line 967

def initialize(client)
  super(client)
end

Instance Method Details

#activate(category_id, user_id) ⇒ Object

activate CategoryUser



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/kaltura_client.rb', line 1026

def activate(category_id, user_id)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'userId', user_id)
  client.queue_service_action_call('categoryuser', 'activate', 'KalturaCategoryUser', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#add(category_user) ⇒ Object

Add new CategoryUser



973
974
975
976
977
978
979
980
981
 
# File 'lib/kaltura_client.rb', line 973

def add(category_user)
  kparams = {}
  client.add_param(kparams, 'categoryUser', category_user)
  client.queue_service_action_call('categoryuser', 'add', 'KalturaCategoryUser', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented, bulk_upload_category_user_data = KalturaNotImplemented) ⇒ Object 



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/kaltura_client.rb', line 1089

def add_from_bulk_upload(file_data, bulk_upload_data=KalturaNotImplemented, bulk_upload_category_user_data=KalturaNotImplemented)
  kparams = {}
  kfiles = {}
  client.add_param(kfiles, 'fileData', file_data)
  client.add_param(kparams, 'bulkUploadData', bulk_upload_data)
  client.add_param(kparams, 'bulkUploadCategoryUserData', bulk_upload_category_user_data)
  client.queue_service_action_call('categoryuser', 'addFromBulkUpload', 'KalturaBulkUpload', kparams, kfiles)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#copy_from_category(category_id) ⇒ Object

Copy all memeber from parent category



1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/kaltura_client.rb', line 1065

def copy_from_category(category_id)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.queue_service_action_call('categoryuser', 'copyFromCategory', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#deactivate(category_id, user_id) ⇒ Object

reject CategoryUser



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/kaltura_client.rb', line 1039

def deactivate(category_id, user_id)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'userId', user_id)
  client.queue_service_action_call('categoryuser', 'deactivate', 'KalturaCategoryUser', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(category_id, user_id) ⇒ Object

Delete a CategoryUser



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/kaltura_client.rb', line 1013

def delete(category_id, user_id)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'userId', user_id)
  client.queue_service_action_call('categoryuser', 'delete', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(category_id, user_id) ⇒ Object

Get CategoryUser by id



985
986
987
988
989
990
991
992
993
994
 
# File 'lib/kaltura_client.rb', line 985

def get(category_id, user_id)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'userId', user_id)
  client.queue_service_action_call('categoryuser', 'get', 'KalturaCategoryUser', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#index(user_id, category_id, should_update = true) ⇒ Object

Index CategoryUser by userid and category id



1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/kaltura_client.rb', line 1077

def index(user_id, category_id, should_update=true)
  kparams = {}
  client.add_param(kparams, 'userId', user_id)
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'shouldUpdate', should_update)
  client.queue_service_action_call('categoryuser', 'index', 'int', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

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

List all categories



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/kaltura_client.rb', line 1052

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

#update(category_id, user_id, category_user, override = false) ⇒ Object

Update CategoryUser by id



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/kaltura_client.rb', line 998

def update(category_id, user_id, category_user, override=false)
  kparams = {}
  client.add_param(kparams, 'categoryId', category_id)
  client.add_param(kparams, 'userId', user_id)
  client.add_param(kparams, 'categoryUser', category_user)
  client.add_param(kparams, 'override', override)
  client.queue_service_action_call('categoryuser', 'update', 'KalturaCategoryUser', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end