asdoc/mx/messaging/messages/HTTPRequestMessage.js.json

{ "type": "class",
  "qname": "mx.messaging.messages.HTTPRequestMessage",
  "baseClassname": "mx.messaging.messages.AbstractMessage"
  ,
    "description": "HTTP requests are sent to the HTTP endpoint using this message type. An HTTPRequestMessage encapsulates content and header information normally found in HTTP requests made by a browser.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["BlazeDS 4", "LCDS 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.messaging.messages.HTTPRequestMessage",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs an uninitialized HTTP request.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "contentType",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Indicates the content type of this message. This value must be understood by the destination this request is sent to.  <p>The following example sets the <code>contentType</code> property:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Object",
        "qname": "httpHeaders",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Contains specific HTTP headers that should be placed on the request made to the destination.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "recordHeaders",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Only used when going through the proxy, should the proxy send back the request and response headers it used.  Defaults to false. Currently only set when using the NetworkMonitor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "url",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Contains the final destination for this request. This is the URL that the content of this message, found in the <code>body</code> property, will be sent to, using the method specified.  <p>The following example sets the <code>url</code> property:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "method",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Indicates what method should be used for the request. The only values allowed are: <ul> <li><code>HTTPRequestMessage.DELETE_METHOD</code></li> <li><code>HTTPRequestMessage.GET_METHOD</code></li> <li><code>HTTPRequestMessage.HEAD_METHOD</code></li> <li><code>HTTPRequestMessage.POST_METHOD</code></li> <li><code>HTTPRequestMessage.OPTIONS_METHOD</code></li> <li><code>HTTPRequestMessage.PUT_METHOD</code></li> <li><code>HTTPRequestMessage.TRACE_METHOD</code></li> </ul>  <p>The following example sets the <code>method</code> property:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "CONTENT_TYPE_XML",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the content of this message is XML.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_XML;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "CONTENT_TYPE_FORM",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the content of this message is a form.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "CONTENT_TYPE_SOAP_XML",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the content of this message is XML meant for a SOAP request.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_SOAP_XML;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "POST_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;post&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.POST_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "GET_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;get&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.GET_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "PUT_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;put&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.PUT_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "HEAD_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;head&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.HEAD_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "DELETE_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;delete&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.DELETE_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "OPTIONS_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;options&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.OPTIONS_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "TRACE_METHOD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Indicates that the method used for this request should be &quot;trace&quot;.  <p>The following example uses this constant:</p> <pre>\\n var msg:HTTPRequestMessage = new HTTPRequestMessage();\\n msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;\\n msg.method = HTTPRequestMessage.TRACE_METHOD;\\n msg.url = &quot;http://my.company.com/login&quot;;\\n </pre>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }