TeamResource
in package
implements
JsonSerializable
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $iconEmoji : string|null
- $iconSvg : string|null
- $iconURL : string|null
- $label : string
- $resourceId : string
- $teamResourceProvider : ITeamResourceProvider
- $url : string
Methods
- __construct() : mixed
- getIconEmoji() : string|null
- Emoji show next to the name for the resource
- getIconSvg() : string|null
- Svg icon to show next to the name for the resource
- getIconURL() : string|null
- Image url of the icon to show next to the name for the resource
- getId() : string
- Unique id of the resource (e.g. primary key id)
- getLabel() : string
- User visible label when listing resources
- getProvider() : ITeamResourceProvider
- Returns the provider details for the current resource
- getUrl() : string
- Absolute url to navigate the user to the resource
- jsonSerialize() : array<string|int, mixed>
Properties
$iconEmoji
private
string|null
$iconEmoji
= null
$iconSvg
private
string|null
$iconSvg
= null
$iconURL
private
string|null
$iconURL
= null
$label
private
string
$label
$resourceId
private
string
$resourceId
$teamResourceProvider
private
ITeamResourceProvider
$teamResourceProvider
$url
private
string
$url
Methods
__construct()
public
__construct(ITeamResourceProvider $teamResourceProvider, string $resourceId, string $label, string $url[, string|null $iconSvg = null ][, string|null $iconURL = null ][, string|null $iconEmoji = null ]) : mixed
Parameters
- $teamResourceProvider : ITeamResourceProvider
- $resourceId : string
- $label : string
- $url : string
- $iconSvg : string|null = null
- $iconURL : string|null = null
- $iconEmoji : string|null = null
Tags
getIconEmoji()
Emoji show next to the name for the resource
public
getIconEmoji() : string|null
From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
Tags
Return values
string|nullgetIconSvg()
Svg icon to show next to the name for the resource
public
getIconSvg() : string|null
From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
Tags
Return values
string|nullgetIconURL()
Image url of the icon to show next to the name for the resource
public
getIconURL() : string|null
From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
Tags
Return values
string|nullgetId()
Unique id of the resource (e.g. primary key id)
public
getId() : string
Tags
Return values
stringgetLabel()
User visible label when listing resources
public
getLabel() : string
Tags
Return values
stringgetProvider()
Returns the provider details for the current resource
public
getProvider() : ITeamResourceProvider
Tags
Return values
ITeamResourceProvidergetUrl()
Absolute url to navigate the user to the resource
public
getUrl() : string
Tags
Return values
stringjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>