BrightSign Object Reference Manual (FW 5.1) User Manual

Page 254

Advertising
background image

246

PutFromFile(a As String) As Integer: Uses the HTTP PUT method to write the contents of the specified
file to the current URL and return the response code. Any response body is discarded; use
roUrlTransfer.SyncMethod to retrieve the response body.

AsyncPutFromString(a As String) As Boolean: Uses the HTTP PUT method to write the supplied string
to the current URL. Events of type roUrlEvent will be sent to the message port associated with the object. A False
return indicates that the request could not be issued and no events will be delivered. Any response body is
discarded; use roUrlTransfer.AsyncMethod to retrieve the response body.

AsyncPutFromFile(a As String) As Boolean : Uses the HTTP PUT method to write the contents of the
specified file to the current URL. Events of type roUrlEvent will be sent to the message port associated with the
object. A False return indicates that the request could not be issued and no events will be delivered. Any response
body is discarded; use roUrlTransfer.AsyncMethod to retrieve the response body.

Delete() As Object: Uses the HTTP DELETE method to delete the resource at the current URL and return the
response code. Any response body is discarded; use roUrlTransfer.SyncMethod to retrieve the response body.

AsyncDelete() As Boolean: Uses the HTTP DELETE method to delete the resource at the current URL.
Events of type roUrlEvent will be sent to the message port associated with the object. A False return indicates that
the request could not be issued and no events will be delivered. Any response body is discarded; use
roUrlTransfer.AsyncMethod to retrieve the response body.

ClearHeaders(): Removes all headers that would be supplied with an HTTP request.

AddHeaders(a As Object) As Boolean: Adds one or more headers to HTTP requests. Pass headers to this
object as an roAssociativeArray of name/value pairs. This method returns True upon success and False upon
failure. All headers that are added with this method will continue to be sent with HTTP requests until
ClearHeaders()is called.

SyncMethod(a As Object) As Object: Performs a synchronous HTTP method request using the specified
parameters. If the request is started successfully, then the method returns an roUrlEvent object containing the
results of the request. This method returns Invalid if the the request could not be started. In this case, the
GetFailureReason() method may provide more information.

Advertising