IShareSourceType
in
Tags
Attributes
- #[Implementable]
- $since: '35.0.0'
Table of Contents
Methods
- getDisplayName() : non-empty-string
- Returns a user friendly display name for this source type.
- getSourceDisplayName() : non-empty-string|null
- getSourceIcon() : null|ShareIconSVG|ShareIconURL
- getSourceInteractionResource() : InteractionResource
- validateSource() : bool
- Validate that a source exists.
Methods
getDisplayName()
Returns a user friendly display name for this source type.
public
getDisplayName(IFactory $l10nFactory) : non-empty-string
Parameters
- $l10nFactory : IFactory
Tags
Return values
non-empty-stringgetSourceDisplayName()
public
getSourceDisplayName(non-empty-string $source) : non-empty-string|null
Parameters
- $source : non-empty-string
Tags
Return values
non-empty-string|nullgetSourceIcon()
public
getSourceIcon(non-empty-string $source) : null|ShareIconSVG|ShareIconURL
Parameters
- $source : non-empty-string
Tags
Return values
null|ShareIconSVG|ShareIconURLgetSourceInteractionResource()
public
getSourceInteractionResource(non-empty-string $userId, non-empty-string $source) : InteractionResource
Parameters
- $userId : non-empty-string
- $source : non-empty-string
Tags
Return values
InteractionResourcevalidateSource()
Validate that a source exists.
public
validateSource(non-empty-string $source) : bool
Any check if the source is allowed to be accessed and shared, must be implemented through RestrictInteractionEvent.
Parameters
- $source : non-empty-string