Nextcloud PHP API (master)

ITeamResourceProvider

Implement a provider of resources that are shared or owned by a team

Tags
since
29.0.0

Table of Contents

Methods

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
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

Methods

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>

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

        
On this page

Search results