# Constants

### Authors

Generated by _pbuild

# GWSConstants constants

### GWSErrorKey

NSString* const GWSErrorKey;
Key for a local error returned in a result dictionary.
If an error occurred at the local end while producing the result dictionary, the value for this key (and NSError, NSException, or NSString) will describe the nature of the problem.

### GWSFaultKey

NSString* const GWSFaultKey;
Key for a fault dictionary returned in a response dictionary.
The value for this key is `nil` unless a wsdl fault was decoded into the dictionary.

### GWSJSONResultKey

NSString* const GWSJSONResultKey;
Description forthcoming.

### GWSMethodKey

NSString* const GWSMethodKey;
Key for the method name in a request dictionary.
The value of this key is `nil` unless the dictionary was the result of decoding a request, in which case it is the name of the method/operation requested.

### GWSOrderKey

NSString* const GWSOrderKey;
Key for an ordering array in a request or response dictionary.
If present in a decoded object, the value of this key is an NSMutableArray object containing the names of the parameters decoded.
If present in a dictionary being encoded, this is an NSArray object specifying the order in which the members of the dictionary are to be encoded.

### GWSParametersKey

NSString* const GWSParametersKey;
Key for a parameters dictionary in a request or response dictionary.
If present, the value of this key is an NSMutableDictionary containing the decoded parameters.

### GWSRPCIDKey

NSString* const GWSRPCIDKey;
Key for protocol request/response ID information stored in an RPC.

### GWSRPCVersionKey

NSString* const GWSRPCVersionKey;
Key for protocol version information stored in an RPC request or response.

### GWSRequestDataKey

NSString* const GWSRequestDataKey;
Key for the data sent to a remote system to perform a GWSService RPC operation.
This is present if debug was enabled for the service, but is omitted otherwise.

### GWSResponseDataKey

NSString* const GWSResponseDataKey;
Key for the data from a remote system returned in a result of a GWSService RPC made to a web services server.
This is present if and debug was enabled for the service, but is omitted otherwise.

### GWSSOAPArrayKey

NSString* const GWSSOAPArrayKey;
If this key is present in a dictionary describing a value (one with a GWSSOAPValueKey present) where the value is actually an array of values, then the array contents are encoded as an xsd style array of items inside this element rather than as a sequence of values of the same type. The value of this key is used as the name for the array item elements (if the value is not a legal element name then the string 'item' is used).

     foo = {
       GWSSOAPValueKey = ("hello", "there");
       GWSSOAPArrayKey = val;
     };

would encode '<foo><val>hello</val><val>there</val></foo>' rather than the normal '<foo>hello</foo><foo>there</foo>'

### GWSSOAPBodyEncodingStyleDocument

NSString* const GWSSOAPBodyEncodingStyleDocument;
This means that the SOAP body is encoded in document style.
Setting this value for the GWSSOAPBodyEncodingStyleKey in the parameters of a message being encoded has the same effect as calling [GWSSOAPCoder -setOperationStyle:] with an argument of GWSSOAPBodyEncodingStyleDocument.

### GWSSOAPBodyEncodingStyleKey

NSString* const GWSSOAPBodyEncodingStyleKey;
Key for the encoding style to be used for the SOAP body.
The value of this may be one of

- GWSSOAPBodyEncodingStyleDocument
- GWSSOAPBodyEncodingStyleRPC
- GWSSOAPBodyEncodingStyleWrapped

### GWSSOAPBodyEncodingStyleRPC

NSString* const GWSSOAPBodyEncodingStyleRPC;
This means that the SOAP body is encoded in RPC style.
Setting this value for the GWSSOAPBodyEncodingStyleKey in the parameters of a message being encoded has the same effect as calling [GWSSOAPCoder -setOperationStyle:] with an argument of GWSSOAPBodyEncodingStyleRPC.

### GWSSOAPBodyEncodingStyleWrapped

NSString* const GWSSOAPBodyEncodingStyleWrapped;
This means that the SOAP body is encoded in wrapped style.
Setting this value for the GWSSOAPBodyEncodingStyleKey in the parameters of a message being encoded has the same effect as calling [GWSSOAPCoder -setOperationStyle:] with an argument of GWSSOAPBodyEncodingStyleWrapped.
NB. This encoding style is not yet implemented.

### GWSSOAPMessageHeadersKey

NSString* const GWSSOAPMessageHeadersKey;
Key for the header element for a soap message.
You usually do not need to create this directly.
This is a dictionary of message parts (like the parameters dictionary itsself) which is used to specify for the contents of the Header.
If you do not specify a value for this key, the coder will attempt to build a dictionary from any items in the parameters dictionary which are not used for the main message body.
If no value is set for this key (and the dictionary can't be built from headers present in the main parameters dictionary), the header element is omitted.

### GWSSOAPNamespaceNameKey

NSString* const GWSSOAPNamespaceNameKey;
Key for the name to be used for the namespace of the current element (ie as the namespace prefix before the element name).
For instance.

     foo = {
       GWSSOAPnamespaceNameKey = "xxx";
     };

means that the element is encoded as 'xxx:foo' rather than just 'foo'.
This has a special meaning at the level of the SOAP Body, Fault, or Header dictionary. In these cases it does not set the namespace prefix for that element, but is instead used in conjunction with the GWSSOAPNamespaceURIKey to set up a namespace mapping in the SOAP Envelope.

### GWSSOAPNamespaceURIKey

NSString* const GWSSOAPNamespaceURIKey;
Key for the URI to be used as the default namespace for the current element (and all elements within it, unless overriden).
As a special case at the SOAP Body, Fault, or Header level, if this key is used in conjunction with the GWSSOAPNamespaceNameKey, a mapping is set up in the SOAP Envelope to match the name to the URI. This behavior is in addition to the normal behavior of setting the default namespace.

### GWSSOAPTypeKey

NSString* const GWSSOAPTypeKey;
If this key is present in a dictionary describing a value (one with a GWSSOAPValueKey present) it is used to specify the type of the value, overriding any normal xsi:type=... setting inferred from the actual data type of the value.

### GWSSOAPUseEncoded

NSString* const GWSSOAPUseEncoded;
Constant 'encoded' for Body/Header use.
If data is 'encoded', each element of the data has a 'type' attribute which provides type information allowing the element contents to be be decoded.

### GWSSOAPUseKey

NSString* const GWSSOAPUseKey;
Key for the 'use' style to be used for the SOAP Body, Header or Fault (depending on whether it is in the top level parameters dictionary or in the header parameters).
The value of this key may be 'literal' or 'encoded'. GWSSOAPUseEncoded or GWSSOAPUseLiteral

### GWSSOAPUseLiteral

NSString* const GWSSOAPUseLiteral;
Constant 'literal' for Body/Header use.
If data is 'literal', the contents of elements are decoded by implicit type knowledge depending on the element name and its position within the XML document.

### GWSSOAPValueKey

NSString* const GWSSOAPValueKey;
If this key is present in a dictionary, then instead of treating the dictionary as a complex type, the value referenced by this key is encoded, and other values in the dictionary (eg. GWSSOAPNamespaceURIKey) are used to modify the encoding of that value.
eg.

     foo = {
       GWSSOAPValueKey = "hello";
       GWSSOAPNamespaceURIKey = "http://foo/xxx.xsd";
     };

would encode '<foo "xmlns=http://foo/xxx.xsd">hello</foo>'.