\OCPIGroup

Interface IGroup

Summary

Methods
Constants
getGID()
getDisplayName()
getUsers()
inGroup()
addUser()
removeUser()
searchUsers()
count()
searchDisplayName()
delete()
getBackend()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getGID()

getGID() : string

Returns

string

getDisplayName()

getDisplayName() : string

Returns the group display name

Returns

string

getUsers()

getUsers() : array<mixed,\OCP\IUser>

get all users in the group

Returns

array<mixed,\OCP\IUser>

inGroup()

inGroup(\OCP\IUser  $user) : boolean

check if a user is in the group

Parameters

\OCP\IUser $user

Returns

boolean

addUser()

addUser(\OCP\IUser  $user) 

add a user to the group

Parameters

\OCP\IUser $user

removeUser()

removeUser(\OCP\IUser  $user) 

remove a user from the group

Parameters

\OCP\IUser $user

searchUsers()

searchUsers(string  $search, integer  $limit = null, integer  $offset = null) : array<mixed,\OCP\IUser>

search for users in the group by userid

Parameters

string $search
integer $limit
integer $offset

Returns

array<mixed,\OCP\IUser>

count()

count(string  $search = '') : integer|boolean

returns the number of users matching the search string

Parameters

string $search

Returns

integer|boolean

searchDisplayName()

searchDisplayName(string  $search, integer  $limit = null, integer  $offset = null) : array<mixed,\OCP\IUser>

search for users in the group by displayname

Parameters

string $search
integer $limit
integer $offset

Returns

array<mixed,\OCP\IUser>

delete()

delete() : boolean

delete the group

Returns

boolean

getBackend()

getBackend() : \OC\Group\Backend

Returns the backend for this group

Returns

\OC\Group\Backend