ButtonEmailEventPayload
in package
implements
OfcpEvent
FinalYes
Payload for sending emails with one to two buttons
Table of Contents
Interfaces
- OfcpEvent
- Basic interface for OFCP-Events.
Properties
- $header : EmailHeader
- $primaryButton : PrimaryButton
- $secondaryButton : SecondaryButton|null
- $text : string
- $title : string
Methods
- __construct() : self
- Payload for sending emails with one to two buttons
- from_json() : self
- Parse JSON data into an instance of this class.
- getHeader() : EmailHeader
- getPrimaryButton() : PrimaryButton
- getSecondaryButton() : SecondaryButton|null
- getText() : string
- getTitle() : string
- jsonSerialize() : array<string|int, mixed>
- setHeader() : void
- setPrimaryButton() : void
- setSecondaryButton() : void
- setText() : void
- setTitle() : void
Properties
$header
private
EmailHeader
$header
$primaryButton
private
PrimaryButton
$primaryButton
$secondaryButton
private
SecondaryButton|null
$secondaryButton
$text
private
string
$text
$title
private
string
$title
Methods
__construct()
Payload for sending emails with one to two buttons
public
__construct(EmailHeader $header, PrimaryButton $primaryButton, string $text, string $title, SecondaryButton $secondaryButton) : self
Parameters
- $header : EmailHeader
-
The header of an email. Reused in all email events.
- $primaryButton : PrimaryButton
-
The primary button
- $text : string
-
The text content of the email
- $title : string
-
The title of the email
- $secondaryButton : SecondaryButton
-
The secondary button
Return values
selffrom_json()
Parse JSON data into an instance of this class.
public
static from_json(string|array<string|int, mixed> $json) : self
Parameters
- $json : string|array<string|int, mixed>
-
JSON data to parse.
Return values
selfgetHeader()
public
getHeader() : EmailHeader
Return values
EmailHeadergetPrimaryButton()
public
getPrimaryButton() : PrimaryButton
Return values
PrimaryButtongetSecondaryButton()
public
getSecondaryButton() : SecondaryButton|null
Return values
SecondaryButton|nullgetText()
public
getText() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>setHeader()
public
setHeader(EmailHeader $header) : void
Parameters
- $header : EmailHeader
setPrimaryButton()
public
setPrimaryButton(PrimaryButton $primaryButton) : void
Parameters
- $primaryButton : PrimaryButton
setSecondaryButton()
public
setSecondaryButton(SecondaryButton|null $secondaryButton) : void
Parameters
- $secondaryButton : SecondaryButton|null
setText()
public
setText(string $text) : void
Parameters
- $text : string
setTitle()
public
setTitle(string $title) : void
Parameters
- $title : string