Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
SubscriptionInfo

Package | mx.messaging
Class | public class SubscriptionInfo
Inheritance | SubscriptionInfo Object

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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

| Property | Defined By
--- | --- | ---
|  | maxFrequency : uint The maximum number of messages per second the subscription wants to receive. | SubscriptionInfo
|  | selector : String The selector. | SubscriptionInfo
|  | subtopic : String The subtopic. | SubscriptionInfo

Public Methods

| Method | Defined By
--- | --- | ---
|  | SubscriptionInfo(st:String, sel:String, mf:uint = 0) Builds a new SubscriptionInfo with the specified subtopic and selector. | SubscriptionInfo

Property Detail

maxFrequency | property

`public var maxFrequency:uint`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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, LCDS 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, LCDS 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, LCDS 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.

Sun Mar 5 2017, 03:42 PM +11:00