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

Class EOS_RTCAdmin_KickOptions

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.rtcadmin.options.EOS_RTCAdmin_KickOptions
Direct Known Subclasses:
EOS_RTCAdmin_KickOptions.ByReference, EOS_RTCAdmin_KickOptions.ByValue
@FieldOrder({"ApiVersion","RoomName","TargetUserId"}) public class EOS_RTCAdmin_KickOptions extends com.sun.jna.Structure
Input parameters for the EOS_RTCAdmin_Kick function.
Since:
11/01/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_RTCAdmin_KickOptions.ByReference
     
    static class 
    EOS_RTCAdmin_KickOptions.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_KICK_API_LATEST.
    static final int
    EOS_RTCADMIN_KICK_API_LATEST
    The most recent version of the EOS_RTCAdmin_Kick API
    String
    RoomName
    Room name to kick the participant from
    EOS_ProductUserId
    TargetUserId
    Product User ID of the participant to kick from the 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_KickOptions()
     
    EOS_RTCAdmin_KickOptions(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_RTCADMIN_KICK_API_LATEST

      public static final int EOS_RTCADMIN_KICK_API_LATEST
      The most recent version of the EOS_RTCAdmin_Kick API
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_RTCADMIN_KICK_API_LATEST.

    • RoomName

      public String RoomName
      Room name to kick the participant from

    • TargetUserId

      public EOS_ProductUserId TargetUserId
      Product User ID of the participant to kick from the room

  • Constructor Details

    • EOS_RTCAdmin_KickOptions

      public EOS_RTCAdmin_KickOptions()

    • EOS_RTCAdmin_KickOptions

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