EOS_Lobby_PromoteMember

EOS API reference page for EOS_Lobby_PromoteMember

Choose your implementation method:

C

C#

This function is part of the Lobby Interface.

Remarks

Promote an existing member of the lobby to owner, allowing them to make lobby data modifications

Return Value

  • EOS_Success if the promote completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Lobby_NotOwner if the calling user is not the owner of the lobby

  • EOS_NotFound if the lobby of interest does not exist

Parameters

EOS_Lobby_PromoteMember

Parameter Type And Name

Usage Information

EOS_HLobby Handle

const EOS_Lobby_PromoteMemberOptions* Options

Structure containing information about the lobby and member to be promoted

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Lobby_OnPromoteMemberCallback CompletionDelegate

A callback that is fired when the promotion operation completes, either successfully or in 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_Lobby_OnPromoteMemberCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Lobby_PromoteMember

Callback Parameters

EOS_Lobby_OnPromoteMemberCallback

Parameter Type And Name

Usage Information

const EOS_Lobby_PromoteMemberCallbackInfo* Data

A EOS_Lobby_PromoteMember CallbackInfo containing the output information and result

Related API Members

This function is part of the Lobby Interface.

Remarks

Promote an existing member of the lobby to owner, allowing them to make lobby data modifications {Result.InvalidParameters} if any of the options are incorrect {Result.LobbyNotOwner} if the calling user is not the owner of the lobby {Result.NotFound} if the lobby of interest does not exist

Return Value

{Result.Success} if the promote completes successfully

Parameters

Lobby.LobbyInterface.PromoteMember

Parameter Type And Name

Usage Information

PromoteMemberOptions options

Structure containing information about the lobby and member to be promoted

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnPromoteMemberCallback completionDelegate

A callback that is fired when the promotion operation completes, either successfully or in 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 Lobby.OnPromoteMemberCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {LobbyInterface.PromoteMember}

Callback Parameters

Lobby.OnPromoteMemberCallback

Parameter Type And Name

Usage Information

PromoteMemberCallbackInfo data

A EOS_Lobby_PromoteMember CallbackInfo containing the output information and result

Related API Members

Tags