Click or drag to resize

StrixNetworkKickRoomMember Method

Forcibly removes a member from the match room.

Namespace:  SoftGear.Strix.Unity.Runtime
Assembly:  StrixUnityRuntime (in StrixUnityRuntime.dll) Version: 1.5.0
Syntax
C#
Copy
public void KickRoomMember(
	UID kickedPlayerUid,
	RoomMemberKickEventHandler handler,
	FailureEventHandler failureHandler,
	RequestConfig config = null
)

Parameters

kickedPlayerUid
Type: SoftGear.Strix.Client.CoreUID
ID of the player to be kicked.
handler
Type: SoftGear.Strix.Unity.Runtime.EventRoomMemberKickEventHandler
This callback is invoked when the member has been kicked successfully.
failureHandler
Type: SoftGear.Strix.Unity.Runtime.EventFailureEventHandler
This is callback is invoked if the member could not be kicked for some reason.
config (Optional)
Type: SoftGear.Strix.Client.Core.RequestRequestConfig
If not null, used to configure the request timeout. Default timeout is 30 seconds. See RequestConfig for more details.
Remarks
To kick a member you must be the room's owner. If the kick succeeds, the kicked room member will receive MatchRoomKickNotified notification on StrixNetwork.instance.roomClient while all the other members receive RoomLeaveNotified notification.

Possible exception types in FailureEventArgs's cause:
ErrorCodeException Strix error which can be further separated by an error code:
ConnectionErrorFailed to send the request because of a connection error.
RequestTimeoutServer did not respond within the specified timeout interval.
NotRoomOwnerYou're trying to kick a member while not being a room owner.
[!:MatchErrorCode.SelfKickProhibited]Cannot kick yourself.
RoomMemberNotFoundCannot find room member with kickedPlayerUid.
LockTimeout
See Also