stingray.Social namespace reference

Description

The interface to access Social Manager functionality on Xbox One.

Other related reference items

Xbox Live

Functions

add_local_user_to_graph ( user_id ) Adds the user to the SocialMananager.

Parameters

user_id :

integer

Id of the user to start using social user manager.

Returns

This function does not return any values.

This needs to be done before the user can be used to call [stingray.Social.core_social_group] and stingray.Social.create_filtered_social_group

Use stingray.Social.remove_local_user_from_graph to remove the user from the SocialManager when it's no longer needed.

Note: If stingray.Social.last_social_events returns stingray.SocialEventType.RTA_DISCONNECT_ERR the user must be added to the SocialManager again.

Other related reference items

stingray.Social.create_filtered_social_group() stingray.Social.last_social_events()

create_filtered_social_group ( user_id, presence_filter, relationship_filter ) : integer Adds a social group with the supplied filters to the SocialManager.

Parameters

user_id :	integer	Id of the user to base the social group on.
presence_filter :	integer	Must be one of the stingray.SocialPresenceFilter constants.
relationship_filter :	integer	Must be one of the stingray.SocialRelationshipFilter constants.

Returns

integer

Id of the created social group.

Use stingray.Social.social_group to get information on the members in the group. Note that since the SocialManager keeps the the social group up to date asynchronously it might change at any time.

Ensure that the supplied user is added to the SocialManager with stingray.Social.add_local_user_to_graph before calling. When the social group is no longer in use it should be removed with stingray.Social.remove_social_group.

Note: If stingray.Social.last_social_events returns stingray.SocialEventType.RTA_DISCONNECT_ERR the social group must be recreated again.

Other related reference items

stingray.Social.add_local_user_to_graph() stingray.Social.last_social_events() stingray.Social.social_group()

last_social_events ( ) : integer* Returns the events from the SocialManager that has happened since last time this function was called.

Parameters

This function does not accept any parameters.

Returns

integer*

Will be one of the stingray.SocialEventType constants. The * notation indicates that there may be zero or more instances of the specified type.

Note: If stingray.SocialEventType.RTA_DISCONNECT_ERR is returned all users need to be added again with stingray.Social.add_local_user_to_graph and all social groups created with stingray.Social.create_filtered_social_group need to be recreated.

Other related reference items

stingray.Social.add_local_user_to_graph() stingray.Social.create_filtered_social_group()

remove_local_user_from_graph ( user_id ) Removes the user from the SocialManager.

Parameters

user_id :

integer

Id of the user to stop using the social user manager.

Returns

This function does not return any values.

Other related reference items

stingray.Social.add_local_user_to_graph()

remove_social_group ( social_group_id ) Removes the specified social group from the SocialManager.

Parameters

social_group_id :

integer

Id of the social group to remove.

Returns

This function does not return any values.

You should call this when the social group no longer is in use in order to avoid keeping it up to date unnecessarily.

Other related reference items

stingray.Social.create_filtered_social_group()

social_group ( social_group_id ) : social_user* Returns the specified social group created with stingray.Social.create_filtered_social_group.

Parameters

social_group_id :

integer

Id of the social group to get members for.

Returns

social_user*

Information on users in the user group. The * notation indicates that there may be zero or more instances of the specified type.

Other related reference items

stingray.Social.create_filtered_social_group()