mx.messaging.SubscriptionInfo - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.messaging
Class	public class SubscriptionInfo
Inheritance	SubscriptionInfo 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : 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
		prototype : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SubscriptionInfo(st:String, sel:String, mf:uint = 0) Builds a new SubscriptionInfo with the specified subtopic and selector.	SubscriptionInfo
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object 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.