Skip to content

partialuser

roblox.partials.partialuser

This file contains partial objects related to Roblox users.

PartialUser (BaseUser)

Represents partial user information.

Attributes:

Name Type Description
_client Client

The Client object, which is passed to all objects this Client generates.

id int

The user's ID.

name str

The user's name.

display_name str

The user's display name.

Source code in roblox/partials/partialuser.py
class PartialUser(BaseUser):
    """
    Represents partial user information.

    Attributes:
        _client: The Client object, which is passed to all objects this Client generates.
        id: The user's ID.
        name: The user's name.
        display_name: The user's display name.
    """

    def __init__(self, client: Client, data: dict):
        """
        Arguments:
            client: The Client.
            data: The data from the endpoint.
        """
        self._client: Client = client

        self.id: int = data.get("id") or data.get("userId") or data.get("Id")

        super().__init__(client=client, user_id=self.id)

        self.name: str = data.get("name") or data.get("Name") or data.get("username") or data.get("Username")
        self.display_name: str = data.get("displayName")

    def __repr__(self):
        return f"<{self.__class__.__name__} id={self.id} name={self.name!r} display_name={self.display_name!r}>"

__init__(self, client: Client, data: dict) special

Parameters:

Name Type Description Default
client Client

The Client.

required
data dict

The data from the endpoint.

required
Source code in roblox/partials/partialuser.py
def __init__(self, client: Client, data: dict):
    """
    Arguments:
        client: The Client.
        data: The data from the endpoint.
    """
    self._client: Client = client

    self.id: int = data.get("id") or data.get("userId") or data.get("Id")

    super().__init__(client=client, user_id=self.id)

    self.name: str = data.get("name") or data.get("Name") or data.get("username") or data.get("Username")
    self.display_name: str = data.get("displayName")

__repr__(self) special

Source code in roblox/partials/partialuser.py
def __repr__(self):
    return f"<{self.__class__.__name__} id={self.id} name={self.name!r} display_name={self.display_name!r}>"

PreviousUsernamesPartialUser (PartialUser)

Represents a partial user in the context of a search where the user's previous usernames are present.

Attributes:

Name Type Description
previous_usernames List[str]

A list of the user's previous usernames.

Source code in roblox/partials/partialuser.py
class PreviousUsernamesPartialUser(PartialUser):
    """
    Represents a partial user in the context of a search where the user's previous usernames are present.
    Attributes:
        previous_usernames: A list of the user's previous usernames.
    """

    def __init__(self, client: Client, data: dict):
        """
        Arguments:
            client: The Client.
            data: The data from the endpoint.
        """
        super().__init__(client=client, data=data)

        self.previous_usernames: List[str] = data["previousUsernames"]

__init__(self, client: Client, data: dict) special

Source code in roblox/partials/partialuser.py
def __init__(self, client: Client, data: dict):
    """
    Arguments:
        client: The Client.
        data: The data from the endpoint.
    """
    super().__init__(client=client, data=data)

    self.previous_usernames: List[str] = data["previousUsernames"]

RequestedUsernamePartialUser (PartialUser)

Represents a partial user in the context of a search where the requested username is present.

Attributes:

Name Type Description
requested_username Optional[str]

The requested username.

Source code in roblox/partials/partialuser.py
class RequestedUsernamePartialUser(PartialUser):
    """
    Represents a partial user in the context of a search where the requested username is present.

    Attributes:
        requested_username: The requested username.
    """

    def __init__(self, client: Client, data: dict):
        """
        Arguments:
            client: The Client.
            data: The data from the endpoint.
        """
        super().__init__(client=client, data=data)

        self.requested_username: Optional[str] = data.get("requestedUsername")

__init__(self, client: Client, data: dict) special

Source code in roblox/partials/partialuser.py
def __init__(self, client: Client, data: dict):
    """
    Arguments:
        client: The Client.
        data: The data from the endpoint.
    """
    super().__init__(client=client, data=data)

    self.requested_username: Optional[str] = data.get("requestedUsername")