host.anzo.eossdk.eos.sdk.sessions

Class EOS_SessionModification

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.sessions.EOS_SessionModification

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.lang.AutoCloseable

public class EOS_SessionModification
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable

To modify sessions, you must call EOS_Sessions_CreateSessionModification to create a Session Modification handle. To modify that handle, call EOS_HSessionModification methods. Once you are finished, call EOS_Sessions_UpdateSession with your handle. You must then release your Session Modification handle by calling EOS_SessionModification_Release.

Since:

9/5/2023

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EOS_EResult	addAttribute(EOS_SessionModification_AddAttributeOptions options) Associate an attribute with this session An attribute is something that may or may not be advertised with the session.
void	close()
void	release() Release the memory associated with session modification.
EOS_EResult	removeAttribute(EOS_SessionModification_RemoveAttributeOptions options) Remove an attribute from this session
EOS_EResult	setAllowedPlatformIds(EOS_SessionModification_SetAllowedPlatformIdsOptions options) Set the Allowed Platform IDs for the session.
EOS_EResult	setBucketId(EOS_SessionModification_SetBucketIdOptions options) Set the bucket ID associated with this session.
EOS_EResult	setHostAddress(EOS_SessionModification_SetHostAddressOptions options) Set the host address associated with this session Setting this is optional, if the value is not set the SDK will fill the value in from the service.
EOS_EResult	setInvitesAllowed(EOS_SessionModification_SetInvitesAllowedOptions options) Allows enabling or disabling invites for this session.
EOS_EResult	setJoinInProgressAllowed(EOS_SessionModification_SetJoinInProgressAllowedOptions options) Set whether or not join in progress is allowed Once a session is started, it will no longer be visible to search queries unless this flag is set or the session returns to the pending or ended state
EOS_EResult	setMaxPlayers(EOS_SessionModification_SetMaxPlayersOptions options) Set the maximum number of players allowed in this session.
EOS_EResult	setPermissionLevel(EOS_SessionModification_SetPermissionLevelOptions options) Set the session permissions associated with this session.

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_SessionModification

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

EOS_SessionModification

public EOS_SessionModification()

Method Detail

setBucketId

public EOS_EResult setBucketId(EOS_SessionModification_SetBucketIdOptions options)

Set the bucket ID associated with this session. Values such as region, game mode, etc can be combined here depending on game need. Setting this is strongly recommended to improve search performance.

Parameters:

options - Options associated with the bucket ID of the session

Returns:

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

setHostAddress

public EOS_EResult setHostAddress(EOS_SessionModification_SetHostAddressOptions options)

Set the host address associated with this session Setting this is optional, if the value is not set the SDK will fill the value in from the service. It is useful to set if other addressing mechanisms are desired or if LAN addresses are preferred during development
No validation of this value occurs to allow for flexibility in addressing methods

Parameters:

options - Options associated with the host address of the session

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_InvalidParameters if the host ID is an empty string
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setPermissionLevel

public EOS_EResult setPermissionLevel(EOS_SessionModification_SetPermissionLevelOptions options)

Set the session permissions associated with this session. The permissions range from "public" to "invite only" and are described by EOS_EOnlineSessionPermissionLevel

Parameters:

options - Options associated with the permission level of the session

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setJoinInProgressAllowed

public EOS_EResult setJoinInProgressAllowed(EOS_SessionModification_SetJoinInProgressAllowedOptions options)

Set whether or not join in progress is allowed Once a session is started, it will no longer be visible to search queries unless this flag is set or the session returns to the pending or ended state

Parameters:

options - Options associated with setting the join in progress state the session

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setMaxPlayers

public EOS_EResult setMaxPlayers(EOS_SessionModification_SetMaxPlayersOptions options)

Set the maximum number of players allowed in this session. When updating the session, it is not possible to reduce this number below the current number of existing players

Parameters:

options - Options associated with max number of players in this session

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setInvitesAllowed

public EOS_EResult setInvitesAllowed(EOS_SessionModification_SetInvitesAllowedOptions options)

Allows enabling or disabling invites for this session. The session will also need to have `bPresenceEnabled` true.

Parameters:

options - Options associated with invites allowed flag for this session.

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

setAllowedPlatformIds

public EOS_EResult setAllowedPlatformIds(EOS_SessionModification_SetAllowedPlatformIdsOptions options)

Set the Allowed Platform IDs for the session.

Parameters:

options - Options associated with allowed Platform IDs for this session.

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect
EOS_EResult.EOS_InvalidParameters if the attribution is missing information or otherwise invalid

addAttribute

public EOS_EResult addAttribute(EOS_SessionModification_AddAttributeOptions options)

Associate an attribute with this session An attribute is something that may or may not be advertised with the session. If advertised, it can be queried for in a search, otherwise the data remains local to the client

Parameters:

options - Options to set the attribute and its advertised state

Returns:

EOS_EResult.EOS_Success if setting this parameter was successful
EOS_EResult.EOS_InvalidParameters if the attribution is missing information or otherwise invalid
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

removeAttribute

public EOS_EResult removeAttribute(EOS_SessionModification_RemoveAttributeOptions options)

Remove an attribute from this session

Parameters:

options - Specify the key of the attribute to remove

Returns:

EOS_EResult.EOS_Success if removing this parameter was successful
EOS_EResult.EOS_InvalidParameters if the key is null or empty
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect

release

public void release()

Release the memory associated with session modification. This must be called on data retrieved from EOS_Sessions_CreateSessionModification or EOS_Sessions_UpdateSessionModification

See Also:

EOS_Sessions_Interface.createSessionModification(EOS_Sessions_CreateSessionModificationOptions, EOS_SessionModification), EOS_Sessions_Interface.updateSessionModification(EOS_Sessions_UpdateSessionModificationOptions, EOS_SessionModification)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception