CsrpMessageFragment

A CsrpMessageFragment object represents a fragment of a message that uses the CSRPv2 specification.

Constructors

CsrpMessageFragment new

CsrpMessageFragment.new = function(interactionId: string?, fragment: number?, fragmentCount: number?, content: string?): CsrpMessageFragment

Returns a CsrpMessageFragment.

Arguments:

1. string? interactionId - The message interaction ID. Required when there are multiple fragments.
2. number? fragment - The fragment number.
3. number? fragmentCount - The total number of fragments.
4. string? content - The encapsulated message fragment content.

Note

The first 3 arguments that form the message header must not contain semicolons (;). The message content can contain any characters.

CsrpMessageFragment fromString

CsrpMessageFragment.fromString = function(message: string): CsrpMessageFragment

Parse a string into a CsrpMessageFragment. Throws an error if the string is not a valid CSRPv2 message fragment.

Arguments:

1. string message - The message to parse.

---

Properties

string? InteractionId

The message interaction ID. Required when there are multiple fragments.

number? Fragment

The fragment sequence number. Starts at 1.

number? FragmentCount

The total number of fragments in the message.

string? Content

The encapsulated message fragment content. Can contain any characters.

---

Serialization

A CsrpMessageFragment object can be serialized into a string using the built-in tostring function.

local fragment = CsrpMessageFragment.new("interactionId", 1, 2, "content")
print(tostring(fragment)) --> "interactionId;1;2;content"