ITeamFolderProvider
extends
ITeamResourceProvider
in
Provides the exclusive folder belonging to a team.
Register implementations through IRegistrationContext::registerTeamResourceProvider().
Tags
Attributes
- #[Consumable]
- $since: '35.0.0'
- #[Implementable]
- $since: '35.0.0'
Table of Contents
Methods
- createTeamFolder() : TeamFolder
- Create the exclusive folder for a team, or return its existing folder.
- getIconSvg() : string
- Svg icon to show next to the provider (app icon)
- getId() : string
- Unique identifier used to identify the provider (app id)
- getLinkableTeamFolders() : array<string|int, mixed>
- Return the list of team folders that can be linked to the team.
- getName() : string
- User visible name of the provider (app name)
- getSharedWith() : array<string|int, TeamResource>
- Return all resources that are shared to the given team id for the current provider
- getTeamFolder() : TeamFolder|null
- Return the folder exclusively linked to the team.
- getTeamsForResource() : array<string|int, string>
- Return team ids that a resource is shared with or owned by
- isSharedWithTeam() : bool
- Check if a resource is shared with the given team
- linkTeamFolder() : TeamFolder
- Link a team folder to the team.
- removeTeamFolder() : bool
- Remove the team folder and its contents.
- unlinkTeamFolder() : TeamFolder|null
- Remove the exclusive relationship but retain the folder and its contents.
- updateTeamFolderQuota() : TeamFolder
- Update the storage quota of the team folder.
Methods
createTeamFolder()
Create the exclusive folder for a team, or return its existing folder.
public
createTeamFolder(Team $team[, int $quota = 0 ]) : TeamFolder
Parameters
- $team : Team
-
The team that owns the folder.
- $quota : int = 0
-
Quota in bytes; zero means unlimited.
Tags
Return values
TeamFoldergetIconSvg()
Svg icon to show next to the provider (app icon)
public
getIconSvg() : string
Tags
Return values
stringgetId()
Unique identifier used to identify the provider (app id)
public
getId() : string
Tags
Return values
stringgetLinkableTeamFolders()
Return the list of team folders that can be linked to the team.
public
getLinkableTeamFolders(string $circleId) : array<string|int, mixed>
Parameters
- $circleId : string
Tags
Return values
array<string|int, mixed>getName()
User visible name of the provider (app name)
public
getName() : string
Tags
Return values
stringgetSharedWith()
Return all resources that are shared to the given team id for the current provider
public
getSharedWith(string $teamId) : array<string|int, TeamResource>
Parameters
- $teamId : string
Tags
Return values
array<string|int, TeamResource>getTeamFolder()
Return the folder exclusively linked to the team.
public
getTeamFolder(string $teamId) : TeamFolder|null
Parameters
- $teamId : string
Tags
Return values
TeamFolder|nullgetTeamsForResource()
Return team ids that a resource is shared with or owned by
public
getTeamsForResource(string $resourceId) : array<string|int, string>
Parameters
- $resourceId : string
Tags
Return values
array<string|int, string>isSharedWithTeam()
Check if a resource is shared with the given team
public
isSharedWithTeam(string $teamId, string $resourceId) : bool
Parameters
- $teamId : string
- $resourceId : string
Tags
Return values
boollinkTeamFolder()
Link a team folder to the team.
public
linkTeamFolder(string $circleId, int $folderId) : TeamFolder
Parameters
- $circleId : string
- $folderId : int
Tags
Return values
TeamFolderremoveTeamFolder()
Remove the team folder and its contents.
public
removeTeamFolder(string $teamId) : bool
Parameters
- $teamId : string
Tags
Return values
boolunlinkTeamFolder()
Remove the exclusive relationship but retain the folder and its contents.
public
unlinkTeamFolder(string $teamId) : TeamFolder|null
Parameters
- $teamId : string
Tags
Return values
TeamFolder|null —The unlinked folder, if one existed.
updateTeamFolderQuota()
Update the storage quota of the team folder.
public
updateTeamFolderQuota(string $teamId, int $quota) : TeamFolder
Parameters
- $teamId : string
-
The team single id.
- $quota : int
-
Quota in bytes; zero means unlimited.
Tags
Return values
TeamFolder —The updated folder.