IGroup¶

interface OCP\IGroup¶

Interface IGroup

Implemented by:	`OC\Group\Group`
Source:	lib/public/IGroup.php#36

Methods¶

public OCP\IGroup::getGID()¶

public OCP\IGroup::getDisplayName()¶

Returns the group display name

public OCP\IGroup::setDisplayName($displayName)¶

Set the group display name

public OCP\IGroup::getUsers()¶

get all users in the group

public OCP\IGroup::inGroup($user)¶

check if a user is in the group

public OCP\IGroup::addUser($user)¶

add a user to the group

public OCP\IGroup::removeUser($user)¶

remove a user from the group

public OCP\IGroup::searchUsers($search, $limit=null, $offset=null)¶

search for users in the group by userid

Source:	lib/public/IGroup.php#102
Parameters:	$search (string) $limit (int) $offset (int)
Returns:	`\OCP\IUser[]`
Since:	8.0.0

public OCP\IGroup::count($search="")¶

returns the number of users matching the search string

public OCP\IGroup::countDisabled()¶

returns the number of disabled users

public OCP\IGroup::searchDisplayName($search, $limit=null, $offset=null)¶

search for users in the group by displayname

Source:	lib/public/IGroup.php#130
Parameters:	$search (string) $limit (int) $offset (int)
Returns:	`\OCP\IUser[]`
Since:	8.0.0

public OCP\IGroup::getBackendNames()¶

Get the names of the backends the group is connected to

public OCP\IGroup::delete()¶

delete the group

public OCP\IGroup::canRemoveUser()¶

public OCP\IGroup::canAddUser()¶

public OCP\IGroup::hideFromCollaboration()¶