Class WebRequestTask
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class WebRequestTask : Task
- Inheritance
-
objectWebRequestTask
Properties
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
CredentialProfile
The credentials to use for this request. Optional. If not specified, the job identity will be used.
public CredentialProfile CredentialProfile { get; set; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
MaxRunTime
The maximum execution time (in seconds) for the download. If the download exceeds the specified time it will be terminated.
public int MaxRunTime { get; set; }
Property Value
- int
RequestBody
The body of the request to send to the server if the RequestMethod is POST.
public string RequestBody { get; set; }
Property Value
- string
Remarks
If the RequestMethod is POST, the RequestBody specifies the HTTP request to send to the server.
RequestMethod
The HTTP method to use when sending the request.
public string RequestMethod { get; set; }
Property Value
- string
Remarks
By default a GET is performed. Set the RequestMethod to POST and set the RequestBody to perform a POST instead.
RequestURL
The URL to request.
public string RequestURL { get; set; }
Property Value
- string
Remarks
This value is required. Variable tokens can be used. The protocol (e.g., "http://") must be included.
SaveAsCapturedFile
Specifies whether the save the requested page or file as a Captured File in the job history.
public bool SaveAsCapturedFile { get; set; }
Property Value
- bool
Remarks
Default: false
- See Also
SaveToLocation
Specifies the file name to use to save the requested page or file.
public string SaveToLocation { get; set; }
Property Value
- string
Remarks
If a file name is specified, the requested page or file is saved to it. If no SaveLocation is specified, the file is not saved.
Variable tokens can be used in the value.
- See Also
SupportedResponseEvents
Gets a list of the events that are supported for Responses associated with this task.
public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
Methods
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- Task.UserInterfaceExtensionID
- Task.UserInterfaceExtensionData
- Task.DescriptionOverride
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)