public class EOS_LobbySearch
extends com.sun.jna.PointerType
| Constructor and Description |
|---|
EOS_LobbySearch() |
EOS_LobbySearch(com.sun.jna.Pointer address) |
| 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.
|
public EOS_LobbySearch(com.sun.jna.Pointer address)
public EOS_LobbySearch()
public void find(EOS_LobbySearch_FindOptions options, com.sun.jna.Pointer clientData, EOS_LobbySearch_OnFindCallback completionDelegate)
options - Structure containing information about the search criteria to useclientData - Arbitrary data that is passed back to you in the CompletionDelegatecompletionDelegate - A callback that is fired when the search operation completes, either successfully or in errorpublic EOS_EResult setLobbyId(EOS_LobbySearch_SetLobbyIdOptions options)
options - A specific lobby ID for which to searchEOS_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 incorrectpublic EOS_EResult setTargetUserId(EOS_LobbySearch_SetTargetUserIdOptions options)
options - a specific target user ID to findEOS_EResult.EOS_Success if setting this target user ID was successfulEOS_EResult.EOS_InvalidParameters if the target user ID is invalid or nullEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectpublic EOS_EResult setParameter(EOS_LobbySearch_SetParameterOptions options)
options - a search parameter and its comparison opEOS_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 incorrectEOS_Lobby_AttributeData,
EOS_EComparisonOppublic EOS_EResult removeParameter(EOS_LobbySearch_RemoveParameterOptions options)
options - a search parameter key name to removeEOS_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 incorrectpublic EOS_EResult setMaxResults(EOS_LobbySearch_SetMaxResultsOptions options)
options - maximum number of search results to return in the queryEOS_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 incorrectpublic int getSearchResultCount(EOS_LobbySearch_GetSearchResultCountOptions options)
options - Options associated with the search countpublic EOS_EResult copySearchResultByIndex(EOS_LobbySearch_CopySearchResultByIndexOptions options, EOS_LobbyDetails outLobbyDetailsHandle)
options - Structure containing the input parametersoutLobbyDetailsHandle - out parameter used to receive the lobby details handleEOS_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 incorrectEOS_LobbySearch_CopySearchResultByIndexOptions,
EOS_LobbyDetails.release()