Class ApiImportParameter

Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
ApiImportParameter
Implements
Inherited Members
Namespace: LemonEdge.ApiConnector.Tasks.Parameters
Assembly: LemonEdge.ApiConnector.dll
Syntax
[DataContract]
[ServerTaskParameters("Execute API Query", "3B7D8B22-EC0F-41F8-AB86-7F9503B59FDC", Description = "Executes and imports a scheduled API Query.")]
public class ApiImportParameter : ItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<ApiImportParameter>

Constructors

ApiImportParameter()

Declaration
public ApiImportParameter()

ApiImportParameter(Guid)

Declaration
public ApiImportParameter(Guid queryID)
Parameters
Type Name Description
Guid queryID

Fields

UNIQUE_TASK_ID

The unique id of the ApiImport server task

Declaration
public const string UNIQUE_TASK_ID = "3B7D8B22-EC0F-41F8-AB86-7F9503B59FDC"
Field Value
Type Description
string

Properties

Base64SerializedParameters

Holds the parameters for the api import

Declaration
public string Base64SerializedParameters { get; set; }
Property Value
Type Description
string

QueryID

Declaration
public Guid QueryID { get; set; }
Property Value
Type Description
Guid

Methods

Clone()

Creates a new instance of this class (of type ApiImportParameter) with all the same property values as this instance

Declaration
public ApiImportParameter Clone()
Returns
Type Description
ApiImportParameter

A new instance of this class with all the same property values as this instance

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(ApiImportParameter)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(ApiImportParameter source)
Parameters
Type Name Description
ApiImportParameter source

The source object to copy all values from.

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns a user friendly string for the type of task being processed that these parameters work against

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

An instance of a task that these parameters work for
Returns
Type Description
string

A user friendly string for the type of task being processed that these parameters work against
Overrides

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods