Skip to main content

TextFilterServiceClient

Functions​

PromiseNonChatStringForUser​

</>
TextFilterServiceClient:PromiseNonChatStringForUser(
text: string,
fromUserId: number
) → Promise<string>

Filters a non-chat string for a user

PromiseNonChatStringForBroadcast​

</>
TextFilterServiceClient:PromiseNonChatStringForBroadcast(
text: string,
fromUserId: number
) → Promise<string>

Filters a non-chat string for a broadcast

PromisePreviewNonChatStringForBroadcast​

</>
TextFilterServiceClient:PromisePreviewNonChatStringForBroadcast(text: string) → Promise<string>

Filters a preview-non-chat string for a broadcast

ObservePreviewNonChatStringForBroadcast​

</>
TextFilterServiceClient:ObservePreviewNonChatStringForBroadcast(text: string) → Promise<string>

Observes a non-chat string preview for broadcast

Show raw api
{
    "functions": [
        {
            "name": "PromiseNonChatStringForUser",
            "desc": "Filters a non-chat string for a user",
            "params": [
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "fromUserId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 25,
                "path": "src/textfilterservice/src/Client/TextFilterServiceClient.lua"
            }
        },
        {
            "name": "PromiseNonChatStringForBroadcast",
            "desc": "Filters a non-chat string for a broadcast",
            "params": [
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "fromUserId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 42,
                "path": "src/textfilterservice/src/Client/TextFilterServiceClient.lua"
            }
        },
        {
            "name": "PromisePreviewNonChatStringForBroadcast",
            "desc": "Filters a preview-non-chat string for a broadcast",
            "params": [
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 58,
                "path": "src/textfilterservice/src/Client/TextFilterServiceClient.lua"
            }
        },
        {
            "name": "ObservePreviewNonChatStringForBroadcast",
            "desc": "Observes a non-chat string preview for broadcast",
            "params": [
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/textfilterservice/src/Client/TextFilterServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TextFilterServiceClient",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/textfilterservice/src/Client/TextFilterServiceClient.lua"
    }
}