Class BugSaveManager

Static class that handles saving and loading bugs.

Inheritance

object

BugSaveManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.Aruba

Assembly: Phoenix.Plugin.Aruba.dll

Syntax

public class BugSaveManager

Remarks

Initializes a new instance of the BugSaveManager class.

Constructors

BugSaveManager(IPhoenixLogger, IAutoSaver)

Static class that handles saving and loading bugs.

Declaration

public BugSaveManager(IPhoenixLogger logger, IAutoSaver autoSaver)

Parameters

Type	Name	Description
IPhoenixLogger	logger	A Phoenix.Logger.IPhoenixLogger used to log any errors.
IAutoSaver	autoSaver	A IAutoSaver used to to get the auto save path.

Remarks

Initializes a new instance of the BugSaveManager class.

Fields

ImagePlaceholderDelimiter

Declaration

public const char ImagePlaceholderDelimiter = '|'

Field Value

Type	Description
char

ImagePlaceholderPrependString

Declaration

public const string ImagePlaceholderPrependString = "?ImagePlaceHolder?"

Field Value

Type	Description
string

Properties

BugFolderPrependNameLength

Declaration

public static int BugFolderPrependNameLength { get; }

Property Value

Type	Description
int

Methods

DeleteAllSaves()

Deletes all saves in a given directory.

Declaration

public void DeleteAllSaves()

DeleteSave(Guid)

Deletes the specific save for the given directory.

Declaration

public void DeleteSave(Guid bugID)

Parameters

Type	Name	Description
Guid	bugID	The GUID representing the bug.

GetBugCreationSaveModel(string)

Gets the bug creation save model for a given bug.

Declaration

public Task<BugCreationSaveModel> GetBugCreationSaveModel(string bugID)

Parameters

Type	Name	Description
string	bugID	The GUID representing the bug to load

Returns

Type	Description
Task<BugCreationSaveModel>	A BugCreationSaveModel object that was loaded from a save file.

SaveBug(BugCreationSaveModel)

Saves a bug and its content to the given directory.

Declaration

public Task SaveBug(BugCreationSaveModel bugCreationSaveModel)

Parameters

Type	Name	Description
BugCreationSaveModel	bugCreationSaveModel	A BugCreationSaveModel containing the necessary information about a bug.

Returns

Type	Description
Task	A task.