Nextcloud PHP API (master)

ITeamFolderProvider extends ITeamResourceProvider
in

Provides the exclusive folder belonging to a team.

Register implementations through IRegistrationContext::registerTeamResourceProvider().

Tags
since
35.0.0
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)
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
removeTeamFolder()  : bool
Remove the team folder and its contents.
unlinkTeamFolder()  : TeamFolder|null
Remove the exclusive relationship but retain the folder and its contents.

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
since
35.0.0
Return values
TeamFolder

getIconSvg()

Svg icon to show next to the provider (app icon)

public getIconSvg() : string
Tags
since
29.0.0
Return values
string

getId()

Unique identifier used to identify the provider (app id)

public getId() : string
Tags
since
29.0.0
Return values
string

getName()

User visible name of the provider (app name)

public getName() : string
Tags
since
29.0.0
Return values
string

getSharedWith()

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
since
29.0.0
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
since
35.0.0
Return values
TeamFolder|null

getTeamsForResource()

Return team ids that a resource is shared with or owned by

public getTeamsForResource(string $resourceId) : array<string|int, string>
Parameters
$resourceId : string
Tags
since
29.0.0
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
since
29.0.0
Return values
bool

removeTeamFolder()

Remove the team folder and its contents.

public removeTeamFolder(string $teamId) : bool
Parameters
$teamId : string
Tags
since
35.0.0
Return values
bool

unlinkTeamFolder()

Remove the exclusive relationship but retain the folder and its contents.

public unlinkTeamFolder(string $teamId) : TeamFolder|null
Parameters
$teamId : string
Tags
since
35.0.0
Return values
TeamFolder|null —

The unlinked folder, if one existed.

On this page

Search results