IShareRecipientTypePublicSecret
extends
IShareRecipientType
in
Tags
Attributes
- #[Implementable]
- $since: '35.0.0'
Table of Contents
Methods
- getDisplayName() : non-empty-string
- Returns a user friendly display name for this recipient type.
- getRecipientDisplayName() : non-empty-string|null
- getRecipientIcon() : null|ShareIconSVG|ShareIconURL
- getRecipientInteractionReceiver() : InteractionReceiver
- getRecipients() : array<int, string>
- Get possible recipient values for the current user.
- isSecretPublic() : bool
- isSecretUpdatable() : bool
- validateRecipient() : bool
- Validate that a recipient exists.
Methods
getDisplayName()
Returns a user friendly display name for this recipient type.
public
getDisplayName(IFactory $l10nFactory) : non-empty-string
Parameters
- $l10nFactory : IFactory
Tags
Return values
non-empty-stringgetRecipientDisplayName()
public
getRecipientDisplayName(non-empty-string $recipient) : non-empty-string|null
Parameters
- $recipient : non-empty-string
Tags
Return values
non-empty-string|nullgetRecipientIcon()
public
getRecipientIcon(non-empty-string $recipient) : null|ShareIconSVG|ShareIconURL
Parameters
- $recipient : non-empty-string
Tags
Return values
null|ShareIconSVG|ShareIconURLgetRecipientInteractionReceiver()
public
getRecipientInteractionReceiver(non-empty-string $recipient) : InteractionReceiver
Parameters
- $recipient : non-empty-string
Tags
Return values
InteractionReceivergetRecipients()
Get possible recipient values for the current user.
public
getRecipients(IUser|null $currentUser, mixed $arguments) : array<int, string>
Parameters
- $currentUser : IUser|null
- $arguments : mixed
Tags
Return values
array<int, string>isSecretPublic()
public
isSecretPublic(non-empty-string $recipient) : bool
Parameters
- $recipient : non-empty-string
Tags
Return values
boolisSecretUpdatable()
public
isSecretUpdatable(non-empty-string $recipient) : bool
Parameters
- $recipient : non-empty-string
Tags
Return values
boolvalidateRecipient()
Validate that a recipient exists.
public
validateRecipient(non-empty-string $recipient) : bool
Any check if the recipient is allowed to be shared to, must be implemented through RestrictInteractionEvent.
Parameters
- $recipient : non-empty-string