Module ro_py.accountinformation
This file houses functions and classes that pertain to Roblox authenticated user account information.
Expand source code
"""
This file houses functions and classes that pertain to Roblox authenticated user account information.
"""
from datetime import datetime
from ro_py.gender import RobloxGender
from ro_py.utilities.url import url
endpoint = url("accountinformation")
class AccountInformationMetadata:
"""
Represents account information metadata.
"""
def __init__(self, metadata_raw):
self.is_allowed_notifications_endpoint_disabled = metadata_raw["isAllowedNotificationsEndpointDisabled"]
"""Unsure what this does."""
self.is_account_settings_policy_enabled = metadata_raw["isAccountSettingsPolicyEnabled"]
"""Whether the account settings policy is enabled (unsure exactly what this does)"""
self.is_phone_number_enabled = metadata_raw["isPhoneNumberEnabled"]
"""Whether the user's linked phone number is enabled."""
self.max_user_description_length = metadata_raw["MaxUserDescriptionLength"]
"""Maximum length of the user's description."""
self.is_user_description_enabled = metadata_raw["isUserDescriptionEnabled"]
"""Whether the user's description is enabled."""
self.is_user_block_endpoints_updated = metadata_raw["isUserBlockEndpointsUpdated"]
"""Whether the UserBlock endpoints are updated (unsure exactly what this does)"""
class PromotionChannels:
"""
Represents account information promotion channels.
"""
def __init__(self, promotion_raw):
self.promotion_channels_visibility_privacy = promotion_raw["promotionChannelsVisibilityPrivacy"]
"""Visibility of promotion channels."""
self.facebook = promotion_raw["facebook"]
"""Link to the user's Facebook page."""
self.twitter = promotion_raw["twitter"]
"""Link to the user's Twitter page."""
self.youtube = promotion_raw["youtube"]
"""Link to the user's YouTube page."""
self.twitch = promotion_raw["twitch"]
"""Link to the user's Twitch page."""
class AccountInformation:
"""
Represents authenticated client account information (https://accountinformation.roblox.com/)
This is only available for authenticated clients as it cannot be accessed otherwise.
Parameters
----------
cso : ro_py.client.ClientSharedObject
ClientSharedObject.
"""
def __init__(self, cso):
self.cso = cso
self.requests = cso.requests
self.account_information_metadata = None
self.promotion_channels = None
async def update(self):
"""
Updates the account information.
"""
account_information_req = await self.requests.get(
url="https://accountinformation.roblox.com/v1/metadata"
)
self.account_information_metadata = AccountInformationMetadata(account_information_req.json())
promotion_channels_req = await self.requests.get(
url="https://accountinformation.roblox.com/v1/promotion-channels"
)
self.promotion_channels = PromotionChannels(promotion_channels_req.json())
async def get_gender(self):
"""
Gets the user's gender.
Returns
-------
ro_py.gender.RobloxGender
"""
gender_req = await self.requests.get(endpoint + "v1/gender")
return RobloxGender(gender_req.json()["gender"])
async def set_gender(self, gender):
"""
Sets the user's gender.
Parameters
----------
gender : ro_py.gender.RobloxGender
"""
await self.requests.post(
url=endpoint + "v1/gender",
data={
"gender": str(gender.value)
}
)
async def get_birthdate(self):
"""
Grabs the user's birthdate.
Returns
-------
datetime.datetime
"""
birthdate_req = await self.requests.get(endpoint + "v1/birthdate")
birthdate_raw = birthdate_req.json()
birthdate = datetime(
year=birthdate_raw["birthYear"],
month=birthdate_raw["birthMonth"],
day=birthdate_raw["birthDay"]
)
return birthdate
async def set_birthdate(self, birthdate):
"""
Sets the user's birthdate.
Parameters
----------
birthdate : datetime.datetime
"""
await self.requests.post(
url=endpoint + "v1/birthdate",
data={
"birthMonth": birthdate.month,
"birthDay": birthdate.day,
"birthYear": birthdate.year
}
)Classes
class AccountInformation (cso)-
Represents authenticated client account information (https://accountinformation.roblox.com/) This is only available for authenticated clients as it cannot be accessed otherwise.
Parameters
cso:ro_py.client.ClientSharedObject- ClientSharedObject.
Expand source code
class AccountInformation: """ Represents authenticated client account information (https://accountinformation.roblox.com/) This is only available for authenticated clients as it cannot be accessed otherwise. Parameters ---------- cso : ro_py.client.ClientSharedObject ClientSharedObject. """ def __init__(self, cso): self.cso = cso self.requests = cso.requests self.account_information_metadata = None self.promotion_channels = None async def update(self): """ Updates the account information. """ account_information_req = await self.requests.get( url="https://accountinformation.roblox.com/v1/metadata" ) self.account_information_metadata = AccountInformationMetadata(account_information_req.json()) promotion_channels_req = await self.requests.get( url="https://accountinformation.roblox.com/v1/promotion-channels" ) self.promotion_channels = PromotionChannels(promotion_channels_req.json()) async def get_gender(self): """ Gets the user's gender. Returns ------- ro_py.gender.RobloxGender """ gender_req = await self.requests.get(endpoint + "v1/gender") return RobloxGender(gender_req.json()["gender"]) async def set_gender(self, gender): """ Sets the user's gender. Parameters ---------- gender : ro_py.gender.RobloxGender """ await self.requests.post( url=endpoint + "v1/gender", data={ "gender": str(gender.value) } ) async def get_birthdate(self): """ Grabs the user's birthdate. Returns ------- datetime.datetime """ birthdate_req = await self.requests.get(endpoint + "v1/birthdate") birthdate_raw = birthdate_req.json() birthdate = datetime( year=birthdate_raw["birthYear"], month=birthdate_raw["birthMonth"], day=birthdate_raw["birthDay"] ) return birthdate async def set_birthdate(self, birthdate): """ Sets the user's birthdate. Parameters ---------- birthdate : datetime.datetime """ await self.requests.post( url=endpoint + "v1/birthdate", data={ "birthMonth": birthdate.month, "birthDay": birthdate.day, "birthYear": birthdate.year } )Methods
async def get_birthdate(self)-
Grabs the user's birthdate.
Returns
datetime.datetime
Expand source code
async def get_birthdate(self): """ Grabs the user's birthdate. Returns ------- datetime.datetime """ birthdate_req = await self.requests.get(endpoint + "v1/birthdate") birthdate_raw = birthdate_req.json() birthdate = datetime( year=birthdate_raw["birthYear"], month=birthdate_raw["birthMonth"], day=birthdate_raw["birthDay"] ) return birthdate async def get_gender(self)-
Expand source code
async def get_gender(self): """ Gets the user's gender. Returns ------- ro_py.gender.RobloxGender """ gender_req = await self.requests.get(endpoint + "v1/gender") return RobloxGender(gender_req.json()["gender"]) async def set_birthdate(self, birthdate)-
Sets the user's birthdate.
Parameters
birthdate:datetime.datetime
Expand source code
async def set_birthdate(self, birthdate): """ Sets the user's birthdate. Parameters ---------- birthdate : datetime.datetime """ await self.requests.post( url=endpoint + "v1/birthdate", data={ "birthMonth": birthdate.month, "birthDay": birthdate.day, "birthYear": birthdate.year } ) async def set_gender(self, gender)-
Expand source code
async def set_gender(self, gender): """ Sets the user's gender. Parameters ---------- gender : ro_py.gender.RobloxGender """ await self.requests.post( url=endpoint + "v1/gender", data={ "gender": str(gender.value) } ) async def update(self)-
Updates the account information.
Expand source code
async def update(self): """ Updates the account information. """ account_information_req = await self.requests.get( url="https://accountinformation.roblox.com/v1/metadata" ) self.account_information_metadata = AccountInformationMetadata(account_information_req.json()) promotion_channels_req = await self.requests.get( url="https://accountinformation.roblox.com/v1/promotion-channels" ) self.promotion_channels = PromotionChannels(promotion_channels_req.json())
class AccountInformationMetadata (metadata_raw)-
Represents account information metadata.
Expand source code
class AccountInformationMetadata: """ Represents account information metadata. """ def __init__(self, metadata_raw): self.is_allowed_notifications_endpoint_disabled = metadata_raw["isAllowedNotificationsEndpointDisabled"] """Unsure what this does.""" self.is_account_settings_policy_enabled = metadata_raw["isAccountSettingsPolicyEnabled"] """Whether the account settings policy is enabled (unsure exactly what this does)""" self.is_phone_number_enabled = metadata_raw["isPhoneNumberEnabled"] """Whether the user's linked phone number is enabled.""" self.max_user_description_length = metadata_raw["MaxUserDescriptionLength"] """Maximum length of the user's description.""" self.is_user_description_enabled = metadata_raw["isUserDescriptionEnabled"] """Whether the user's description is enabled.""" self.is_user_block_endpoints_updated = metadata_raw["isUserBlockEndpointsUpdated"] """Whether the UserBlock endpoints are updated (unsure exactly what this does)"""Instance variables
var is_account_settings_policy_enabled-
Whether the account settings policy is enabled (unsure exactly what this does)
var is_allowed_notifications_endpoint_disabled-
Unsure what this does.
var is_phone_number_enabled-
Whether the user's linked phone number is enabled.
var is_user_block_endpoints_updated-
Whether the UserBlock endpoints are updated (unsure exactly what this does)
var is_user_description_enabled-
Whether the user's description is enabled.
var max_user_description_length-
Maximum length of the user's description.
class PromotionChannels (promotion_raw)-
Represents account information promotion channels.
Expand source code
class PromotionChannels: """ Represents account information promotion channels. """ def __init__(self, promotion_raw): self.promotion_channels_visibility_privacy = promotion_raw["promotionChannelsVisibilityPrivacy"] """Visibility of promotion channels.""" self.facebook = promotion_raw["facebook"] """Link to the user's Facebook page.""" self.twitter = promotion_raw["twitter"] """Link to the user's Twitter page.""" self.youtube = promotion_raw["youtube"] """Link to the user's YouTube page.""" self.twitch = promotion_raw["twitch"] """Link to the user's Twitch page."""Instance variables
var facebook-
Link to the user's Facebook page.
var promotion_channels_visibility_privacy-
Visibility of promotion channels.
var twitch-
Link to the user's Twitch page.
var twitter-
Link to the user's Twitter page.
var youtube-
Link to the user's YouTube page.