LoginEvent (BungeeCord-API 1.20-R0.2-SNAPSHOT API)

java.lang.Object
- net.md_5.bungee.api.plugin.Event
- - net.md_5.bungee.api.event.AsyncEvent<LoginEvent>
  - - net.md_5.bungee.api.event.LoginEvent

All Implemented Interfaces:

Cancellable
```
public class LoginEvent
extends AsyncEvent<LoginEvent>
implements Cancellable
```
Event called to represent a player logging in.

Constructor Summary

Constructors
Constructor Description

LoginEvent(PendingConnection connection, Callback<LoginEvent> done)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getCancelReason()`	Deprecated. use component methods instead
`BaseComponent[]`	`getCancelReasonComponents()`	Deprecated. use single component methods instead
`void`	`setCancelReason(String cancelReason)`	Deprecated. use component methods instead
`void`	`setCancelReason(BaseComponent... cancelReason)`	Deprecated. use single component methods instead

Methods inherited from class net.md_5.bungee.api.event.AsyncEvent
completeIntent, postCall, registerIntent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.md_5.bungee.api.plugin.Cancellable
isCancelled, setCancelled

- Constructor Detail
  - LoginEvent
```
public LoginEvent(PendingConnection connection,
                  Callback<LoginEvent> done)
```
- Method Detail
  - getCancelReason
```
@Deprecated
public String getCancelReason()
```
    Deprecated.
    use component methods instead
    
    Returns:
    
    reason to be displayed
  - setCancelReason
```
@Deprecated
public void setCancelReason(String cancelReason)
```
    Deprecated.
    use component methods instead
    
    Parameters:
    
    cancelReason - reason to be displayed
  - getCancelReasonComponents
```
@Deprecated
public BaseComponent[] getCancelReasonComponents()
```
    Deprecated.
    use single component methods instead
    
    Returns:
    
    reason to be displayed
  - setCancelReason
```
@Deprecated
public void setCancelReason(BaseComponent... cancelReason)
```
    Deprecated.
    use single component methods instead
    
    Parameters:
    
    cancelReason - reason to be displayed