Package host.anzo.eossdk.eos.sdk.presence.options

Class EOS_PresenceModification_SetJoinInfoOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.presence.options.EOS_PresenceModification_SetJoinInfoOptions

Direct Known Subclasses:

EOS_PresenceModification_SetJoinInfoOptions.ByReference, EOS_PresenceModification_SetJoinInfoOptions.ByValue

@FieldOrder({"ApiVersion","JoinInfo"})
public class EOS_PresenceModification_SetJoinInfoOptions
extends com.sun.jna.Structure

Data for the EOS_PresenceModification_SetJoinInfo function.

Since:

8/22/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_PresenceModification_SetJoinInfoOptions.ByReference
static class	EOS_PresenceModification_SetJoinInfoOptions.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
int	ApiVersion	API Version: Set this to EOS_PRESENCEMODIFICATION_SETJOININFO_API_LATEST.
static final int	EOS_PRESENCEMODIFICATION_SETJOININFO_API_LATEST	The most recent version of the EOS_PresenceModification_SetJoinInfo API.
String	JoinInfo	The string which will be advertised as this player's join info.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_PresenceModification_SetJoinInfoOptions()
EOS_PresenceModification_SetJoinInfoOptions(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EOS_PRESENCEMODIFICATION_SETJOININFO_API_LATEST

public static final int EOS_PRESENCEMODIFICATION_SETJOININFO_API_LATEST

The most recent version of the EOS_PresenceModification_SetJoinInfo API.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_PRESENCEMODIFICATION_SETJOININFO_API_LATEST.

JoinInfo

public String JoinInfo

The string which will be advertised as this player's join info. An application is expected to freely define the meaning of this string to use for connecting to an active game session. The string should not exceed EOS_PRESENCEMODIFICATION_JOININFO_MAX_LENGTH in length. This affects the ability of the Social Overlay to show game related actions to take in the player's social graph.
The Social Overlay can handle only one of the following three options at a time:

• using the bPresenceEnabled flags within the Sessions interface
• using the bPresenceEnabled flags within the Lobby interface
• using EOS_PresenceModification_SetJoinInfo

See Also:

• EOS_Lobby_CreateLobbyOptions
• EOS_Lobby_JoinLobbyOptions
• EOS_Sessions_CreateSessionModificationOptions
• EOS_Sessions_JoinSessionOptions

Constructor Details

EOS_PresenceModification_SetJoinInfoOptions

public EOS_PresenceModification_SetJoinInfoOptions()

EOS_PresenceModification_SetJoinInfoOptions

public EOS_PresenceModification_SetJoinInfoOptions(com.sun.jna.Pointer peer)