Class UnturnedUserProvider

Inheritance
System.Object
UnturnedUserProvider
Implements
IDisposable
Namespace: OpenMod.Unturned.Users
Assembly: OpenMod.Unturned.dll
Syntax
public class UnturnedUserProvider : IUserProvider, IDisposable

Constructors

| Improve this Doc View Source

UnturnedUserProvider(IEventBus, IOpenModStringLocalizer, IUserDataSeeder, IUserDataStore, IRuntime)

Declaration
public UnturnedUserProvider(IEventBus eventBus, IOpenModStringLocalizer stringLocalizer, IUserDataSeeder dataSeeder, IUserDataStore userDataStore, IRuntime runtime)
Parameters
Type Name Description
IEventBus eventBus
IOpenModStringLocalizer stringLocalizer
IUserDataSeeder dataSeeder
IUserDataStore userDataStore
IRuntime runtime

Methods

| Improve this Doc View Source

BanAsync(IUser, Nullable<IUser>, Nullable<String>, Nullable<DateTime>)

Declaration
public Task<bool> BanAsync(IUser user, IUser? instigator = null, string? reason = null, DateTime? expireDate = null)
Parameters
Type Name Description
IUser user
System.Nullable<IUser> instigator
System.Nullable<System.String> reason
System.Nullable<DateTime> expireDate
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

BanAsync(IUser, Nullable<String>, Nullable<DateTime>)

Declaration
public Task<bool> BanAsync(IUser user, string? reason = null, DateTime? expireDate = null)
Parameters
Type Name Description
IUser user
System.Nullable<System.String> reason
System.Nullable<DateTime> expireDate
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

BroadcastAsync(String, Nullable<System.Drawing.Color>)

Declaration
public Task BroadcastAsync(string message, System.Drawing.Color? color)
Parameters
Type Name Description
System.String message
System.Nullable<System.Drawing.Color> color
Returns
Type Description
Task
| Improve this Doc View Source

BroadcastAsync(String, Nullable<System.Drawing.Color>, Boolean, String)

Declaration
public Task BroadcastAsync(string message, System.Drawing.Color? color, bool isRich, string iconUrl)
Parameters
Type Name Description
System.String message
System.Nullable<System.Drawing.Color> color
System.Boolean isRich
System.String iconUrl
Returns
Type Description
Task
| Improve this Doc View Source

BroadcastAsync(String, String, Nullable<System.Drawing.Color>)

Declaration
public Task BroadcastAsync(string userType, string message, System.Drawing.Color? color)
Parameters
Type Name Description
System.String userType
System.String message
System.Nullable<System.Drawing.Color> color
Returns
Type Description
Task
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

FindUserAsync(String, String, UserSearchMode)

Declaration
public Task<IUser?> FindUserAsync(string userType, string searchString, UserSearchMode searchMode)
Parameters
Type Name Description
System.String userType
System.String searchString
UserSearchMode searchMode
Returns
Type Description
Task<System.Nullable<IUser>>
| Improve this Doc View Source

FinishSession(UnturnedPendingUser)

Declaration
protected virtual void FinishSession(UnturnedPendingUser pending)
Parameters
Type Name Description
UnturnedPendingUser pending
| Improve this Doc View Source

GetOnlineUsers()

Declaration
public ICollection<UnturnedUser> GetOnlineUsers()
Returns
Type Description
ICollection<UnturnedUser>
| Improve this Doc View Source

GetPendingUsers()

Declaration
public ICollection<UnturnedPendingUser> GetPendingUsers()
Returns
Type Description
ICollection<UnturnedPendingUser>
| Improve this Doc View Source

GetUser(CSteamID)

Declaration
public virtual UnturnedUser GetUser(CSteamID id)
Parameters
Type Name Description
CSteamID id
Returns
Type Description
UnturnedUser
| Improve this Doc View Source

GetUser(Player)

Declaration
public virtual UnturnedUser GetUser(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
UnturnedUser
| Improve this Doc View Source

GetUser(SteamPlayer)

Declaration
public virtual UnturnedUser GetUser(SteamPlayer player)
Parameters
Type Name Description
SteamPlayer player
Returns
Type Description
UnturnedUser
| Improve this Doc View Source

GetUsersAsync(String)

Declaration
public Task<IReadOnlyCollection<IUser>> GetUsersAsync(string userType)
Parameters
Type Name Description
System.String userType
Returns
Type Description
Task<IReadOnlyCollection<IUser>>
| Improve this Doc View Source

KickAsync(IUser, Nullable<String>)

Declaration
public Task<bool> KickAsync(IUser user, string? reason = null)
Parameters
Type Name Description
IUser user
System.Nullable<System.String> reason
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

OnPendingPlayerConnecting(ValidateAuthTicketResponse_t, ref Boolean, ref Nullable<String>)

Declaration
protected virtual void OnPendingPlayerConnecting(ValidateAuthTicketResponse_t callback, ref bool isValid, ref string? explanation)
Parameters
Type Name Description
ValidateAuthTicketResponse_t callback
System.Boolean isValid
System.Nullable<System.String> explanation
| Improve this Doc View Source

OnPlayerConnected(CSteamID)

Declaration
protected virtual void OnPlayerConnected(CSteamID steamID)
Parameters
Type Name Description
CSteamID steamID
| Improve this Doc View Source

OnPlayerDisconnected(CSteamID)

Declaration
protected virtual void OnPlayerDisconnected(CSteamID steamID)
Parameters
Type Name Description
CSteamID steamID
| Improve this Doc View Source

OnRejectingPlayer(CSteamID, ESteamRejection, String)

Declaration
protected virtual void OnRejectingPlayer(CSteamID steamId, ESteamRejection rejection, string explanation)
Parameters
Type Name Description
CSteamID steamId
ESteamRejection rejection
System.String explanation
| Improve this Doc View Source

SupportsUserType(String)

Declaration
public bool SupportsUserType(string userType)
Parameters
Type Name Description
System.String userType
Returns
Type Description
System.Boolean

Implements

IDisposable

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)