public class EOS_SessionSearch
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable
| Constructor and Description |
|---|
EOS_SessionSearch() |
EOS_SessionSearch(com.sun.jna.Pointer address) |
| Modifier and Type | Method and Description |
|---|---|
void |
close() |
EOS_EResult |
copySearchResultByIndex(EOS_SessionSearch_CopySearchResultByIndexOptions options,
EOS_SessionDetails outSessionHandle)
EOS_SessionSearch_CopySearchResultByIndex is used to immediately retrieve a handle to the session information from a given search result.
|
void |
find(EOS_SessionSearch_FindOptions options,
com.sun.jna.Pointer clientData,
EOS_SessionSearch_OnFindCallback completionDelegate)
Find sessions matching the search criteria setup via this session search handle.
|
int |
getSearchResultCount(EOS_SessionSearch_GetSearchResultCountOptions options)
Get the number of search results found by the search parameters in this search
|
void |
release()
Release the memory associated with a session search.
|
EOS_EResult |
removeParameter(EOS_SessionSearch_RemoveParameterOptions options)
Remove a parameter from the array of search criteria.
|
EOS_EResult |
setMaxResults(EOS_SessionSearch_SetMaxResultsOptions options)
Set the maximum number of search results to return in the query, can't be more than
EOS_SessionSearch_SetMaxResultsOptions.EOS_SESSIONS_MAX_SEARCH_RESULTS |
EOS_EResult |
setParameter(EOS_SessionSearch_SetParameterOptions options)
Add a parameter to an array of search criteria combined via an implicit AND operator.
|
EOS_EResult |
setSessionId(EOS_SessionSearch_SetSessionIdOptions options)
Set a session ID to find and will return at most one search result.
|
EOS_EResult |
setTargetUserId(EOS_SessionSearch_SetTargetUserIdOptions options)
Set a target user ID to find and will return at most one search result.
|
public EOS_SessionSearch(com.sun.jna.Pointer address)
public EOS_SessionSearch()
public EOS_EResult setSessionId(EOS_SessionSearch_SetSessionIdOptions options)
options - A specific session ID for which to searchEOS_EResult.EOS_Success if setting this session ID was successfulEOS_EResult.EOS_InvalidParameters if the session ID is invalid or nullEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectpublic EOS_EResult setTargetUserId(EOS_SessionSearch_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_SessionSearch_SetParameterOptions options)
options - a search parameter and its comparison opEOS_EResult.EOS_Success if setting this search parameter was successfulEOS_EResult.EOS_InvalidParameters if the search criteria is invalid or nullEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectEOS_Sessions_AttributeData,
EOS_EComparisonOppublic EOS_EResult removeParameter(EOS_SessionSearch_RemoveParameterOptions options)
options - a search parameter key name to removeEOS_EResult.EOS_Success if removing this search parameter was successfulEOS_EResult.EOS_InvalidParameters if the search key is invalid or nullEOS_EResult.EOS_NotFound if the parameter was not a part of the search criteriaEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectpublic EOS_EResult setMaxResults(EOS_SessionSearch_SetMaxResultsOptions options)
EOS_SessionSearch_SetMaxResultsOptions.EOS_SESSIONS_MAX_SEARCH_RESULTSoptions - maximum number of search results to return in the queryEOS_EResult.EOS_Success if setting the max results was successfulEOS_EResult.EOS_InvalidParameters if the number of results requested is invalidEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectpublic void find(EOS_SessionSearch_FindOptions options, com.sun.jna.Pointer clientData, EOS_SessionSearch_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 int getSearchResultCount(EOS_SessionSearch_GetSearchResultCountOptions options)
options - Options associated with the search countpublic EOS_EResult copySearchResultByIndex(EOS_SessionSearch_CopySearchResultByIndexOptions options, EOS_SessionDetails outSessionHandle)
options - Structure containing the input parametersoutSessionHandle - out parameter used to receive the session handleEOS_EResult.EOS_Success if the information is available and passed out in OutSessionHandleEOS_EResult.EOS_InvalidParameters if you pass an invalid index or a null pointer for the out parameterEOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrectEOS_SessionSearch_CopySearchResultByIndexOptions,
EOS_SessionDetails.release()public void release()
public void close()
throws java.lang.Exception
close in interface java.lang.AutoCloseablejava.lang.Exception