Package host.anzo.eossdk.eos.sdk.lobby
Class EOS_LobbyDetails
java.lang.Object
com.sun.jna.PointerType
host.anzo.eossdk.eos.sdk.lobby.EOS_LobbyDetails
- All Implemented Interfaces:
com.sun.jna.NativeMapped
,AutoCloseable
A "read only" representation of an existing lobby that games interact with externally.
Both the lobby and lobby search interfaces use this common class for lobby management and search results
- Since:
- 8/16/2023
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
EOS_LobbyDetails_CopyAttributeByIndex is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.EOS_LobbyDetails_CopyAttributeByKey is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result.copyInfo
(EOS_LobbyDetails_CopyInfoOptions options) EOS_LobbyDetails_CopyInfo is used to immediately retrieve a copy of lobby information from a given source such as a existing lobby or a search result.EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.int
Get the number of attributes associated with this lobbyGet the product user ID of the current owner for a given lobbyint
EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.int
Get the number of members associated with this lobbyvoid
release()
Methods inherited from class com.sun.jna.PointerType
equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString
-
Constructor Details
-
EOS_LobbyDetails
public EOS_LobbyDetails(com.sun.jna.Pointer address) -
EOS_LobbyDetails
public EOS_LobbyDetails()
-
-
Method Details
-
getLobbyOwner
Get the product user ID of the current owner for a given lobby- Parameters:
options
- Structure containing the input parameters- Returns:
- the product user ID for the lobby owner or null if the input parameters are invalid
-
copyInfo
EOS_LobbyDetails_CopyInfo is used to immediately retrieve a copy of lobby information from a given source such as a existing lobby or a search result. If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsInfo, must be passed to EOS_LobbyDetails_Info_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_LobbyDetails_Info structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
getAttributeCount
Get the number of attributes associated with this lobby- Parameters:
options
- the Options associated with retrieving the attribute count- Returns:
- number of attributes on the lobby or 0 if there is an error
-
copyAttributeByIndex
public EOS_Lobby_Attribute copyAttributeByIndex(EOS_LobbyDetails_CopyAttributeByIndexOptions options) throws EOSException EOS_LobbyDetails_CopyAttributeByIndex is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result. If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_Lobby_Attribute structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
copyAttributeByKey
public EOS_Lobby_Attribute copyAttributeByKey(EOS_LobbyDetails_CopyAttributeByKeyOptions options) throws EOSException EOS_LobbyDetails_CopyAttributeByKey is used to immediately retrieve a copy of a lobby attribute from a given source such as a existing lobby or a search result. If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_Lobby_Attribute structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
getMemberCount
Get the number of members associated with this lobby- Parameters:
options
- the Options associated with retrieving the member count- Returns:
- number of members in the existing lobby or 0 if there is an error
-
getMemberByIndex
EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.- Parameters:
options
- Structure containing the input parameters- Returns:
- the product user ID for the registered member at a given index or null if that index is invalid
- See Also:
-
getMemberAttributeCount
EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.- Parameters:
options
- Structure containing the input parameters- Returns:
- the number of attributes associated with a given lobby member or 0 if that member is invalid
- See Also:
-
copyMemberAttributeByIndex
public EOS_Lobby_Attribute copyMemberAttributeByIndex(EOS_LobbyDetails_CopyMemberAttributeByIndexOptions options) throws EOSException EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby. If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_Lobby_Attribute structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
copyMemberAttributeByKey
public EOS_Lobby_Attribute copyMemberAttributeByKey(EOS_LobbyDetails_CopyMemberAttributeByKeyOptions options) throws EOSException EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby. If the call returns an EOS_Success result, the out parameter, OutAttribute, must be passed to EOS_Lobby_Attribute_Release to release the memory associated with it.- Parameters:
options
- Structure containing the input parameters- Returns:
- Out parameter used to receive the EOS_Lobby_Attribute structure.
- Throws:
EOSInvalidParametersException
- if you pass a null pointer for the out parameterEOSIncompatibleVersionException
- if the API version passed in is incorrectEOSException
- See Also:
-
release
public void release() -
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-