Nextcloud PHP API (stable18)

ISubAdmin

Tags
since
16.0.0

Table of Contents

createSubAdmin()  : void
add a SubAdmin
deleteSubAdmin()  : void
delete a SubAdmin
getGroupsSubAdmins()  : \OCP\IUser[]
get SubAdmins of a group
getSubAdminsGroups()  : \OCP\IGroup[]
get groups of a SubAdmin
isSubAdmin()  : bool
checks if a user is a SubAdmin
isSubAdminOfGroup()  : bool
checks if a user is a SubAdmin of a group
isUserAccessible()  : bool
checks if a user is a accessible by a subadmin

Methods

createSubAdmin()

add a SubAdmin

public createSubAdmin(IUser $user, IGroup $group) : void
Parameters
$user : IUser

user to be SubAdmin

$group : IGroup

group $user becomes subadmin of

Tags
since
16.0.0

deleteSubAdmin()

delete a SubAdmin

public deleteSubAdmin(IUser $user, IGroup $group) : void
Parameters
$user : IUser

the user that is the SubAdmin

$group : IGroup

the group

Tags
since
16.0.0

getGroupsSubAdmins()

get SubAdmins of a group

public getGroupsSubAdmins(IGroup $group) : \OCP\IUser[]
Parameters
$group : IGroup

the group

Tags
since
16.0.0
Return values
\OCP\IUser[]

getSubAdminsGroups()

get groups of a SubAdmin

public getSubAdminsGroups(IUser $user) : \OCP\IGroup[]
Parameters
$user : IUser

the SubAdmin

Tags
since
16.0.0
Return values
\OCP\IGroup[]

isSubAdmin()

checks if a user is a SubAdmin

public isSubAdmin(IUser $user) : bool
Parameters
$user : IUser
Tags
since
16.0.0
Return values
bool

isSubAdminOfGroup()

checks if a user is a SubAdmin of a group

public isSubAdminOfGroup(IUser $user, IGroup $group) : bool
Parameters
$user : IUser
$group : IGroup
Tags
since
16.0.0
Return values
bool

isUserAccessible()

checks if a user is a accessible by a subadmin

public isUserAccessible(IUser $subadmin, IUser $user) : bool
Parameters
$subadmin : IUser
$user : IUser
Tags
since
16.0.0
Return values
bool

Search results