ActionScript® 3.0 — dokumentacja dla platformy Adobe® Flash®
Strona główna  |  Ukryj listę pakietów i klas |  Pakiety  |  Klasy  |  Nowości  |  Indeks  |  Dodatki  |  Dlaczego język angielski?
Filtry: Pobieranie danych z serwera...
Pobieranie danych z serwera...
mx.messaging.messages 

CommandMessage  - AS3 BlazeDS LCDS

Pakietmx.messaging.messages
Klasapublic class CommandMessage
DziedziczenieCommandMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

The CommandMessage class provides a mechanism for sending commands to the server infrastructure, such as commands related to publish/subscribe messaging scenarios, ping operations, and cluster operations.



Właściwości publiczne
 WłaściwośćZdefiniowane przez
 Inheritedbody : Object
The body of a message contains the specific data that needs to be delivered to the remote destination.
AbstractMessage
 InheritedclientId : String
The clientId indicates which MessageAgent sent the message.
AbstractMessage
 Inheritedconstructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu.
Object
 InheritedcorrelationId : String
Provides access to the correlation id of the message.
AsyncMessage
 Inheriteddestination : String
The message destination.
AbstractMessage
 Inheritedheaders : Object
The headers of a message are an associative array where the key is the header name and the value is the header value.
AbstractMessage
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
  operation : uint
Provides access to the operation/command for the CommandMessage.
CommandMessage
 Inheritedtimestamp : Number
Provides access to the time stamp for the message.
AbstractMessage
 InheritedtimeToLive : Number
The time to live value of a message indicates how long the message should be considered valid and deliverable.
AbstractMessage
Metody publiczne
 MetodaZdefiniowane przez
  
Constructs an instance of a CommandMessage with an empty body and header and a default operation of UNKNOWN_OPERATION.
CommandMessage
  
[statyczny] Provides a description of the operation specified.
CommandMessage
 Inherited
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość.
Object
 Inherited
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr.
Object
 Inherited
Wskazuje, czy określona właściwość istnieje i jest przeliczalna.
Object
 Inherited
Ustawia dostępność właściwości dynamicznej używanej w pętlach.
Object
 Inherited
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych.
Object
  
[przesłanianie] Returns a string representation of the message.
CommandMessage
 Inherited
Zwraca pierwotną wartość dla określonego obiektu.
Object
Stałe publiczne
 StałaZdefiniowane przez
  ADD_SUBSCRIPTIONS : String = "DSAddSub"
[statyczny] Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector pairs to add to the existing set of subscriptions.
CommandMessage
  AUTHENTICATION_MESSAGE_REF_TYPE : String = "flex.messaging.messages.AuthenticationMessage"
[statyczny] The server message type for authentication commands.
CommandMessage
  CLIENT_PING_OPERATION : uint = 5
[statyczny] This operation is used to test connectivity over the current channel to the remote endpoint.
CommandMessage
  CLIENT_SYNC_OPERATION : uint = 4
[statyczny] This operation is used by a remote destination to sync missed or cached messages back to a client as a result of a client issued poll command.
CommandMessage
  CLUSTER_REQUEST_OPERATION : uint = 7
[statyczny] This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.
CommandMessage
  CREDENTIALS_CHARSET_HEADER : String = "DSCredentialsCharset"
[statyczny] Header to specify which character set encoding was used while encoding login credentials.
CommandMessage
  DISCONNECT_OPERATION : uint = 12
[statyczny] This operation is used to indicate that a channel has disconnected.
CommandMessage
  HEARTBEAT_HEADER : String = "DS<3"
[statyczny] Header that indicates the message is a heartbeat.
CommandMessage
  LOGIN_OPERATION : uint = 8
[statyczny] This operation is used to send credentials to the endpoint so that the user can be logged in over the current channel.
CommandMessage
  LOGOUT_OPERATION : uint = 9
[statyczny] This operation is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.
CommandMessage
  MAX_FREQUENCY_HEADER : String = "DSMaxFrequency"
[statyczny] Header to indicate the maximum number of messages a Consumer wants to receive per second.
CommandMessage
  MESSAGING_VERSION : String = "DSMessagingVersion"
