Skip to main content

UserInfoService

Centralized provider for user info so we can coordinate web requests.

Functions​

PromiseUserInfo​

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

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

ObserveUserInfo​

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

Observes the user info for the user

PromiseDisplayName​

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

Promises the user display name for the userId

PromiseUsername​

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

Promises the Username for the userId

ObserveDisplayName​

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

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": 35,
                "path": "src/userserviceutils/src/Shared/UserInfoService.lua"
            }
        },
        {
            "name": "ObserveUserInfo",
            "desc": "Observes the user info for the user",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<UserInfo>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "src/userserviceutils/src/Shared/UserInfoService.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": 59,
                "path": "src/userserviceutils/src/Shared/UserInfoService.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": 71,
                "path": "src/userserviceutils/src/Shared/UserInfoService.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": 83,
                "path": "src/userserviceutils/src/Shared/UserInfoService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "UserInfoService",
    "desc": "Centralized provider for user info so we can coordinate web requests.",
    "source": {
        "line": 7,
        "path": "src/userserviceutils/src/Shared/UserInfoService.lua"
    }
}