Package host.anzo.eossdk.eos.sdk.rtc.callbackresults

Class EOS_RTC_BlockParticipantCallbackInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.rtc.callbackresults.EOS_RTC_BlockParticipantCallbackInfo

Direct Known Subclasses:

EOS_RTC_BlockParticipantCallbackInfo.ByReference, EOS_RTC_BlockParticipantCallbackInfo.ByValue

@FieldOrder({"ResultCode","ClientData","LocalUserId","RoomName","ParticipantId","IsBlocked"})
public class EOS_RTC_BlockParticipantCallbackInfo
extends com.sun.jna.Structure

This struct is passed in with a call to EOS_RTC_OnBlockParticipantCallback.

Since:

11/01/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_RTC_BlockParticipantCallbackInfo.ByReference
static class	EOS_RTC_BlockParticipantCallbackInfo.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
com.sun.jna.Pointer	ClientData	Client-specified data passed into EOS_RTC_BlockParticipant.
EOS_Bool	IsBlocked	The block state that should have been set
EOS_ProductUserId	LocalUserId	The Product User ID of the user who initiated this request.
EOS_ProductUserId	ParticipantId	The Product User ID of the participant being blocked
EOS_EResult	ResultCode	This returns: EOS_EResult.EOS_Success if the channel was successfully blocked EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect EOS_EResult.EOS_NotFound if either the local user or specified participant are not in the specified room EOS_EResult.EOS_RTC_UserIsInBlocklist if the user is in one of the platform's applicable block lists and thus an RTC unblock is not allowed. EOS_EResult.EOS_UnexpectedError otherwise.
String	RoomName	The room the users should be blocked on.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_RTC_BlockParticipantCallbackInfo()
EOS_RTC_BlockParticipantCallbackInfo(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

ResultCode

public EOS_EResult ResultCode

This returns:
EOS_EResult.EOS_Success if the channel was successfully blocked
EOS_EResult.EOS_InvalidParameters if any of the parameters are incorrect
EOS_EResult.EOS_NotFound if either the local user or specified participant are not in the specified room
EOS_EResult.EOS_RTC_UserIsInBlocklist if the user is in one of the platform's applicable block lists and thus an RTC unblock is not allowed.
EOS_EResult.EOS_UnexpectedError otherwise.

ClientData

public com.sun.jna.Pointer ClientData

Client-specified data passed into EOS_RTC_BlockParticipant.

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the user who initiated this request.

RoomName

public String RoomName

The room the users should be blocked on.

ParticipantId

public EOS_ProductUserId ParticipantId

The Product User ID of the participant being blocked

IsBlocked

public EOS_Bool IsBlocked

The block state that should have been set

Constructor Details

EOS_RTC_BlockParticipantCallbackInfo

public EOS_RTC_BlockParticipantCallbackInfo()

EOS_RTC_BlockParticipantCallbackInfo

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