Package host.anzo.eossdk.eos.sdk.rtcadmin

Class EOS_RTCAdmin_UserToken

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtcadmin.EOS_RTCAdmin_UserToken

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

EOS_RTCAdmin_UserToken.ByReference, EOS_RTCAdmin_UserToken.ByValue

@FieldOrder({"ApiVersion","ProductUserId","Token"})
public class EOS_RTCAdmin_UserToken
extends com.sun.jna.Structure
implements AutoCloseable

Contains information about a collection of user tokens for joining a room.

Since:

11/01/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_RTCAdmin_UserToken.ByReference
static class	EOS_RTCAdmin_UserToken.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_RTCADMIN_USERTOKEN_API_LATEST.
static final int	EOS_RTCADMIN_USERTOKEN_API_LATEST	The most recent version of the EOS_RTCAdmin_UserToken struct.
EOS_ProductUserId	ProductUserId	The Product User ID for the user who owns this user token.
String	Token	Access token to enable a user to join a room

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
void	release()	Release the memory associated with EOS_RTCAdmin_UserToken.

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_RTCADMIN_USERTOKEN_API_LATEST

public static final int EOS_RTCADMIN_USERTOKEN_API_LATEST

The most recent version of the EOS_RTCAdmin_UserToken struct.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_RTCADMIN_USERTOKEN_API_LATEST.

ProductUserId

public EOS_ProductUserId ProductUserId

The Product User ID for the user who owns this user token.

Token

public String Token

Access token to enable a user to join a room

Constructor Details

EOS_RTCAdmin_UserToken

public EOS_RTCAdmin_UserToken()

EOS_RTCAdmin_UserToken

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

Method Details

release

public void release()

Release the memory associated with EOS_RTCAdmin_UserToken. This must be called on data retrieved from EOS_RTCAdmin_CopyUserTokenByIndex or EOS_RTCAdmin_CopyUserTokenByUserId.

See Also:

• EOS_RTCAdmin_UserToken
• EOS_RTC_Admin_Interface.copyUserTokenByIndex(EOS_RTCAdmin_CopyUserTokenByIndexOptions)
• EOS_RTC_Admin_Interface.copyUserTokenByUserId(EOS_RTCAdmin_CopyUserTokenByUserIdOptions)

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception