C# Class Nexus.Client.ModManagement.ModUpdateCheckTask

Inheritance: ThreadedBackgroundTask

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
Cancel ( ) : void	Cancels the update.
ModUpdateCheckTask ( AutoUpdater p_AutoUpdater, IModRepository p_ModRepository, List p_lstModList, bool p_booOverrideCategorySetup ) : System	A simple constructor that initializes the object with its dependencies.
Update ( ConfirmActionMethod p_camConfirm ) : void	Starts the update.

Protected Methods

Method	Description
DoWork ( object p_objArgs ) : object	The method that is called to start the backgound task.
OnTaskEnded ( TaskEndedEventArgs e ) : void	Raises the IBackgroundTask.TaskEnded event.

Private Methods

Method	Description
CheckForModListUpdate ( List p_lstModList ) : void	Checks for the updated information for the given mods.

Method Details

Cancel() public method

Cancels the update.

public Cancel ( ) : void
return	void

DoWork() protected method

The method that is called to start the backgound task.

protected DoWork ( object p_objArgs ) : object
p_objArgs	object	Arguments to for the task execution.
return	object

ModUpdateCheckTask() public method

A simple constructor that initializes the object with its dependencies.

public ModUpdateCheckTask ( AutoUpdater p_AutoUpdater, IModRepository p_ModRepository, List p_lstModList, bool p_booOverrideCategorySetup ) : System
p_AutoUpdater	AutoUpdater	The AutoUpdater.
p_ModRepository	IModRepository	The current mod repository.
p_lstModList	List	The list of mods we need to update.
p_booOverrideCategorySetup	bool	Whether to force a global update.
return	System

OnTaskEnded() protected method

Raises the IBackgroundTask.TaskEnded event.

protected OnTaskEnded ( TaskEndedEventArgs e ) : void
e	Nexus.Client.BackgroundTasks.TaskEndedEventArgs	A describing the event arguments.
return	void

Update() public method

Starts the update.

public Update ( ConfirmActionMethod p_camConfirm ) : void
p_camConfirm	ConfirmActionMethod	The delegate to call to confirm an action.
return	void