CSStagingEventMessage
extends CSStagingMessage
in package
API Layer for StagingMessage Database object.
Serves as a blueprint for all types of Staging Messages.
Tags
Table of Contents
- acknowledge() : bool
- Acknowledges the staging message. A persistent message has their HasUpdate flag and IsQueued flag updated.
- delete() : bool
- Deletes the staging message.
- dequeue() : bool
- Dequeues a staging message.
- getAttempts() : int
- Returns the value that indicates how many attempts have already been made.
- getBatchId() : string
- getChanges() : string
- Retrieves the Changes information of the message object.
- getId() : int
- Get the ID of the CSStagingMessage.
- getIsQueued() : int
- Get the value of the "IsQueued" property.
- getOperationType() : string
- Retrieves the operation type of the CSStagingMessage.
- getPriority() : int
- Retrieves the priority of the CSStagingMessage.
- getQueuedAt() : string
- Returns the timestamp when the message was queued.
- isQueued() : bool
- Checks if the staging message is queued.
- queue() : bool
- Queues the staging message for processing.
- reject() : bool
- Rejects the staging message.
- setAttempts() : void
- Sets the attempts value of the assigned record.
- setBatchId() : void
- setChanges() : void
- Sets the changes for the staging event message.
- setIsQueued() : void
- Sets the flag indicating whether the message is queued or not.
- setOperationType() : void
- Sets the operation type for the staging message.
- setPriority() : void
- Sets the priority of the staging message.
- setQueuedAt() : void
- Sets the queueing timestamp for the staging message.
- store() : bool
- Stores the CSStagingMessage.
Methods
acknowledge()
Acknowledges the staging message. A persistent message has their HasUpdate flag and IsQueued flag updated.
public
acknowledge() : bool
Tags
Return values
bool —Returns true if the acknowledgement is successful, false otherwise.
delete()
Deletes the staging message.
public
delete() : bool
Tags
Return values
bool —Returns true if the staging message is successfully deleted, false otherwise.
dequeue()
Dequeues a staging message.
public
dequeue() : bool
Tags
Return values
bool —True if the message was successfully dequeued, false otherwise.
getAttempts()
Returns the value that indicates how many attempts have already been made.
public
getAttempts() : int
Tags
Return values
int —The value that indicates how many attempts have already been made.
getBatchId()
public
getBatchId() : string
Tags
Return values
string —getChanges()
Retrieves the Changes information of the message object.
public
getChanges() : string
Tags
Return values
string —The item type.
getId()
Get the ID of the CSStagingMessage.
public
getId() : int
Tags
Return values
int —The ID of the CSStagingMessage.
getIsQueued()
Get the value of the "IsQueued" property.
public
getIsQueued() : int
Tags
Return values
int —The value of the "IsQueued" property.
getOperationType()
Retrieves the operation type of the CSStagingMessage.
public
getOperationType() : string
Tags
Return values
string —The operation type.
getPriority()
Retrieves the priority of the CSStagingMessage.
public
getPriority() : int
Tags
Return values
int —The priority of the CSStagingMessage.
getQueuedAt()
Returns the timestamp when the message was queued.
public
getQueuedAt() : string
Tags
Return values
string —The queued timestamp.
isQueued()
Checks if the staging message is queued.
public
final isQueued() : bool
Tags
Return values
bool —Returns true if the staging message is queued, false otherwise.
queue()
Queues the staging message for processing.
public
queue() : bool
Tags
Return values
bool —Returns true if the staging message is successfully queued, false otherwise.
reject()
Rejects the staging message.
public
reject([bool $bRetry = false ]) : bool
Parameters
- $bRetry : bool = false
-
(optional) Whether to retry the message or not.
Tags
Return values
bool —Returns true if the rejection is successful, false otherwise.
setAttempts()
Sets the attempts value of the assigned record.
public
setAttempts(int $iAttempts) : void
Parameters
- $iAttempts : int
-
The attempts value.
Tags
Return values
void —setBatchId()
public
setBatchId(string $sBatchId) : void
Parameters
- $sBatchId : string
Tags
Return values
void —setChanges()
Sets the changes for the staging event message.
public
setChanges(string $sChanges) : void
Parameters
- $sChanges : string
-
The changes to set.
Tags
Return values
void —setIsQueued()
Sets the flag indicating whether the message is queued or not.
public
setIsQueued(int $bIsQueued) : void
Parameters
- $bIsQueued : int
-
The flag indicating whether the message is queued (1) or not (0).
Tags
Return values
void —setOperationType()
Sets the operation type for the staging message.
public
setOperationType(string $sOperationType) : void
Parameters
- $sOperationType : string
-
The operation type to set.
Tags
Return values
void —setPriority()
Sets the priority of the staging message.
public
setPriority(int $iPriority) : void
Parameters
- $iPriority : int
-
The priority value to set.
Tags
Return values
void —setQueuedAt()
Sets the queueing timestamp for the staging message.
public
setQueuedAt(string $sQueuedAt) : void
Parameters
- $sQueuedAt : string
-
The queueing timestamp.
Tags
Return values
void —store()
Stores the CSStagingMessage.
public
store() : bool
Tags
Return values
bool —Returns true if the CSStagingMessage is successfully stored, false otherwise.