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, java.lang.AutoCloseable

public class EOS_LobbyDetails
extends com.sun.jna.PointerType
implements java.lang.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

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
EOS_Lobby_Attribute	copyAttributeByIndex(EOS_LobbyDetails_CopyAttributeByIndexOptions options) 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_Lobby_Attribute	copyAttributeByKey(EOS_LobbyDetails_CopyAttributeByKeyOptions options) 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.
EOS_LobbyDetails_Info	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_Lobby_Attribute	copyMemberAttributeByIndex(EOS_LobbyDetails_CopyMemberAttributeByIndexOptions options) EOS_LobbyDetails_CopyMemberAttributeByIndex is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
EOS_Lobby_Attribute	copyMemberAttributeByKey(EOS_LobbyDetails_CopyMemberAttributeByKeyOptions options) EOS_LobbyDetails_CopyMemberAttributeByKey is used to immediately retrieve a copy of a lobby member attribute from an existing lobby.
EOS_LobbyDetails_MemberInfo	copyMemberInfo(EOS_LobbyDetails_CopyMemberInfoOptions options) EOS_LobbyDetails_CopyMemberInfo is used to immediately retrieve a copy of lobby member information from an existing lobby.
int	getAttributeCount(EOS_LobbyDetails_GetAttributeCountOptions options) Get the number of attributes associated with this lobby
EOS_ProductUserId	getLobbyOwner(EOS_LobbyDetails_GetLobbyOwnerOptions options) Get the product user ID of the current owner for a given lobby
int	getMemberAttributeCount(EOS_LobbyDetails_GetMemberAttributeCountOptions options) EOS_LobbyDetails_GetMemberAttributeCount is used to immediately retrieve the attribute count for members in a lobby.
EOS_ProductUserId	getMemberByIndex(EOS_LobbyDetails_GetMemberByIndexOptions options) EOS_LobbyDetails_GetMemberByIndex is used to immediately retrieve individual members registered with a lobby.
int	getMemberCount(EOS_LobbyDetails_GetMemberCountOptions options) Get the number of members associated with this lobby
void	release()

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_LobbyDetails

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

EOS_LobbyDetails

public EOS_LobbyDetails()

Method Detail

getLobbyOwner

public EOS_ProductUserId getLobbyOwner(EOS_LobbyDetails_GetLobbyOwnerOptions options)

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

public EOS_LobbyDetails_Info copyInfo(EOS_LobbyDetails_CopyInfoOptions options)
                               throws EOSException

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 parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_LobbyDetails_Info, EOS_LobbyDetails_CopyInfoOptions, release()

copyMemberInfo

public EOS_LobbyDetails_MemberInfo copyMemberInfo(EOS_LobbyDetails_CopyMemberInfoOptions options)
                                           throws EOSException

EOS_LobbyDetails_CopyMemberInfo is used to immediately retrieve a copy of lobby member information from an existing lobby.
If the call returns an EOS_Success result, the out parameter, OutLobbyDetailsMemberInfo, must be passed to EOS_LobbyDetails_MemberInfo.release() to release the memory associated with it.
Note: this information is only available if you are actively in the lobby. It is not available for search results.

Parameters:

options - Structure containing the input parameters

Returns:

EOS_EResult.EOS_Success if the information is available and passed out in OutLobbyMemberDetailsInfo
EOS_EResult.EOS_InvalidParameters if you pass a null pointer for the out parameter
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
if searching for a target user ID returns no results

Throws:

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_LobbyDetails_MemberInfo, EOS_LobbyDetails_CopyMemberInfoOptions, EOS_LobbyDetails_MemberInfo.release()

getAttributeCount

public int getAttributeCount(EOS_LobbyDetails_GetAttributeCountOptions options)

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 parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_Lobby_Attribute, EOS_LobbyDetails_CopyAttributeByIndexOptions, release()

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 parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_Lobby_Attribute, EOS_LobbyDetails_CopyAttributeByKeyOptions, release()

getMemberCount

public int getMemberCount(EOS_LobbyDetails_GetMemberCountOptions options)

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

public EOS_ProductUserId getMemberByIndex(EOS_LobbyDetails_GetMemberByIndexOptions options)

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:

getMemberCount(EOS_LobbyDetails_GetMemberCountOptions), EOS_LobbyDetails_GetMemberByIndexOptions

getMemberAttributeCount

public int getMemberAttributeCount(EOS_LobbyDetails_GetMemberAttributeCountOptions options)

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:

getMemberCount(EOS_LobbyDetails_GetMemberCountOptions), EOS_LobbyDetails_GetMemberAttributeCountOptions

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 parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_Lobby_Attribute, EOS_LobbyDetails_CopyMemberAttributeByIndexOptions, release()

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 parameter

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_Lobby_Attribute, EOS_LobbyDetails_CopyMemberAttributeByKeyOptions, release()

release

public void release()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception