People - Get friendlist info
People - Access friendlist from own profiles and others
- class xbox.webapi.api.provider.people.PeopleProvider(client)[source]
Bases:
BaseProvider
- SOCIAL_URL = 'https://social.xboxlive.com'
- HEADERS_SOCIAL = {'x-xbl-contract-version': '2'}
- PEOPLE_URL = 'https://peoplehub.xboxlive.com'
- HEADERS_PEOPLE = {'Accept-Language': 'overwrite in __init__', 'x-xbl-contract-version': '3'}
- SEPERATOR = ','
- __init__(client)[source]
Initialize Baseclass, set ‘Accept-Language’ header from client instance
- Parameters:
client (
XboxLiveClient
) – Instance of client
- async get_friends_own(decoration_fields=None, **kwargs)[source]
Get friendlist of own profile
- Returns:
People Response
- Return type:
PeopleResponse
- Parameters:
decoration_fields (List[PeopleDecoration]) –
- async get_friends_by_xuid(xuid, decoration_fields=None, **kwargs)[source]
Get friendlist of own profile
- Returns:
People Response
- Return type:
PeopleResponse
- Parameters:
xuid (str) –
decoration_fields (List[PeopleDecoration]) –
- async get_friends_own_batch(xuids, decoration_fields=None, **kwargs)[source]
Get friends metadata by providing a list of XUIDs
- Parameters:
decoration_fields (List[PeopleDecoration]) –
- Returns:
People Response
- Return type:
PeopleResponse
- async get_friend_recommendations(**kwargs)[source]
Get recommended friends
- Returns:
People Response
- Return type:
PeopleResponse
- async get_friends_summary_own(**kwargs)[source]
Get friendlist summary of own profile
- Returns:
People Summary Response
- Return type:
PeopleSummaryResponse