Skip to main content

PlaceMessagingService

Provides a centralized messaging service for the current place, to other places.

Functions​

ObserveMessages​

</>
PlaceMessagingService.ObserveMessages(
topic: string
) → Observable<unknown>

Observes messages for the current place on the given topic

The returned value should be the same as the message published.

TIP

This observable will only be active while there is at least one active subscription to it. This is to help limit unnecessary load on MessagingService.

SendMessage​

</>
PlaceMessagingService.SendMessage(
placeId: number,
jobId: string,
topic: string,
message: any
) → Promise<()>

Sends a message to the given place and job

SendMessageToAddress​

</>
PlaceMessagingService.SendMessageToAddress(
address: PlaceAddress,
topic: string,
message: any
) → Promise<()>

Sends a message to the given place address

GetPlaceAddress​

</>
PlaceMessagingService.GetPlaceAddress(self: PlaceMessagingService) → PlaceAddress

Gets the current place address

PlaceAddressToTopicString​

</>
PlaceMessagingService.PlaceAddressToTopicString(
address: PlaceAddress
) → string

Converts a place address to a topic string

PlaceAndJobToServerAddress​

</>
PlaceMessagingService.PlaceAndJobToServerAddress(
placeId: number,
jobId: string
) → PlaceAddress

Converts a placeId and jobId to a place address

Show raw api
{
    "functions": [
        {
            "name": "ObserveMessages",
            "desc": "Observes messages for the current place on the given topic\n\nThe returned value should be the same as the message published.\n\n:::tip\nThis observable will only be active while there is at least one active\nsubscription to it. This is to help limit unnecessary load on MessagingService.\n:::",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                },
                {
                    "name": "topic",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<unknown>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 137,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        },
        {
            "name": "SendMessage",
            "desc": "Sends a message to the given place and job",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                },
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "jobId",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "topic",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 166,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        },
        {
            "name": "SendMessageToAddress",
            "desc": "Sends a message to the given place address",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                },
                {
                    "name": "address",
                    "desc": "",
                    "lua_type": "PlaceAddress"
                },
                {
                    "name": "topic",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 185,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        },
        {
            "name": "GetPlaceAddress",
            "desc": "Gets the current place address",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlaceAddress"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 210,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        },
        {
            "name": "PlaceAddressToTopicString",
            "desc": "Converts a place address to a topic string",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                },
                {
                    "name": "address",
                    "desc": "",
                    "lua_type": "PlaceAddress"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 225,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        },
        {
            "name": "PlaceAndJobToServerAddress",
            "desc": "Converts a placeId and jobId to a place address",
            "params": [
                {
                    "name": "_self",
                    "desc": "",
                    "lua_type": "PlaceMessagingService"
                },
                {
                    "name": "placeId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "jobId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlaceAddress"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 236,
                "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlaceMessagingService",
    "desc": "Provides a centralized messaging service for the current place, to other places.",
    "source": {
        "line": 6,
        "path": "src/messagingserviceutils/src/Server/PlaceMessagingService.lua"
    }
}