host.anzo.eossdk.eos.sdk.lobby

Class EOS_LobbySearch

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.lobby.EOS_LobbySearch

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_LobbySearch
extends com.sun.jna.PointerType

Class responsible for the creation, setup, and execution of a search query. Search parameters are defined, the query is executed and the search results are returned within this object

Since:

8/16/2023

Constructor Summary

Constructors

Constructor and Description
EOS_LobbySearch()
EOS_LobbySearch(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_EResult	copySearchResultByIndex(EOS_LobbySearch_CopySearchResultByIndexOptions options, EOS_LobbyDetails outLobbyDetailsHandle) EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result.
void	find(EOS_LobbySearch_FindOptions options, com.sun.jna.Pointer clientData, EOS_LobbySearch_OnFindCallback completionDelegate) Find lobbies matching the search criteria setup via this lobby search handle.
int	getSearchResultCount(EOS_LobbySearch_GetSearchResultCountOptions options) Get the number of search results found by the search parameters in this search
EOS_EResult	removeParameter(EOS_LobbySearch_RemoveParameterOptions options) Remove a parameter from the array of search criteria.
EOS_EResult	setLobbyId(EOS_LobbySearch_SetLobbyIdOptions options) Set a lobby ID to find and will return at most one search result.
EOS_EResult	setMaxResults(EOS_LobbySearch_SetMaxResultsOptions options) Set the maximum number of search results to return in the query, can't be more than EOS_LOBBY_MAX_SEARCH_RESULTS
EOS_EResult	setParameter(EOS_LobbySearch_SetParameterOptions options) Add a parameter to an array of search criteria combined via an implicit AND operator.
EOS_EResult	setTargetUserId(EOS_LobbySearch_SetTargetUserIdOptions options) Set a target user ID to find.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_LobbySearch

public EOS_LobbySearch(com.sun.jna.Pointer address)

EOS_LobbySearch

public EOS_LobbySearch()

Method Detail

find

public void find(EOS_LobbySearch_FindOptions options,
                 com.sun.jna.Pointer clientData,
                 EOS_LobbySearch_OnFindCallback completionDelegate)

Find lobbies matching the search criteria setup via this lobby search handle. When the operation completes, this handle will have the search results that can be parsed

Parameters:

options - Structure containing information about the search criteria to use

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the search operation completes, either successfully or in error

setLobbyId

public EOS_EResult setLobbyId(EOS_LobbySearch_SetLobbyIdOptions options)

Set a lobby ID to find and will return at most one search result. Setting TargetUserId or SearchParameters will result in EOS_LobbySearch_Find failing

Parameters:

options - A specific lobby ID for which to search

Returns:

EOS_EResult.EOS_Success if setting this lobby ID was successful EOS_EResult.EOS_InvalidParameters if the lobby ID is invalid or null EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setTargetUserId

public EOS_EResult setTargetUserId(EOS_LobbySearch_SetTargetUserIdOptions options)

Set a target user ID to find. Setting LobbyId or SearchParameters will result in EOS_LobbySearch_Find failing
A search result will only be found if this user is in a public lobby

Parameters:

options - a specific target user ID to find

Returns:

EOS_EResult.EOS_Success if setting this target user ID was successful
EOS_EResult.EOS_InvalidParameters if the target user ID is invalid or null
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setParameter

public EOS_EResult setParameter(EOS_LobbySearch_SetParameterOptions options)

Add a parameter to an array of search criteria combined via an implicit AND operator. Setting LobbyId or TargetUserId will result in EOS_LobbySearch_Find failing

Parameters:

options - a search parameter and its comparison op

Returns:

EOS_EResult.EOS_Success if setting this search parameter was successful EOS_EResult.EOS_InvalidParameters if the search criteria is invalid or null EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

See Also:

EOS_Lobby_AttributeData, EOS_EComparisonOp

removeParameter

public EOS_EResult removeParameter(EOS_LobbySearch_RemoveParameterOptions options)

Remove a parameter from the array of search criteria.

Parameters:

options - a search parameter key name to remove

Returns:

EOS_EResult.EOS_Success if removing this search parameter was successful EOS_EResult.EOS_InvalidParameters if the search key is invalid or null EOS_EResult.EOS_NotFound if the parameter was not a part of the search criteria EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setMaxResults

public EOS_EResult setMaxResults(EOS_LobbySearch_SetMaxResultsOptions options)

Set the maximum number of search results to return in the query, can't be more than EOS_LOBBY_MAX_SEARCH_RESULTS

Parameters:

options - maximum number of search results to return in the query

Returns:

EOS_EResult.EOS_Success if setting the max results was successful EOS_EResult.EOS_InvalidParameters if the number of results requested is invalid EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

getSearchResultCount

public int getSearchResultCount(EOS_LobbySearch_GetSearchResultCountOptions options)

Get the number of search results found by the search parameters in this search

Parameters:

options - Options associated with the search count

Returns:

return the number of search results found by the query or 0 if search is not complete

copySearchResultByIndex

public EOS_EResult copySearchResultByIndex(EOS_LobbySearch_CopySearchResultByIndexOptions options,
                                           EOS_LobbyDetails outLobbyDetailsHandle)

EOS_LobbySearch_CopySearchResultByIndex is used to immediately retrieve a handle to the lobby information from a given search result. If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsHandle, must be passed to EOS_LobbyDetails_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

outLobbyDetailsHandle - out parameter used to receive the lobby details handle

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutLobbyDetailsHandle EOS_EResult.EOS_InvalidParameters if you pass an invalid index or a null pointer for the out parameter EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

See Also:

EOS_LobbySearch_CopySearchResultByIndexOptions, EOS_LobbyDetails.release()