Difference between revisions of "Function.Communication.REST.SetProperty"

From GAB Help
Jump to: navigation, search
(Added category)
 
Line 1: Line 1:
==Syntax==
+
==SetProperty(Name, Value)==
Function.Communication.REST.SetProperty (PropertyName [string], PropertyValue [string])
+
Sets a property value. The available properties can be found http://cdn.nsoftware.com/help/IPF/cs/REST.htm
  
==Arguments==
+
===Arguments===
===PropertyName===
+
====Name as String====
string
+
The property name
===PropertyValue===
+
====Value as Any====
string
+
The property value [as object]
  
==Examples==
+
===Examples===
 
+
<code>Function.Communication.REST.SetProperty("Name",V.Local.Property)</code>
==Property==
 
 
 
Available properties:
 
 
 
1. Accept A list of acceptable MIME types for the request.
 
 
 
2. Authorization The Authorization string to be sent to the server.
 
 
 
3. AuthScheme The authentication scheme to use when server authorization is required.
 
 
 
4. BuildDOM When True, an internal object model of the XML document is created.
 
 
 
5. Connected Shows whether the component is connected.
 
 
 
6. ContentType Content type for posts and puts.
 
 
 
7. Cookies Collection of cookies.  
 
 
 
8. Firewall A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.
 
 
 
9. FollowRedirects Determines what happens when the server issues a redirect.
 
 
 
10. From The email address of the HTTP agent (optional).
 
 
 
11. HTTPMethod The HTTP method used for the request.
 
 
 
12. IfModifiedSince A date determining the maximum age of the desired document.
 
 
 
13. LocalFile The path to a local file for downloading. If the file exists, it is overwritten.
 
 
 
14. LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.  
 
 
 
15. OtherHeaders Other headers as determined by the user (optional).
 
 
 
16. Password A password if authentication is to be used.
 
 
 
17. PostData The data to post with the URL if the POST method is used.
 
 
 
18. PostDataB
 
 
 
19. Proxy A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.
 
 
 
20. Referer Referer URL/document (optional).
 
 
 
21. Timeout A timeout for the component.
 
 
 
22. TransferredDataLimit The maximum of bytes of data to be transferred.
 
 
 
23. URL The URL to which information is posted.
 
 
 
24. User A user name if authentication is to be used.
 
 
 
25. Validate When True, the parser checks that the document consists of well-formed XML.
 
 
 
26. XErrorPath An XPath to check the server response for errors.
 
 
 
27. XPath Provides a way to point to a specific element in the response.
 
 
 
 
 
==Remarks==
 
  
  
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Function.Communication]]
 
[[Category:Function.Communication.REST]]
 
[[Category:Function.Communication.REST]]
[[Category:NeedsExample]]
+
 
[[Category:NeedsEdit]]
+
__FORCETOC__
[[Category:Function.Communication]]
 

Latest revision as of 10:24, 21 May 2020

SetProperty(Name, Value)

Sets a property value. The available properties can be found http://cdn.nsoftware.com/help/IPF/cs/REST.htm

Arguments

Name as String

The property name

Value as Any

The property value [as object]

Examples

Function.Communication.REST.SetProperty("Name",V.Local.Property)