SocialService.GetSocialRelationshipsAsync Method

Definition

Namespace:

Microsoft.Xbox.Services.Social

Assembly:

Microsoft.Xbox.Services.dll

Overloads

GetSocialRelationshipsAsync()	Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to. Defaults to filtering to PersonView.All Defaults to startIndex and maxItems of 0 to return entire list if possible
GetSocialRelationshipsAsync(SocialRelationship)	Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to.
GetSocialRelationshipsAsync(String)
GetSocialRelationshipsAsync(SocialRelationship, UInt32, UInt32)	Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to.

GetSocialRelationshipsAsync()

Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to. Defaults to filtering to PersonView.All Defaults to startIndex and maxItems of 0 to return entire list if possible

[Windows.Foundation.Metadata.Overload("GetSocialRelationshipsAsync4")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult> GetSocialRelationshipsAsync ();

abstract member GetSocialRelationshipsAsync : unit -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>
override this.GetSocialRelationshipsAsync : unit -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>

Public Function GetSocialRelationshipsAsync () As IAsyncOperation(Of XboxSocialRelationshipResult)

Returns

Windows.Foundation.IAsyncOperation<XboxSocialRelationshipResult>

An XboxSocialRelationshipResult object.

Implements

Microsoft.Xbox.Services.Social.__ISocialServicePublicNonVirtuals.GetSocialRelationshipsAsync

Attributes

Windows.Foundation.Metadata.OverloadAttribute

Remarks

Calls V1 GET /users/{ownerId}/people?view={view}&startIndex={startIndex}&maxItems={maxItems}

GetSocialRelationshipsAsync(SocialRelationship)

Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to.

[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("GetSocialRelationshipsAsync3")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult> GetSocialRelationshipsAsync (Microsoft.Xbox.Services.Social.SocialRelationship socialRelationshipFilter);

abstract member GetSocialRelationshipsAsync : Microsoft.Xbox.Services.Social.SocialRelationship -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>
override this.GetSocialRelationshipsAsync : Microsoft.Xbox.Services.Social.SocialRelationship -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>

Public Function GetSocialRelationshipsAsync (socialRelationshipFilter As SocialRelationship) As IAsyncOperation(Of XboxSocialRelationshipResult)

Parameters

socialRelationshipFilter

SocialRelationship

Controls how the list is filtered

Returns

Windows.Foundation.IAsyncOperation<XboxSocialRelationshipResult>

An XboxSocialRelationshipResult object.

Implements

Microsoft.Xbox.Services.Social.__ISocialServicePublicNonVirtuals.GetSocialRelationshipsAsync(Microsoft.Xbox.Services.Social.SocialRelationship)

Attributes

Windows.Foundation.Metadata.DefaultOverloadAttribute Windows.Foundation.Metadata.OverloadAttribute

Remarks

Calls V1 GET /users/{ownerId}/people?view={view}&startIndex={startIndex}&maxItems={maxItems}

GetSocialRelationshipsAsync(String)

[Windows.Foundation.Metadata.Overload("GetSocialRelationshipsAsync2")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult> GetSocialRelationshipsAsync (string xboxUserId);

abstract member GetSocialRelationshipsAsync : string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>
override this.GetSocialRelationshipsAsync : string -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>

Public Function GetSocialRelationshipsAsync (xboxUserId As String) As IAsyncOperation(Of XboxSocialRelationshipResult)

Parameters

xboxUserId

String

Returns

Windows.Foundation.IAsyncOperation<XboxSocialRelationshipResult>

Implements

Microsoft.Xbox.Services.Social.__ISocialServicePublicNonVirtuals.GetSocialRelationshipsAsync(System.String)

Attributes

Windows.Foundation.Metadata.OverloadAttribute

GetSocialRelationshipsAsync(SocialRelationship, UInt32, UInt32)

Returns a XboxSocialRelationshipResult containing a the list of people that the user is connected to.

[Windows.Foundation.Metadata.Overload("GetSocialRelationshipsAsync1")]
public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult> GetSocialRelationshipsAsync (Microsoft.Xbox.Services.Social.SocialRelationship socialRelationshipFilter, uint startIndex, uint maxItems);

abstract member GetSocialRelationshipsAsync : Microsoft.Xbox.Services.Social.SocialRelationship * uint32 * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>
override this.GetSocialRelationshipsAsync : Microsoft.Xbox.Services.Social.SocialRelationship * uint32 * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Social.XboxSocialRelationshipResult>

Public Function GetSocialRelationshipsAsync (socialRelationshipFilter As SocialRelationship, startIndex As UInteger, maxItems As UInteger) As IAsyncOperation(Of XboxSocialRelationshipResult)

Parameters

socialRelationshipFilter

SocialRelationship

Controls how the list is filtered

startIndex

UInt32

Controls the starting index to return

maxItems

UInt32

Controls the number of XboxSocialRelationship objects to get. 0 will return as many as possible

Returns

Windows.Foundation.IAsyncOperation<XboxSocialRelationshipResult>

An XboxSocialRelationshipResult object.

Implements

Microsoft.Xbox.Services.Social.__ISocialServicePublicNonVirtuals.GetSocialRelationshipsAsync(Microsoft.Xbox.Services.Social.SocialRelationship,System.UInt32,System.UInt32)

Attributes

Windows.Foundation.Metadata.OverloadAttribute

Remarks

Calls V1 GET /users/{ownerId}/people?view={view}&startIndex={startIndex}&maxItems={maxItems}