BrightSign Object Reference Manual (FW 5.1) User Manual

Page 203

Advertising
background image

195

Name

Applies to

Value

url_path

all

The path for which the handler method will be used

user_data

GetFromEvent(),PostToString(),
PostToFile(),MethodToString()

A user-defined value that can be retrieved by calling
roHttpEvent.GetUserData()

method

AddMethodFromEvent(),
AddMethodToFile()

The HTTP method associated with the generated roHttpEvent. The
method type can then be retrieved using roHttpEvent.GetMethod().

passwords

all

An associative array that contains a mapping between usernames and
passwords

auth

all

The authentication type to use when passwords are set. This value can
be either "basic" or "digest". The value defaults to “digest” if not
specified.

realm

all

The authentication realm, which will be displayed by web browsers
when prompting for a username and password

headers

GetFromFile

An associative array that contains arbitrary headers to be included with
the automated response

content_type

GetFromFile

The contents of the "Content-Type" header that is included with the
automated response. This may not be set at the same time as the
headers member. You can set both the MIME type and character set
together (e.g.

"text/plain; charset=utf-8")

body

GetFromString

The response body

filename

GetFromFile

The path to the file used for the response body.

destination_directory PostToFile

The path to the directory used for the temporary file containing the
request body. A random filename will be generated automatically.


Advertising