[statyczny] Endpoints can imply what features they support by reporting the latest version of messaging they are capable of during the handshake of the initial ping CommandMessage.
CommandMessage
  MULTI_SUBSCRIBE_OPERATION : uint = 11
[statyczny] Used by the MultiTopicConsumer to subscribe/unsubscribe for more than one topic in the same message.
CommandMessage
  NEEDS_CONFIG_HEADER : String = "DSNeedsConfig"
[statyczny] Header to indicate that the Channel needs the configuration from the server.
CommandMessage
  NO_OP_POLL_HEADER : String = "DSNoOpPoll"
[statyczny] Header to suppress poll response processing.
CommandMessage
  POLL_OPERATION : uint = 2
[statyczny] This operation is used to poll a remote destination for pending, undelivered messages.
CommandMessage
  POLL_WAIT_HEADER : String = "DSPollWait"
[statyczny] Header to drive an idle wait time before the next client poll request.
CommandMessage
  PRESERVE_DURABLE_HEADER : String = "DSPreserveDurable"
[statyczny] Durable JMS subscriptions are preserved when an unsubscribe message has this parameter set to true in its header.
CommandMessage
  REMOVE_SUBSCRIPTIONS : String = "DSRemSub"
[statyczny] Like the above, but specifies the subtopic/selector array of to remove
CommandMessage
  SELECTOR_HEADER : String = "DSSelector"
[statyczny] Subscribe commands issued by a Consumer pass the Consumer's selector expression in this header.
CommandMessage
  SUBSCRIBE_OPERATION : uint = 0
[statyczny] This operation is used to subscribe to a remote destination.
CommandMessage
  SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10
[statyczny] This operation is used to indicate that the client's subscription with a remote destination has timed out.
CommandMessage
  SUBTOPIC_SEPARATOR : String = "_;_"
[statyczny] The separator string used for separating subtopic and selectors in the add and remove subscription headers.
CommandMessage
  TRIGGER_CONNECT_OPERATION : uint = 13
[statyczny] This operation is used to trigger a ChannelSet to connect.
CommandMessage
  UNKNOWN_OPERATION : uint = 10000
[statyczny] This is the default operation for new CommandMessage instances.
CommandMessage
  UNSUBSCRIBE_OPERATION : uint = 1
[statyczny] This operation is used to unsubscribe from a remote destination.
CommandMessage
Szczegół właściwości

operation

właściwość
public var operation:uint

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Provides access to the operation/command for the CommandMessage. Operations indicate how this message should be processed by the remote destination.

Konstruktor Szczegół

CommandMessage

()Konstruktor
public function CommandMessage()

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Constructs an instance of a CommandMessage with an empty body and header and a default operation of UNKNOWN_OPERATION.

Szczegół metody

getOperationAsString

()metoda
public static function getOperationAsString(op:uint):String

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Provides a description of the operation specified. This method is used in toString() operations on this message.

Parametry

op:uint — One of the CommandMessage operation constants.

Zwraca
String — Short name for the operation.

Przykład
Sposób korzystania z tego przykładu
         var msg:CommandMessage = CommandMessage(event.message);
         trace("Current operation -'"+
                CommandMessage.getOperationAsString(msg.operation)+ "'.");
      

toString

()metoda 
override public function toString():String

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Returns a string representation of the message.

Zwraca
String — String representation of the message.
Szczegół stałej

ADD_SUBSCRIPTIONS

Stała
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector pairs to add to the existing set of subscriptions.

AUTHENTICATION_MESSAGE_REF_TYPE

Stała 
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

The server message type for authentication commands.

CLIENT_PING_OPERATION

Stała 
public static const CLIENT_PING_OPERATION:uint = 5

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to test connectivity over the current channel to the remote endpoint.

CLIENT_SYNC_OPERATION

Stała 
public static const CLIENT_SYNC_OPERATION:uint = 4

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used by a remote destination to sync missed or cached messages back to a client as a result of a client issued poll command.

CLUSTER_REQUEST_OPERATION

Stała 
public static const CLUSTER_REQUEST_OPERATION:uint = 7

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.

CREDENTIALS_CHARSET_HEADER

Stała 
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header to specify which character set encoding was used while encoding login credentials.

DISCONNECT_OPERATION

Stała 
public static const DISCONNECT_OPERATION:uint = 12

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to indicate that a channel has disconnected.

HEARTBEAT_HEADER

Stała 
public static const HEARTBEAT_HEADER:String = "DS<3"

Header that indicates the message is a heartbeat.

LOGIN_OPERATION

Stała 
public static const LOGIN_OPERATION:uint = 8

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to send credentials to the endpoint so that the user can be logged in over the current channel. The credentials need to be Base64 encoded and stored in the body of the message.

LOGOUT_OPERATION

Stała 
public static const LOGOUT_OPERATION:uint = 9

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.

MAX_FREQUENCY_HEADER

Stała 
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header to indicate the maximum number of messages a Consumer wants to receive per second.

MESSAGING_VERSION

Stała 
public static const MESSAGING_VERSION:String = "DSMessagingVersion"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Endpoints can imply what features they support by reporting the latest version of messaging they are capable of during the handshake of the initial ping CommandMessage.

MULTI_SUBSCRIBE_OPERATION

Stała 
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Used by the MultiTopicConsumer to subscribe/unsubscribe for more than one topic in the same message.

NEEDS_CONFIG_HEADER

Stała 
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header to indicate that the Channel needs the configuration from the server.

NO_OP_POLL_HEADER

Stała 
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header to suppress poll response processing. If a client has a long-poll parked on the server and issues another poll, the response to this subsequent poll should be tagged with this header in which case the response is treated as a no-op and the next poll will not be scheduled. Without this, a subsequent poll will put the channel and endpoint into a busy polling cycle.

POLL_OPERATION

Stała 
public static const POLL_OPERATION:uint = 2

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to poll a remote destination for pending, undelivered messages.

POLL_WAIT_HEADER

Stała 
public static const POLL_WAIT_HEADER:String = "DSPollWait"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Header to drive an idle wait time before the next client poll request.

PRESERVE_DURABLE_HEADER

Stała 
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Durable JMS subscriptions are preserved when an unsubscribe message has this parameter set to true in its header.

REMOVE_SUBSCRIPTIONS

Stała 
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Like the above, but specifies the subtopic/selector array of to remove

SELECTOR_HEADER

Stała 
public static const SELECTOR_HEADER:String = "DSSelector"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

Subscribe commands issued by a Consumer pass the Consumer's selector expression in this header.

SUBSCRIBE_OPERATION

Stała 
public static const SUBSCRIBE_OPERATION:uint = 0

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to subscribe to a remote destination.

SUBSCRIPTION_INVALIDATE_OPERATION

Stała 
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to indicate that the client's subscription with a remote destination has timed out.

SUBTOPIC_SEPARATOR

Stała 
public static const SUBTOPIC_SEPARATOR:String = "_;_"

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

The separator string used for separating subtopic and selectors in the add and remove subscription headers.

TRIGGER_CONNECT_OPERATION

Stała 
public static const TRIGGER_CONNECT_OPERATION:uint = 13

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to trigger a ChannelSet to connect.

UNKNOWN_OPERATION

Stała 
public static const UNKNOWN_OPERATION:uint = 10000

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This is the default operation for new CommandMessage instances.

UNSUBSCRIBE_OPERATION

Stała 
public static const UNSUBSCRIBE_OPERATION:uint = 1

Wersja języka: ActionScript 3.0
Wersje produktu: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Wersje środowiska wykonawczego: Flash Player 9, AIR 1.1

This operation is used to unsubscribe from a remote destination.





[ X ]Dlaczego język angielski?
Treść dokumentacji języka ActionScript 3.0 wyświetlana w języku angielskim

Niektóre części dokumentacji języka ActionScript 3.0 nie są przetłumaczone na poszczególne języki. Gdy element nie jest przetłumaczony na dany język, jest wyświetlany tekst angielski. Na przykład opis klasy ga.controls.HelpBox nie jest przetłumaczony na żaden dodatkowy język. Z tego powodu polska wersja dokumentacji zawiera opis klasy ga.controls.HelpBox w języku angielskim.