The ILinxterMessaging type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CreateMessage |
Stores the message in the send queue.
| |
| CreateMessages |
Stores a collection of messages in the send queue. This method is strongly recommended if a large number of messages will be created in a
short period of time. By using this method they can be committed to the database as a single transaction, which is far faster than storing them
individually.
The messages will be delivered in the order that they are in the array (index zero first).
If any of the messages fails validation, an exception will be raised with information about the messages that failed
validation and no messages will be stored. The message ids for each message will be in the same index position in the returned Guid array.
| |
| DownloadAttachment |
Download an attachment that is specified as part of a message received. You can obtain the parameters from the MessageReceived event's arguments AttachmentInfo array.
| |
| DownloadAttachmentAsync |
Initiates an async download of the attachment. When the download is complete, the DownloadAttachmentCompleted event will fire and its event arguments will contain the attachment. You can obtain the parameters from the MessageReceived event's arguments AttachmentInfo.
| |
| GetRetryLogEntries |
This method returns a list of retry log entries. These entries allow you to see if there is a retry cycle
in process for a given operation (i.e. Send or Receive). A retry cycle indicates the SDK was unable to
connect to the Linxter ISB, usually due to a lack of connectivity on the client for offline scenarios.
The log entries show when a retry was attempted and what the error message was. When the operation succeeds,
the retry log is cleared for that operation.
| |
| ReceiveNow |
An alternative to using StartScheduledReceive/StopScheduledReceive. Causes an immediate
check with the Linxter services to retrieve current messages.
| |
| SendNow |
Starts sending messages in the queue immediately.
| |
| SetScheduledReceiveInterval |
Sets the scheduled receive interval if an interval range is enabled for the program. If not, an exception will be thrown. Also, if the specified interval is outside the allowable range, an exception will be thrown.
| |
| SetScheduledSendInterval |
Sets the scheduled send interval, if range intervals are enabled for the program. If not, an exception will be thrown. If the specified interval is outside the allowable range, an exception will be thrown.
| |
| SetSecondaryScheduledSendInterval |
Sets the scheduled send interval for the secondary queue, if range intervals are enabled for the program. If not, an exception will be thrown. If the specified interval is outside the allowable range, an exception will be thrown.
| |
| StartScheduledReceive |
Starts listening for messages sent to this instance of the program. Used with
StopScheduledReceive to listen for messages.
| |
| StartScheduledSend |
Starts the scheduled sending of messages.
| |
| StopScheduledReceive |
Stops listening for messages sent to this instance of the program. Used with
StartScheduledReceive to listen for messages.
| |
| StopScheduledSend |
Stops the scheduled sending of messages.
|
Properties
| Name | Description | |
|---|---|---|
| MessagesInQueue |
Gets the number of messages in a local queue.
| |
| MessagesInSecondaryQueue |
Gets the number of messages in the secondary queue.
| |
| ReceiveSettings |
Gets the Message Retrieval Settings.
| |
| SecondaryQueueSendSettings |
Gets the Message Sending Settings for the secondary queue.
| |
| SendSettings |
Gets the Message Sending Settings.
|
Events
| Name | Description | |
|---|---|---|
| DownloadAttachmentCompleted |
Event that fires when attachment download is complete. The event argument contains the attachment or error information if an error occurred.
| |
| MessageReceived |
An event that occurs when a message is received.
| |
| MessageStatusNotification |
An event that is fired when a message's disposition is determined at the ISB (delivered, quarantined, expired).
| |
| SendCompleted |
An event that is fired when a message is sent or cannot be sent.
|