Class BaseController

The import/export controller.

Inheritance

System.Object

BaseController

ExportController

ImportController

Namespace: Dnn.ExportImport.Components.Controllers

Assembly: DotNetNuke.SiteExportImport.dll

Syntax

public class BaseController : object

Fields

| Improve this Doc View Source

ExportFolder

The import/export controller.

Declaration

public static readonly string ExportFolder

Field Value

Type	Description
System.String

Methods

| Improve this Doc View Source

AddEventLog(Int32, Int32, Int32, String)

Adds an event log.

Declaration

protected void AddEventLog(int portalId, int userId, int jobId, string logTypeKey)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.Int32	userId	The user ID.
System.Int32	jobId	The job ID.
System.String	logTypeKey	The log type key.

| Improve this Doc View Source

BuildJobSummary(Int32)

Builds a job summary.

Declaration

protected static ImportExportSummary BuildJobSummary(int jobId)

Parameters

Type	Name	Description
System.Int32	jobId	The job ID.

Returns

Type	Description
ImportExportSummary	An ImportExportSummary instance.

| Improve this Doc View Source

BuildJobSummary(String, IExportImportRepository, ImportExportSummary)

Builds a job summary.

Declaration

protected static void BuildJobSummary(string packageId, IExportImportRepository repository, ImportExportSummary summary)

Parameters

Type	Name	Description
System.String	packageId	The package ID.
IExportImportRepository	repository	The repository.
ImportExportSummary	summary	The summary to build.

| Improve this Doc View Source

CancelJob(Int32, Int32)

Cancels the job.

Declaration

public bool CancelJob(int portalId, int jobId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.Int32	jobId	The job ID.

Returns

Type	Description
System.Boolean	A value indicating whether the job was found.

| Improve this Doc View Source

GetAllJobs(Int32, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String)

Retrieves one page of paginated processed jobs.

Declaration

public AllJobsResult GetAllJobs(int portalId, int currentPortalId, int? pageSize, int? pageIndex, int? jobType, string keywords)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.Int32	currentPortalId	The current portal ID.
System.Nullable<System.Int32>	pageSize	The page size (between `1` and `100`).
System.Nullable<System.Int32>	pageIndex	The page index (zero-based).
System.Nullable<System.Int32>	jobType	The job type.
System.String	keywords	Keywords.

Returns

Type	Description
AllJobsResult	An AllJobsResult instance.

| Improve this Doc View Source

GetExportFileInfo(String)

Gets the export file info.

Declaration

protected static ExportFileInfo GetExportFileInfo(string manifestPath)

Parameters

Type	Name	Description
System.String	manifestPath	The manifest path.

Returns

Type	Description
ExportFileInfo	An ExportFileInfo instance.

| Improve this Doc View Source

GetJobDetails(Int32, Int32)

Gets details about a job.

Declaration

public JobItem GetJobDetails(int portalId, int jobId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.Int32	jobId	The job ID.

Returns

Type	Description
JobItem	A JobItem instance.

| Improve this Doc View Source

GetLastJobTime(Int32, JobType)

Get the last time a successful export job has started. This date/time is in uts and can be used to set the next differential date/time to start the job from.

Declaration

public DateTime? GetLastJobTime(int portalId, JobType jobType)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
JobType	jobType	The job type.

Returns

Type	Description
System.Nullable<DateTime>	The last job time.

| Improve this Doc View Source

GetPackageInfo(String)

Gets the package info.

Declaration

protected static ImportPackageInfo GetPackageInfo(string manifestPath)

Parameters

Type	Name	Description
System.String	manifestPath	The manifest path.

Returns

Type	Description
ImportPackageInfo	An ImportPackageInfo instance.

| Improve this Doc View Source

RemoveJob(Int32, Int32)

Removes the job.

Declaration

public bool RemoveJob(int portalId, int jobId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.Int32	jobId	The job ID.

Returns

Type	Description
System.Boolean	A value indicating whether the job was found.

Extension Methods

JsonExtensionsWeb.ToJson(Object)