host.anzo.eossdk.eos.sdk.rtcadmin.options

Class EOS_RTCAdmin_QueryJoinRoomTokenOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtcadmin.options.EOS_RTCAdmin_QueryJoinRoomTokenOptions

Direct Known Subclasses:

EOS_RTCAdmin_QueryJoinRoomTokenOptions.ByReference, EOS_RTCAdmin_QueryJoinRoomTokenOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","LocalUserId","RoomName","TargetUserIds","TargetUserIdsCount","TargetUserIpAddresses"})
public class EOS_RTCAdmin_QueryJoinRoomTokenOptions
extends com.sun.jna.Structure

Input parameters for the EOS_RTCAdmin_QueryJoinRoomToken function.

Since:

11/01/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_RTCAdmin_QueryJoinRoomTokenOptions.ByReference
static class	EOS_RTCAdmin_QueryJoinRoomTokenOptions.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 and Description
int	ApiVersion API Version: Set this to EOS_RTCADMIN_QUERYJOINROOMTOKEN_API_LATEST.
static int	EOS_RTCADMIN_QUERYJOINROOMTOKEN_API_LATEST The most recent version of the EOS_RTCAdmin_QueryJoinRoomToken API
EOS_ProductUserId	LocalUserId Product User ID for local user who is querying join room tokens.
java.lang.String	RoomName Room name to request a token for.
EOS_ProductUserId	TargetUserIds An array of Product User IDs indicating the users to retrieve a token for.
int	TargetUserIdsCount The number of users included in the query.
com.sun.jna.StringArray	TargetUserIpAddresses Array of IP Addresses, one for each of the users we're querying tokens for.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_RTCAdmin_QueryJoinRoomTokenOptions()
EOS_RTCAdmin_QueryJoinRoomTokenOptions(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 Detail

EOS_RTCADMIN_QUERYJOINROOMTOKEN_API_LATEST

public static final int EOS_RTCADMIN_QUERYJOINROOMTOKEN_API_LATEST

The most recent version of the EOS_RTCAdmin_QueryJoinRoomToken API

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_RTCADMIN_QUERYJOINROOMTOKEN_API_LATEST.

LocalUserId

public EOS_ProductUserId LocalUserId

Product User ID for local user who is querying join room tokens.

RoomName

public java.lang.String RoomName

Room name to request a token for.

TargetUserIds

public EOS_ProductUserId TargetUserIds

An array of Product User IDs indicating the users to retrieve a token for.

TargetUserIdsCount

public int TargetUserIdsCount

The number of users included in the query.

TargetUserIpAddresses

public com.sun.jna.StringArray TargetUserIpAddresses

Array of IP Addresses, one for each of the users we're querying tokens for. There should be TargetUserIdsCount Ip Addresses, you can set an entry to NULL if not known. If TargetUserIpAddresses is set to NULL IP Addresses will be ignored.
IPv4 format: "0.0.0.0"
IPv6 format: "0:0:0:0:0:0:0:0"

Constructor Detail

EOS_RTCAdmin_QueryJoinRoomTokenOptions

public EOS_RTCAdmin_QueryJoinRoomTokenOptions()

EOS_RTCAdmin_QueryJoinRoomTokenOptions

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