Skip to main content

PolicyServiceUtils

Utility methods to query policies for players from PolicyService.

Functions

promisePolicyInfoForPlayer

PolicyServiceUtils.promisePolicyInfoForPlayer(playerPlayer) → table

Promises policy info for players.

canReferenceTwitter

PolicyServiceUtils.canReferenceTwitter(policyInfoPolicyInfo) → boolean

Returns true if you can reference Twitter

canReferenceTwitch

PolicyServiceUtils.canReferenceTwitch(policyInfoPolicyInfo) → boolean

Returns true if you can reference Twitch

canReferenceDiscord

PolicyServiceUtils.canReferenceDiscord(policyInfoPolicyInfo) → boolean

Returns true if you can reference Discord

canReferenceFacebook

PolicyServiceUtils.canReferenceFacebook(policyInfoPolicyInfo) → boolean

Returns true if you can reference Facebook

canReferenceYouTube

PolicyServiceUtils.canReferenceYouTube(policyInfoPolicyInfo) → boolean

Returns true if you can reference YouTube

canReferenceSocialMedia

PolicyServiceUtils.canReferenceSocialMedia(
policyInfoPolicyInfo,
socialInfoNamestring
) → boolean

Returns true if you can reference a specific social media title

Show raw api
{
    "functions": [
        {
            "name": "promisePolicyInfoForPlayer",
            "desc": "Promises policy info for players.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceTwitter",
            "desc": "Returns true if you can reference Twitter",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceTwitch",
            "desc": "Returns true if you can reference Twitch",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceDiscord",
            "desc": "Returns true if you can reference Discord",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceFacebook",
            "desc": "Returns true if you can reference Facebook",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 84,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceYouTube",
            "desc": "Returns true if you can reference YouTube",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 96,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        },
        {
            "name": "canReferenceSocialMedia",
            "desc": "Returns true if you can reference a specific social media title",
            "params": [
                {
                    "name": "policyInfo",
                    "desc": "",
                    "lua_type": "PolicyInfo"
                },
                {
                    "name": "socialInfoName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PolicyServiceUtils",
    "desc": "Utility methods to query policies for players from [PolicyService].",
    "source": {
        "line": 6,
        "path": "src/policyserviceutils/src/Shared/PolicyServiceUtils.lua"
    }
}