Presence - Get online status of friends

Presence - Get online status of friends

class xbox.webapi.api.provider.presence.PresenceProvider(client)[source]

Bases: BaseProvider

PRESENCE_URL = 'https://userpresence.xboxlive.com'
HEADERS_PRESENCE = {'Accept': 'application/json', 'x-xbl-contract-version': '3'}
async get_presence(xuid, presence_level=PresenceLevel.USER, **kwargs)[source]

Get presence for given xuid

Parameters:
Returns:

Presence Response

Return type:

PresenceItem

async get_presence_batch(xuids, online_only=False, presence_level=PresenceLevel.USER, **kwargs)[source]

Get presence for list of xuids

Parameters:

  • xuids (List[str]) – List of XUIDs

  • online_only (bool) – Only get online profiles

  • presence_level (PresenceLevel) – Filter level

Return type:

List[PresenceItem]

Returns: List[PresenceItem]: List of presence items

async get_presence_own(presence_level=PresenceLevel.ALL, **kwargs)[source]

Get presence of own profile

Parameters:

presence_level (PresenceLevel) – Filter level

Returns:

Presence Response

Return type:

PresenceItem

async set_presence_own(presence_state, **kwargs)[source]

Set presence of own profile

Parameters:

presence_state (PresenceState) – State of presence

Returns:

True on success, False otherwise

Return type:

bool