host.anzo.eossdk.eos.sdk.sessions

Class EOS_SessionDetails

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.sessions.EOS_SessionDetails

All Implemented Interfaces:

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

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

This class represents the details of a session, including its session properties and the attribution associated with it Locally created or joined active sessions will contain this information as will search results. A handle to a session is required to join a session via search or invite

Since:

9/5/2023

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
EOS_SessionDetails_Info	copyInfo(EOS_SessionDetails_CopyInfoOptions options) EOS_SessionDetails_CopyInfo is used to immediately retrieve a copy of session information from a given source such as a active session or a search result.
EOS_SessionDetails_Attribute	copySessionAttributeByIndex(EOS_SessionDetails_CopySessionAttributeByIndexOptions options) EOS_SessionDetails_CopySessionAttributeByIndex is used to immediately retrieve a copy of session attribution from a given source such as an active session or a search result.
EOS_SessionDetails_Attribute	copySessionAttributeByKey(EOS_SessionDetails_CopySessionAttributeByKeyOptions options) EOS_SessionDetails_CopySessionAttributeByKey is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result.
int	getSessionAttributeCount(EOS_SessionDetails_GetSessionAttributeCountOptions options) Get the number of attributes associated with this session
void	release() Release the memory associated with a single 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_SessionDetails

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

EOS_SessionDetails

public EOS_SessionDetails()

Method Detail

copyInfo

public EOS_SessionDetails_Info copyInfo(EOS_SessionDetails_CopyInfoOptions options)
                                 throws EOSException

EOS_SessionDetails_CopyInfo is used to immediately retrieve a copy of session information from a given source such as a active session or a search result. If the call returns an EOS_Success result, the out parameter, OutSessionInfo, must be passed to EOS_SessionDetails_Info_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

Returns:

Out parameter used to receive the EOS_SessionDetails_Info structure.

Throws:

EOSInvalidParametersException - if the information is available and passed out in outSessionInfo

EOSIncompatibleVersionException - if the API version passed in is incorrect

EOSException

See Also:

EOS_SessionDetails_Info, EOS_SessionDetails_CopyInfoOptions, EOS_SessionDetails_Info.release()

getSessionAttributeCount

public int getSessionAttributeCount(EOS_SessionDetails_GetSessionAttributeCountOptions options)

Get the number of attributes associated with this session

Parameters:

options - the options associated with retrieving the attribute count

Returns:

number of attributes on the session or 0 if there is an error

copySessionAttributeByIndex

public EOS_SessionDetails_Attribute copySessionAttributeByIndex(EOS_SessionDetails_CopySessionAttributeByIndexOptions options)
                                                         throws EOSException

EOS_SessionDetails_CopySessionAttributeByIndex is used to immediately retrieve a copy of session attribution from a given source such as an active session or a search result. If the call returns an EOS_Success result, the out parameter, outSessionAttribute, must be passed to EOS_SessionDetails_Attribute_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

Returns:

Out parameter used to receive the EOS_SessionDetails_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_SessionDetails_Attribute, EOS_SessionDetails_CopySessionAttributeByIndexOptions, EOS_SessionDetails_Attribute.release()

copySessionAttributeByKey

public EOS_SessionDetails_Attribute copySessionAttributeByKey(EOS_SessionDetails_CopySessionAttributeByKeyOptions options)
                                                       throws EOSException

EOS_SessionDetails_CopySessionAttributeByKey is used to immediately retrieve a copy of session attribution from a given source such as a active session or a search result. If the call returns an EOS_Success result, the out parameter, OutSessionAttribute, must be passed to EOS_SessionDetails_Attribute_Release to release the memory associated with it.

Parameters:

options - Structure containing the input parameters

Returns:

Out parameter used to receive the EOS_SessionDetails_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_SessionDetails_Attribute, EOS_SessionDetails_CopySessionAttributeByKeyOptions, EOS_SessionDetails_Attribute.release()

release

public void release()

Release the memory associated with a single session. This must be called on data retrieved from EOS_SessionSearch_CopySearchResultByIndex.

See Also:

EOS_SessionSearch.copySearchResultByIndex(EOS_SessionSearch_CopySearchResultByIndexOptions, EOS_SessionDetails)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception