Group
in package
Table of Contents
Methods
- __construct() : mixed
- addUser() : void
- delete() : void
- delete an existing group (if the user has the permission to do so)
- getDescription() : string
- getDisplayName() : string
- getGroupTypes() : array<int, string>
- getId() : string
- getMembers() : array<int, User>
- removeUser() : void
- Remove an existing user from the current group
- rename() : bool
- Rename group
Methods
__construct()
public
__construct(Group $openApiGroup, string $serviceUrl, array<string|int, mixed> $connectionConfig, string &$accessToken) : mixed
Parameters
- $openApiGroup : Group
- $serviceUrl : string
- $connectionConfig : array<string|int, mixed>
- $accessToken : string
addUser()
public
addUser(User $user) : void
Parameters
- $user : User
Tags
delete()
delete an existing group (if the user has the permission to do so)
public
delete() : void
Tags
getDescription()
public
getDescription() : string
Return values
stringgetDisplayName()
public
getDisplayName() : string
Return values
stringgetGroupTypes()
public
getGroupTypes() : array<int, string>
Return values
array<int, string>getId()
public
getId() : string
Return values
stringgetMembers()
public
getMembers() : array<int, User>
Return values
array<int, User>removeUser()
Remove an existing user from the current group
public
removeUser(User $user) : void
Parameters
- $user : User
Tags
rename()
Rename group
public
rename(string $name) : bool
Parameters
- $name : string