Packagecom.amazonaws
Classpublic class ClientConfiguration
InheritanceClientConfiguration Inheritance Object
Implements flash.events.IEventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : January 24. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Client configuration options.



Public Properties
 PropertyDefined By
  endpoint : String
Returns Amazon AWS service endpoint.
ClientConfiguration
  protocol : ProtocolEnum
Returns protocol to use when connecting to Amazon Web Services.
ClientConfiguration
  requestURI : String
Returns request URI.
ClientConfiguration
  signatureExpires : uint
Returns the number of seconds after which signature expires.
ClientConfiguration
  userAgent : String
Returns the HTTP(s) user agent header to send with all requests.
ClientConfiguration
Public Methods
 MethodDefined By
  
Constructor.
ClientConfiguration
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
ClientConfiguration
  
dispatchEvent(event:Event):Boolean
ClientConfiguration
  
hasEventListener(type:String):Boolean
ClientConfiguration
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
ClientConfiguration
  
willTrigger(type:String):Boolean
ClientConfiguration
  
Sets Amazon AWS service endpoint and returns updated ClientConfiguration object with the new endpoint setting.
ClientConfiguration
  
Sets the protocol (i.e.
ClientConfiguration
  
Sets SQS requestURI and returns updated ClientConfiguration object with the new requestURI setting.
ClientConfiguration
  
Sets the number of seconds after which signature expires.
ClientConfiguration
  
Sets the HTTP(s) user agent header used in requests and returns the updated ClientConfiguration object.
ClientConfiguration
Public Constants
 ConstantDefined By
  DEFAULT_USER_AGENT : String
[static] The default HTTP user agent header for AWS Flex SDK clients.
ClientConfiguration
Property Detail
endpointproperty
endpoint:String

Returns Amazon AWS service endpoint.

This property can be used as the source for data binding.


Implementation
    public function get endpoint():String
    public function set endpoint(value:String):void
protocolproperty 
protocol:ProtocolEnum

Returns protocol to use when connecting to Amazon Web Services.

The default value is ProtocolEnum.HTTPS.

This property can be used as the source for data binding.


Implementation
    public function get protocol():ProtocolEnum
    public function set protocol(value:ProtocolEnum):void
requestURIproperty 
requestURI:String

Returns request URI.

The default value is /.

This property can be used as the source for data binding.


Implementation
    public function get requestURI():String
    public function set requestURI(value:String):void
signatureExpiresproperty 
signatureExpires:uint

Returns the number of seconds after which signature expires.

This property can be used as the source for data binding.


Implementation
    public function get signatureExpires():uint
    public function set signatureExpires(value:uint):void
userAgentproperty 
userAgent:String

Returns the HTTP(s) user agent header to send with all requests. Note: Only available for AIR Runtime, otherwise null is returned.

This property can be used as the source for data binding.


Implementation
    public function get userAgent():String
    public function set userAgent(value:String):void
Constructor Detail
ClientConfiguration()Constructor
public function ClientConfiguration()

Constructor.

Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean
withEndpoint()method 
public function withEndpoint(endpoint:String):ClientConfiguration

Sets Amazon AWS service endpoint and returns updated ClientConfiguration object with the new endpoint setting.

Parameters

endpoint:String — - Amazon AWS service endpoint

Returns
ClientConfiguration — The updated ClientConfiguration object with the new endpoint setting.
withProtocol()method 
public function withProtocol(protocol:ProtocolEnum):ClientConfiguration

Sets the protocol (i.e. HTTP or HTTPS) to use when connecting to Amazon Web Services and returns updated ClientConfiguration object with the new protocol setting. The default configuration is to use HTTPS for all requests for increased security. Individual clients can also override this setting by explicitly including the protocol as part of the endpoint URL when calling

Parameters

protocol:ProtocolEnum — - The protocol to use when connecting to Amazon Web Services.

Returns
ClientConfiguration — The updated ClientConfiguration object with the new protocol setting.
withRequestURI()method 
public function withRequestURI(requestURI:String):ClientConfiguration

Sets SQS requestURI and returns updated ClientConfiguration object with the new requestURI setting.

Parameters

requestURI:String — - request URI.

Returns
ClientConfiguration — The updated ClientConfiguration object with the new requestURI setting.
withSignatureExpires()method 
public function withSignatureExpires(expires:uint):ClientConfiguration

Sets the number of seconds after which signature expires.

Parameters

expires:uint — Number of seconds after which signature expires. return The updated ClientConfiguration object.

Returns
ClientConfiguration
withUserAgent()method 
public function withUserAgent(userAgent:String):ClientConfiguration

Sets the HTTP(s) user agent header used in requests and returns the updated ClientConfiguration object.

Parameters

userAgent:String — - The user agent string to use when sending requests. return The updated ClientConfiguration object.

Returns
ClientConfiguration
Constant Detail
DEFAULT_USER_AGENTConstant
public static const DEFAULT_USER_AGENT:String

The default HTTP user agent header for AWS Flex SDK clients. Only available for AIR Runtime.