Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
com.adobe.icc.vo 

User  - AS3 Asset Composer

パッケージcom.adobe.icc.vo
クラスpublic class User
継承User Inheritance Object
実装 IEventDispatcher

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Represents the information about the user object



パブリックプロパティ
 プロパティ定義元
  clientSsoExpirationHint : Date
This method returns the sso session expiration time as per client's clock.
User
  commonName : String
User common name
User
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  domainName : String
Name of the user domain
User
  email : String
User email id
User
  expirationHint : Date
Expiration time of the user session
User
  firstName : String
First name of the user
User
  groups : IList
List of Permission Strings that this user is part of - Permission string format already mentioned above
User
  lastName : String
Last name of the user
User
  lcAuthToken : String
Lc Authentication Token of the user.
User
  loginId : String
login id of user
User
  roles : IList
List of Role Strings that this user is part of
User
パブリックメソッド
 メソッド定義元
  
Constructor
User
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
User
  
Dispatches an event into the event flow.
User
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
User
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
User
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
User
プロパティの詳細

clientSsoExpirationHint

プロパティ
clientSsoExpirationHint:Date

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

This method returns the sso session expiration time as per client's clock. So if the client machine is running few minutes before or after actual time, this method will take care of it.



実装
    public function get clientSsoExpirationHint():Date
    public function set clientSsoExpirationHint(value:Date):void

commonName

プロパティ 
commonName:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

User common name



実装
    public function get commonName():String
    public function set commonName(value:String):void

domainName

プロパティ 
domainName:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Name of the user domain



実装
    public function get domainName():String
    public function set domainName(value:String):void

email

プロパティ 
email:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

User email id



実装
    public function get email():String
    public function set email(value:String):void

expirationHint

プロパティ 
expirationHint:Date

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Expiration time of the user session



実装
    public function get expirationHint():Date
    public function set expirationHint(value:Date):void

firstName

プロパティ 
firstName:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

First name of the user



実装
    public function get firstName():String
    public function set firstName(value:String):void

groups

プロパティ 
groups:IList

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 10
ランタイムバージョン: AIR (unsupported), Flash Player 10.2

List of Permission Strings that this user is part of - Permission string format already mentioned above



実装
    public function get groups():IList
    public function set groups(value:IList):void

lastName

プロパティ 
lastName:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Last name of the user



実装
    public function get lastName():String
    public function set lastName(value:String):void

lcAuthToken

プロパティ 
lcAuthToken:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Lc Authentication Token of the user.



実装
    public function get lcAuthToken():String
    public function set lcAuthToken(value:String):void

loginId

プロパティ 
loginId:String

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

login id of user



実装
    public function get loginId():String
    public function set loginId(value:String):void

roles

プロパティ 
roles:IList

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

List of Role Strings that this user is part of



実装
    public function get roles():IList
    public function set roles(value:IList):void
コンストラクターの詳細

User

()コンストラクター
public function User()

言語バージョン: ActionScript 3.0
製品バージョン: Asset Composer Building Block 9.5
ランタイムバージョン: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor

メソッドの詳細

addEventListener

()メソッド
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

パラメーター

type:String — The type of event.
 
listener:Function — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows:

function(evt:Event):void

The function can have any name.
 
useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener() twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
weakRef:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()メソッド 
public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

パラメーター

event:Event — The event object dispatched into the event flow.

戻り値
Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()メソッド 
public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

パラメーター

type:String — The type of event.

戻り値
Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()メソッド 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

パラメーター

type:String — The type of event.
 
listener:Function — The listener object to remove.
 
useCapture:Boolean (default = false) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.

willTrigger

()メソッド 
public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

パラメーター

type:String — The type of event.

戻り値
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。