Class: Kaltura::KalturaGroupService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_group_client_plugin.rb

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaGroupService

Returns a new instance of KalturaGroupService.



207
208
209
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 207

def initialize(client)
	super(client)
end

Instance Method Details

#add(group) ⇒ KalturaGroup

Adds a new group (user of type group).

Returns:



213
214
215
216
217
218
219
220
221
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 213

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

#clone(original_group_id, new_group_id, new_group_name = KalturaNotImplemented) ⇒ KalturaGroup

clone the group (groupId), and set group id with the neeGroupName.

Returns:



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 225

def clone(original_group_id, new_group_id, new_group_name=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'originalGroupId', original_group_id)
	client.add_param(kparams, 'newGroupId', new_group_id)
	client.add_param(kparams, 'newGroupName', new_group_name)
	client.queue_service_action_call('group_group', 'clone', 'KalturaGroup', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(group_id) ⇒ KalturaGroup

Delete group by ID

Returns:



239
240
241
242
243
244
245
246
247
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 239

def delete(group_id)
	kparams = {}
	client.add_param(kparams, 'groupId', group_id)
	client.queue_service_action_call('group_group', 'delete', 'KalturaGroup', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(group_id) ⇒ KalturaGroup

Retrieves a group object for a specified group ID.

Returns:



251
252
253
254
255
256
257
258
259
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 251

def get(group_id)
	kparams = {}
	client.add_param(kparams, 'groupId', group_id)
	client.queue_service_action_call('group_group', 'get', 'KalturaGroup', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

Lists group objects that are associated with an account. Blocked users are listed unless you use a filter to exclude them. Deleted users are not listed unless you use a filter to include them.

Returns:



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 265

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

#update(group_id, group) ⇒ KalturaGroup

Update group by ID

Returns:



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/kaltura_plugins/kaltura_group_client_plugin.rb', line 278

def update(group_id, group)
	kparams = {}
	client.add_param(kparams, 'groupId', group_id)
	client.add_param(kparams, 'group', group)
	client.queue_service_action_call('group_group', 'update', 'KalturaGroup', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end