Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.messaging 
SubscriptionInfo 
Packagemx.messaging
Classpublic class SubscriptionInfo
InheritanceSubscriptionInfo Inheritance Object

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

This is the class used for elements of the ArrayCollection subscriptions property in the MultiTopicConsumer property.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  maxFrequency : uint
The maximum number of messages per second the subscription wants to receive.
SubscriptionInfo
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  selector : String
The selector.
SubscriptionInfo
  subtopic : String
The subtopic.
SubscriptionInfo
Public Methods
 MethodDefined By
  
Builds a new SubscriptionInfo with the specified subtopic and selector.
SubscriptionInfo
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

maxFrequency

property
public var maxFrequency:uint

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The maximum number of messages per second the subscription wants to receive. Zero means the subscription has no preference for the number of messages it receives.

selector

property 
public var selector:String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The selector. If null, indicates all messages should be sent.

subtopic

property 
public var subtopic:String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The subtopic. If null, represents a subscription for messages directed to the destination with no subtopic.

Constructor Detail

SubscriptionInfo

()Constructor
public function SubscriptionInfo(st:String, sel:String, mf:uint = 0)

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Builds a new SubscriptionInfo with the specified subtopic and selector.

Parameters
st:String — The subtopic for the subscription. If null, represents a subscription for messages directed to the destination with no subtopic.
 
sel:String — The selector. If null, inidcates all messages should be sent.
 
mf:uint (default = 0) — The maximum number of messages per second the subscription wants to receive. Zero means no preference.