AttachmentInfo - BETA ActionScript® 3 (AS3 ADEP Document Services) Reference for the Adobe® Flash® Platform API Reference

(Beta)

Package	lc.procmgmt.domain
Class	public class AttachmentInfo
Inheritance	AttachmentInfo Object
Implements	IManagedObject, IManaged

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The AttachmentInfo class provides support for managing attachments and notes with tasks.

Notes and attachments are handled by this class. The first 255 characters of a note are stored in the description field. If the note has more than 255 characters, it is stored as an extended note in a file. A file that is attached to a task is handled in the same manner as an attachment.

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
		creationDate : Date The creation date of the attachment.	AttachmentInfo
		creatorId : String The unique identifier for the user who created the attachment or note.	AttachmentInfo
		creatorName : String The display name of the user who created the attachment.	AttachmentInfo
		description : String The description for the attachment.	AttachmentInfo
		fileName : String The file name for the attachment.	AttachmentInfo
		id : String The identifier for the attachment or note.	AttachmentInfo
		lastModifiedDate : Date The last date the attachment was changed.	AttachmentInfo
		noteExtended : Boolean A flag that indicates whether the note is extended.	AttachmentInfo
		permissions : AttachmentPermissions The permissions assigned to the attachment.	AttachmentInfo
		session : SessionMap [read-only] A SessionMap object that stores information relating to the server session.	AttachmentInfo
		size : String The size of the attachment or note.	AttachmentInfo
		taskId : String The unique identifier for the task.	AttachmentInfo
		type : String The type of attachment.	AttachmentInfo

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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.	AttachmentInfo
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	AttachmentInfo
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	AttachmentInfo
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	AttachmentInfo
		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
		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.	AttachmentInfo

Public Constants

	Constant		Defined By
		TYPE_ATTACHMENT : String = "attachment" [static] A special value that specifies an attachment is being stored.	AttachmentInfo
		TYPE_NOTE : String = "note" [static] A special value that specifies a note is being stored.	AttachmentInfo

Property Detail

creationDate

property

creationDate:Date

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The creation date of the attachment.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get creationDate():Date
public function set creationDate(value:Date):void

creatorId

property

creatorId:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The unique identifier for the user who created the attachment or note.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get creatorId():String
public function set creatorId(value:String):void

creatorName

property

creatorName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The display name of the user who created the attachment.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get creatorName():String
public function set creatorName(value:String):void

description

property

description:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The description for the attachment. If the attachment is a note, it contains the content of the note.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get description():String
public function set description(value:String):void

fileName

property

fileName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The file name for the attachment.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get fileName():String
public function set fileName(value:String):void

id

property

id:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The identifier for the attachment or note.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get id():String
public function set id(value:String):void

lastModifiedDate

property

lastModifiedDate:Date

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The last date the attachment was changed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get lastModifiedDate():Date
public function set lastModifiedDate(value:Date):void

noteExtended

property

noteExtended:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A flag that indicates whether the note is extended. Extended notes have more than 255 characters and are stored in a separate file.

A value of true indicates that the note is extended and that it is necessary to retrieve the full notes from a file.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get noteExtended():Boolean
public function set noteExtended(value:Boolean):void

permissions

property

permissions:AttachmentPermissions

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The permissions assigned to the attachment.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get permissions():AttachmentPermissions
public function set permissions(value:AttachmentPermissions):void

Related API Elements

lc.procmgmt.domain.AttachmentPermissions

session

property

session:SessionMap [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A SessionMap object that stores information relating to the server session.

Implementation
public function get session():SessionMap

Related API Elements

lc.foundation.domain.SessionMap

size

property

size:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The size of the attachment or note. The size is provided in bytes.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get size():String
public function set size(value:String):void

taskId

property

taskId:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The unique identifier for the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get taskId():String
public function set taskId(value:String):void

type

property

type:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The type of attachment. It can be one of AttachmentInfo.TYPE_ATTACHMENT or AttachmentInfo.TYPE_NOTE.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get type():String
public function set type(value:String):void

Method Detail

addEventListener

()

method

 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).

Parameters

	`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

()

method

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.

Parameters

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

Returns

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

hasEventListener

()

method

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.

Parameters

type:String — The type of event.

Returns

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

removeEventListener

()

method

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.

Parameters

	`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

()

method

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.

Parameters

type:String — The type of event.

Returns

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

Constant Detail

TYPE_ATTACHMENT

Constant

public static const TYPE_ATTACHMENT:String = "attachment"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies an attachment is being stored.

TYPE_NOTE

Constant

public static const TYPE_NOTE:String = "note"

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Document Services ES2

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A special value that specifies a note is being stored.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

AttachmentInfo - AS3 ADEP Document Services

Classes x

creationDate

creatorId

creatorName

description

fileName

id

lastModifiedDate

noteExtended

permissions

session

size

taskId

type

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger

TYPE_ATTACHMENT

TYPE_NOTE