Skip to main content

DataStoreMessageHelper

Functions​

GetServiceBag​

</>
DataStoreMessageHelper.GetServiceBag(self: DataStoreMessageHelper) → ServiceBag

Returns the service bag used by this helper. (Used for comparison)

PromiseCloseSessionGraceful​

</>
DataStoreMessageHelper.PromiseCloseSessionGraceful(
placeId: number,
jobId: string,
sessionId: string
) → Promise<()>

Promises a graceful close session notification to other sessions.

PromiseSendSessionMessage​

</>
DataStoreMessageHelper.PromiseSendSessionMessage(
placeId: number,
jobId: string,
sessionId: string,
message: DataStoreMessage
) → Promise<()>

Promises sending a message to another DataStore session.

Show raw api
{
    "functions": [
        {
            "name": "GetServiceBag",
            "desc": "Returns the service bag used by this helper. (Used for comparison)",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DataStoreMessageHelper"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 69,
                "path": "src/datastore/src/Server/DataStoreMessageHelper.lua"
            }
        },
        {
            "name": "PromiseCloseSessionGraceful",
            "desc": "Promises a graceful close session notification to other sessions.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DataStoreMessageHelper"
                },
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "jobId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "sessionId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/datastore/src/Server/DataStoreMessageHelper.lua"
            }
        },
        {
            "name": "PromiseSendSessionMessage",
            "desc": "Promises sending a message to another DataStore session.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DataStoreMessageHelper"
                },
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "jobId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "sessionId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "DataStoreMessage"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 124,
                "path": "src/datastore/src/Server/DataStoreMessageHelper.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DataStoreMessageHelper",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/datastore/src/Server/DataStoreMessageHelper.lua"
    }
}