stingray.Social ネームスペース リファレンス

説明

Xbox One の Social Manager 機能にアクセスするためのインタフェースです。

その他の関連リファレンス項目

Xbox Live

関数

add_local_user_to_graph ( user_id ) SocialMananager にユーザを追加します。

パラメータ

user_id :

integer

ソーシャル ユーザ マネージャの使用を開始するユーザの ID です。

戻り値

この関数は値を返しません。

これを完了してからでないと、ユーザは[stingray.Social.core_social_group]および stingray.Social.create_filtered_social_group を呼び出すことはできません。

ユーザが不要になった場合は、stingray.Social.remove_local_user_from_graph を使用してユーザを SocialManager から除去します。

注: stingray.Social.last_social_events が stingray.SocialEventType.RTA_DISCONNECT_ERR を返す場合、ユーザを SocialManager に追加する必要があります。

その他の関連リファレンス項目

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

create_filtered_social_group ( user_id, presence_filter, relationship_filter ) : integer 指定されたフィルタを使用して、SocialManager にソーシャル グループを追加します。

パラメータ

user_id :	integer	ソーシャル グループのベースとなるユーザの ID です。
presence_filter :	integer	stingray.SocialPresenceFilter 定数のいずれかである必要があります。
relationship_filter :	integer	stingray.SocialRelationshipFilter 定数のいずれかである必要があります。

戻り値

integer

作成されたソーシャル グループの ID です。

グループのメンバーについての情報を取得するには、stingray.Social.social_group を使用します。SocialManager は、ソーシャル グループを非同期で最新状態に保つため、いつでも変更される可能性があります。

呼び出し前に、指定されたユーザが stingray.Social.add_local_user_to_graph を使用して SocialManager に追加されていることを確認してください。ソーシャル グループが使用されなくなった場合、stingray.Social.remove_social_group を使用して除去する必要があります。

注: stingray. ocial.last_social_events が stingray.SocialEventType.RTA_DISCONNECT_ERR を返す場合は、ソーシャル グループを再作成する必要があります。

その他の関連リファレンス項目

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

last_social_events ( ) : integer* この関数が前回呼び出された後に発生したイベントを、SocialManager から返します。

パラメータ

この関数はパラメータを受け入れません。

戻り値

integer*

stingray.SocialEventType 定数のいずれかになります。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

注: stingray.SocialEventType.RTA_DISCONNECT_ERR が返された場合、すべてのユーザを stingray.Social.add_local_user_to_graph を使用して再度追加する必要があり、stingray.Social.create_filtered_social_group を使用して作成されたすべてのソーシャル グループを再作成する必要があります。

その他の関連リファレンス項目

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

remove_local_user_from_graph ( user_id ) SocialManager からユーザを除去します。

パラメータ

user_id :

integer

ソーシャル ユーザ マネージャの使用を停止するユーザの ID です。

戻り値

この関数は値を返しません。

その他の関連リファレンス項目

stingray.Social.add_local_user_to_graph()

remove_social_group ( social_group_id ) SocialManager から、指定したソーシャル グループを除去します。

パラメータ

social_group_id :

integer

除去するソーシャル グループの ID です。

戻り値

この関数は値を返しません。

ソーシャル グループが使用されなくなったとき、そのソーシャル グループを不必要に最新状態に保持することを避けるため、これを呼び出す必要があります。

その他の関連リファレンス項目

stingray.Social.create_filtered_social_group()

social_group ( social_group_id ) : social_user* stingray.Social.create_filtered_social_group を使用して作成された、指定したソーシャル グループを返します。

パラメータ

social_group_id :

integer

メンバーを取得する、ソーシャル グループの ID です。

戻り値

social_user*

ユーザ グループのユーザに関する情報です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。

その他の関連リファレンス項目

stingray.Social.create_filtered_social_group()