EOS_UI_ShowFriends

EOS API reference page for EOS_UI_ShowFriends

Choose your implementation method:

C

C#

This function is part of the UI Interface.

Remarks

Opens the Social Overlay with a request to show the friends list.

Return Value

  • EOS_Success If the Social Overlay has been notified about the request.

  • EOS_InvalidParameters If any of the options are incorrect.

  • EOS_NotConfigured If the Social Overlay is not properly configured.

  • EOS_NoChange If the Social Overlay is already visible.

Parameters

EOS_UI_ShowFriends

Parameter Type And Name

Usage Information

EOS_HUI Handle

const EOS_UI_ShowFriendsOptions* Options

Structure containing the Epic Account ID of the friends list to show.

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate.

const EOS_UI_OnShowFriendsCallback CompletionDelegate

A callback that is fired when the request to show the friends list has been sent to the Social Overlay, or on an error.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_UI_OnShowFriendsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_UI_ShowFriends

Callback Parameters

EOS_UI_OnShowFriendsCallback

Parameter Type And Name

Usage Information

const EOS_UI_ShowFriendsCallbackInfo* Data

A EOS_UI_ShowFriendsCallbackInfo containing the output information and result

Related API Members

This function is part of the UI Interface.

Remarks

Opens the Social Overlay with a request to show the friends list. {Result.InvalidParameters} If any of the options are incorrect. {Result.NotConfigured} If the Social Overlay is not properly configured. {Result.NoChange} If the Social Overlay is already visible.

Return Value

{Result.Success} If the Social Overlay has been notified about the request.

Parameters

UI.UIInterface.ShowFriends

Parameter Type And Name

Usage Information

ShowFriendsOptions options

Structure containing the Epic Account ID of the friends list to show.

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate.

OnShowFriendsCallback completionDelegate

A callback that is fired when the request to show the friends list has been sent to the Social Overlay, or on an error.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type UI.OnShowFriendsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {UIInterface.ShowFriends}

Callback Parameters

UI.OnShowFriendsCallback

Parameter Type And Name

Usage Information

ShowFriendsCallbackInfo data

A EOS_UI_ShowFriendsCallbackInfo containing the output information and result

Related API Members

Tags