IGroup

interface OCP\IGroup
Interface IGroup
Implemented by:OC\Group\Group
Source:lib/public/IGroup.php#35

Methods

public OCP\IGroup::getGID()
Source:lib/public/IGroup.php#40
Returns:string
Since:8.0.0
public OCP\IGroup::getDisplayName()
Returns the group display name
Source:lib/public/IGroup.php#48
Returns:string
Since:12.0.0
public OCP\IGroup::getUsers()
get all users in the group
Source:lib/public/IGroup.php#56
Returns:\OCP\IUser[]
Since:8.0.0
public OCP\IGroup::inGroup($user)
check if a user is in the group
Source:

lib/public/IGroup.php#65

Parameters:
Returns:

bool

Since:

8.0.0

public OCP\IGroup::addUser($user)
add a user to the group
Source:

lib/public/IGroup.php#73

Parameters:
Since:

8.0.0

public OCP\IGroup::removeUser($user)
remove a user from the group
Source:

lib/public/IGroup.php#81

Parameters:
Since:

8.0.0

public OCP\IGroup::searchUsers($search, $limit=null, $offset=null)
search for users in the group by userid
Source:

lib/public/IGroup.php#92

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
Source:

lib/public/IGroup.php#101

Parameters:
  • $search (string)
Returns:

int | bool

Since:

8.0.0

public OCP\IGroup::countDisabled()
returns the number of disabled users
Source:lib/public/IGroup.php#109
Returns:int | bool
Since:14.0.0
public OCP\IGroup::searchDisplayName($search, $limit=null, $offset=null)
search for users in the group by displayname
Source:

lib/public/IGroup.php#120

Parameters:
  • $search (string)
  • $limit (int)
  • $offset (int)
Returns:

\OCP\IUser[]

Since:

8.0.0

public OCP\IGroup::delete()
delete the group
Source:lib/public/IGroup.php#128
Returns:bool
Since:8.0.0
public OCP\IGroup::canRemoveUser()
Source:lib/public/IGroup.php#134
Returns:bool
Since:14.0.0
public OCP\IGroup::canAddUser()
Source:lib/public/IGroup.php#140
Returns:bool
Since:14.0.0
public OCP\IGroup::hideFromCollaboration()
Source:lib/public/IGroup.php#146
Returns:bool
Since:16.0.0