Interface IAdminNotesManager

Namespace: Content.Server.Administration.Notes

Assembly: Content.Server.dll

Syntax

public interface IAdminNotesManager

Methods

| Improve this Doc View Source

AddAdminRemark(ICommonSession, Guid, NoteType, String, Nullable<NoteSeverity>, Boolean, Nullable<DateTime>)

Declaration

Task AddAdminRemark(ICommonSession createdBy, Guid player, NoteType type, string message, NoteSeverity? severity, bool secret, DateTime? expiryTime)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	createdBy
Guid	player
NoteType	type
System.String	message
System.Nullable<NoteSeverity>	severity
System.Boolean	secret
System.Nullable<DateTime>	expiryTime

Returns

Type	Description
Task

| Improve this Doc View Source

CanCreate(ICommonSession)

Declaration

bool CanCreate(ICommonSession admin)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	admin

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanDelete(ICommonSession)

Declaration

bool CanDelete(ICommonSession admin)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	admin

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanEdit(ICommonSession)

Declaration

bool CanEdit(ICommonSession admin)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	admin

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

CanView(ICommonSession)

Declaration

bool CanView(ICommonSession admin)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	admin

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

DeleteAdminRemark(Int32, NoteType, ICommonSession)

Declaration

Task DeleteAdminRemark(int noteId, NoteType type, ICommonSession deletedBy)

Parameters

Type	Name	Description
System.Int32	noteId
NoteType	type
Robust.Shared.Players.ICommonSession	deletedBy

Returns

Type	Description
Task

| Improve this Doc View Source

GetActiveWatchlists(Guid)

Queries the database and retrieves watchlists that may have been placed on the player

Declaration

Task<List<AdminWatchlist>> GetActiveWatchlists(Guid player)

Parameters

Type	Name	Description
Guid	player	Desired player's

Returns

Type	Description
Task<List<Content.Server.Database.AdminWatchlist>>	Active watchlists

| Improve this Doc View Source

GetAllAdminRemarks(Guid)

Queries the database and retrieves all notes, secret and visible

Declaration

Task<List<IAdminRemarksCommon>> GetAllAdminRemarks(Guid player)

Parameters

Type	Name	Description
Guid	player	Desired player's

Returns

Type	Description
Task<List<Content.Server.Database.IAdminRemarksCommon>>	ALL non-deleted notes, secret or not

| Improve this Doc View Source

GetNewMessages(Guid)

Queries the database and retrieves new messages a player has gotten

Declaration

Task<List<AdminMessage>> GetNewMessages(Guid player)

Parameters

Type	Name	Description
Guid	player	Desired player's

Returns

Type	Description
Task<List<Content.Server.Database.AdminMessage>>	All unread messages

| Improve this Doc View Source

GetVisibleRemarks(Guid)

Queries the database and retrieves the notes a player should see

Declaration

Task<List<IAdminRemarksCommon>> GetVisibleRemarks(Guid player)

Parameters

Type	Name	Description
Guid	player	Desired player's

Returns

Type	Description
Task<List<Content.Server.Database.IAdminRemarksCommon>>	All player-visible notes

| Improve this Doc View Source

MarkMessageAsSeen(Int32)

Declaration

Task MarkMessageAsSeen(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
Task

| Improve this Doc View Source

ModifyAdminRemark(Int32, NoteType, ICommonSession, String, Nullable<NoteSeverity>, Boolean, Nullable<DateTime>)

Declaration

Task ModifyAdminRemark(int noteId, NoteType type, ICommonSession editedBy, string message, NoteSeverity? severity, bool secret, DateTime? expiryTime)

Parameters

Type	Name	Description
System.Int32	noteId
NoteType	type
Robust.Shared.Players.ICommonSession	editedBy
System.String	message
System.Nullable<NoteSeverity>	severity
System.Boolean	secret
System.Nullable<DateTime>	expiryTime

Returns

Type	Description
Task

| Improve this Doc View Source

OpenEui(ICommonSession, Guid)

Declaration

Task OpenEui(ICommonSession admin, Guid notedPlayer)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	admin
Guid	notedPlayer

Returns

Type	Description
Task

| Improve this Doc View Source

OpenUserNotesEui(ICommonSession)

Declaration

Task OpenUserNotesEui(ICommonSession player)

Parameters

Type	Name	Description
Robust.Shared.Players.ICommonSession	player

Returns

Type	Description
Task

Events

| Improve this Doc View Source

NoteAdded

Declaration

event Action<SharedAdminNote>? NoteAdded

Event Type

Type	Description
System.Nullable<Action<SharedAdminNote>>

| Improve this Doc View Source

NoteDeleted

Declaration

event Action<SharedAdminNote>? NoteDeleted

Event Type

Type	Description
System.Nullable<Action<SharedAdminNote>>

| Improve this Doc View Source

NoteModified

Declaration

event Action<SharedAdminNote>? NoteModified

Event Type

Type	Description
System.Nullable<Action<SharedAdminNote>>