UnsubscribeRequest
extends PendingMessage
in package
Represents an unsubscribe request.
Table of Contents
- $lastSentAt : DateTime
- $messageId : int
- $sendingAttempts : int
- $topicFilters : array<string|int, mixed>
- __construct() : mixed
- Creates a new unsubscribe request object.
- getLastSentAt() : DateTime
- Returns the date time when the message was last sent.
- getMessageId() : int
- Returns the message identifier.
- getSendingAttempts() : int
- Returns the number of times the message has been sent.
- getTopicFilters() : array<string|int, string>
- Returns the topic filters in this request.
- incrementSendingAttempts() : static
- Increments the sending attempts by one.
- setLastSentAt() : static
- Sets the date time when the message was last sent.
Properties
$lastSentAt
private
DateTime
$lastSentAt
$messageId
private
int
$messageId
$sendingAttempts
private
int
$sendingAttempts
= 1
$topicFilters
private
array<string|int, mixed>
$topicFilters
Methods
__construct()
Creates a new unsubscribe request object.
public
__construct(int $messageId, array<string|int, string> $topicFilters) : mixed
Parameters
- $messageId : int
- $topicFilters : array<string|int, string>
Return values
mixed —getLastSentAt()
Returns the date time when the message was last sent.
public
getLastSentAt() : DateTime
Return values
DateTime —getMessageId()
Returns the message identifier.
public
getMessageId() : int
Return values
int —getSendingAttempts()
Returns the number of times the message has been sent.
public
getSendingAttempts() : int
Return values
int —getTopicFilters()
Returns the topic filters in this request.
public
getTopicFilters() : array<string|int, string>
Return values
array<string|int, string> —incrementSendingAttempts()
Increments the sending attempts by one.
public
incrementSendingAttempts() : static
Return values
static —setLastSentAt()
Sets the date time when the message was last sent.
public
setLastSentAt([DateTime|null $value = null ]) : static
Parameters
- $value : DateTime|null = null