Class: Kaltura::KalturaGroupUserService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• Kaltura::KalturaGroupUserService

Defined in:

lib/kaltura_client.rb

Overview

Add & Manage GroupUser

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary

• #add(group_user) ⇒ KalturaGroupUser

  Add new GroupUser.

• #delete(user_id, group_id) ⇒ Object

  delete by userId and groupId.

• #initialize(client) ⇒ KalturaGroupUserService constructor

  A new instance of KalturaGroupUserService.

• #list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaGroupUserListResponse

  List all GroupUsers.

• #sync(user_id, group_ids = KalturaNotImplemented, remove_from_existing_groups = true, create_new_groups = true) ⇒ KalturaBulkUpload

  sync by userId and groupIds.

• #update(group_user_id, group_user) ⇒ KalturaGroupUser

  update GroupUser.

Constructor Details

#initialize(client) ⇒ KalturaGroupUserService

Returns a new instance of KalturaGroupUserService.

# File 'lib/kaltura_client.rb', line 2114

def initialize(client)
	super(client)
end

Instance Method Details

#add(group_user) ⇒ KalturaGroupUser

Add new GroupUser

Returns:

• (KalturaGroupUser)

# File 'lib/kaltura_client.rb', line 2120

def add(group_user)
	kparams = {}
	client.add_param(kparams, 'groupUser', group_user)
	client.queue_service_action_call('groupuser', 'add', 'KalturaGroupUser', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(user_id, group_id) ⇒ Object

delete by userId and groupId

Returns:

# File 'lib/kaltura_client.rb', line 2132

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

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

List all GroupUsers

Returns:

• (KalturaGroupUserListResponse)

# File 'lib/kaltura_client.rb', line 2145

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

#sync(user_id, group_ids = KalturaNotImplemented, remove_from_existing_groups = true, create_new_groups = true) ⇒ KalturaBulkUpload

sync by userId and groupIds

Returns:

• (KalturaBulkUpload)

# File 'lib/kaltura_client.rb', line 2158

def sync(user_id, group_ids=KalturaNotImplemented, remove_from_existing_groups=true, create_new_groups=true)
	kparams = {}
	client.add_param(kparams, 'userId', user_id)
	client.add_param(kparams, 'groupIds', group_ids)
	client.add_param(kparams, 'removeFromExistingGroups', remove_from_existing_groups)
	client.add_param(kparams, 'createNewGroups', create_new_groups)
	client.queue_service_action_call('groupuser', 'sync', 'KalturaBulkUpload', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(group_user_id, group_user) ⇒ KalturaGroupUser

update GroupUser

Returns:

• (KalturaGroupUser)

# File 'lib/kaltura_client.rb', line 2173

def update(group_user_id, group_user)
	kparams = {}
	client.add_param(kparams, 'groupUserId', group_user_id)
	client.add_param(kparams, 'groupUser', group_user)
	client.queue_service_action_call('groupuser', 'update', 'KalturaGroupUser', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end