Class: Kaltura::KalturaCategoryUserService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaCategoryUserService
- Defined in:
- lib/kaltura_client.rb
Overview
Add & Manage CategoryUser - membership of a user in a category
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#activate(category_id, user_id) ⇒ KalturaCategoryUser
activate CategoryUser.
-
#add(category_user) ⇒ KalturaCategoryUser
Add new CategoryUser.
- #add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented, bulk_upload_category_user_data = KalturaNotImplemented) ⇒ KalturaBulkUpload
-
#copy_from_category(category_id) ⇒ Object
Copy all member from parent category.
-
#deactivate(category_id, user_id) ⇒ KalturaCategoryUser
reject CategoryUser.
-
#delete(category_id, user_id) ⇒ Object
Delete a CategoryUser.
-
#get(category_id, user_id) ⇒ KalturaCategoryUser
Get CategoryUser by id.
-
#index(user_id, category_id, should_update = true) ⇒ int
Index CategoryUser by userid and category id.
-
#initialize(client) ⇒ KalturaCategoryUserService
constructor
A new instance of KalturaCategoryUserService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaCategoryUserListResponse
List all categories.
-
#update(category_id, user_id, category_user, override = false) ⇒ KalturaCategoryUser
Update CategoryUser by id.
Constructor Details
#initialize(client) ⇒ KalturaCategoryUserService
Returns a new instance of KalturaCategoryUserService.
1011 1012 1013 |
# File 'lib/kaltura_client.rb', line 1011 def initialize(client) super(client) end |
Instance Method Details
#activate(category_id, user_id) ⇒ KalturaCategoryUser
activate CategoryUser
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
# File 'lib/kaltura_client.rb', line 1017 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) ⇒ KalturaCategoryUser
Add new CategoryUser
1030 1031 1032 1033 1034 1035 1036 1037 1038 |
# File 'lib/kaltura_client.rb', line 1030 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) ⇒ KalturaBulkUpload
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 |
# File 'lib/kaltura_client.rb', line 1041 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 member from parent category
1056 1057 1058 1059 1060 1061 1062 1063 1064 |
# File 'lib/kaltura_client.rb', line 1056 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) ⇒ KalturaCategoryUser
reject CategoryUser
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 |
# File 'lib/kaltura_client.rb', line 1068 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
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 |
# File 'lib/kaltura_client.rb', line 1081 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) ⇒ KalturaCategoryUser
Get CategoryUser by id
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'lib/kaltura_client.rb', line 1094 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) ⇒ int
Index CategoryUser by userid and category id
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 |
# File 'lib/kaltura_client.rb', line 1107 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) ⇒ KalturaCategoryUserListResponse
List all categories
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 |
# File 'lib/kaltura_client.rb', line 1121 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) ⇒ KalturaCategoryUser
Update CategoryUser by id
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 |
# File 'lib/kaltura_client.rb', line 1134 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 |