Skip to main content

UserInfoAggregator

Aggregates all requests into one big send request to deduplicate the request

Functions​

PromiseUserInfo​

</>
UserInfoAggregator:PromiseUserInfo(userId: number) → Promise<UserInfo>

Promises the user info for the given user, aggregating all requests to reduce calls into Roblox.

PromiseDisplayName​

</>
UserInfoAggregator:PromiseDisplayName(userId: number) → Promise<string>

Promises the user display name for the userId

PromiseUsername​

</>
UserInfoAggregator:PromiseUsername(userId: number) → Promise<string>

Promises the Username for the userId

PromiseHasVerifiedBadge​

</>
UserInfoAggregator:PromiseHasVerifiedBadge(userId: number) → Promise<boolean>

Promises the user display name for the userId

ObserveUserInfo​

</>
UserInfoAggregator:ObserveUserInfo(userId: number) → Observable<UserInfo>

Observes the user display name for the userId

ObserveDisplayName​

</>
UserInfoAggregator:ObserveDisplayName(userId: number) → Observable<string>

Observes the user display name for the userId

ObserveUsername​

</>
UserInfoAggregator:ObserveUsername(userId: number) → Observable<string>

Observes the Username for the userId

ObserveHasVerifiedBadge​

</>
UserInfoAggregator:ObserveHasVerifiedBadge(userId: number) → Observable<boolean>

Observes the user display name for the userId

Show raw api
{
    "functions": [
        {
            "name": "PromiseUserInfo",
            "desc": "Promises the user info for the given user, aggregating all requests to reduce\ncalls into Roblox.",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<UserInfo>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "PromiseDisplayName",
            "desc": "Promises the user display name for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 64,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "PromiseUsername",
            "desc": "Promises the Username for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 78,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "PromiseHasVerifiedBadge",
            "desc": "Promises the user display name for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 92,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "ObserveUserInfo",
            "desc": "Observes the user display name for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UserInfo>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 106,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "ObserveDisplayName",
            "desc": "Observes the user display name for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 118,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "ObserveUsername",
            "desc": "Observes the Username for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 134,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        },
        {
            "name": "ObserveHasVerifiedBadge",
            "desc": "Observes the user display name for the userId",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "UserInfoAggregator",
    "desc": "Aggregates all requests into one big send request to deduplicate the request",
    "source": {
        "line": 7,
        "path": "src/userserviceutils/src/Shared/UserInfoAggregator.lua"
    }
}