RequestMessage
in package
implements
MessageInterface
Table of Contents
Interfaces
Properties
- $filters : array<string|int, mixed>
- Array of filters
- $subscriptionId : string
- An arbitrary, non-empty string of max length 64 chars
- $type : string
- Message type.
Methods
- __construct() : mixed
- Constructor for the RequestMessage class.
- generate() : string
- Generates a JSON-encoded request array by merging the subscription ID and filters array.
- setType() : void
- Set message type.
Properties
$filters
Array of filters
protected
array<string|int, mixed>
$filters
= []
$subscriptionId
An arbitrary, non-empty string of max length 64 chars
protected
string
$subscriptionId
$type
Message type.
private
string
$type
Methods
__construct()
Constructor for the RequestMessage class.
public
__construct(string $subscriptionId, array<string|int, mixed> $filters) : mixed
Initializes the subscription ID and filters array based on the provided parameters.
Parameters
- $subscriptionId : string
-
The ID of the subscription
- $filters : array<string|int, mixed>
-
An array of filters to be applied
generate()
Generates a JSON-encoded request array by merging the subscription ID and filters array.
public
generate() : string
Return values
string —The JSON-encoded request array
setType()
Set message type.
public
setType(MessageTypeEnum $type) : void
Parameters
- $type : MessageTypeEnum