(Beta)
| Package | lc.foundation.domain |
| Class | public class Group |
| Inheritance | Group  DomainObject Object |
| 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 |
Group class represents a group principal in LiveCycle ES2
and is used for retrieving the members of a given group.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| canonicalName : String
The canonical name of the group. | Group | ||
| commonName : String
The common name of the group. | Group | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| description : String
The description of the group. | Group | ||
| domain : String
The domain of the group. | Group | ||
| email : String
The email address of the group. | Group | ||
| emailAliases : Array
The email aliases used by the group. | Group | ||
| oid : String
The unique object identifier of the group. | Group | ||
| organization : String
The organization name of the group. | Group | ||
| session : SessionMap [read-only]
A SessionMap object that stores information relating to the server session. | DomainObject | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Retrieves the members of the group. | Group | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
canonicalName | property |
canonicalName: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 canonical name of the group.
Implementation
public function get canonicalName():String public function set canonicalName(value:String):voidcommonName | property |
commonName: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 common name of the group.
Implementation
public function get commonName():String public function set commonName(value:String):voiddescription | 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 of the group.
Implementation
public function get description():String public function set description(value:String):voiddomain | property |
domain: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 domain of the group.
Implementation
public function get domain():String public function set domain(value:String):void| property |
email: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 email address of the group.
Implementation
public function get email():String public function set email(value:String):voidemailAliases | property |
emailAliases:Array| 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 email aliases used by the group.
Implementation
public function get emailAliases():Array public function set emailAliases(value:Array):voidoid | property |
oid: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 object identifier of the group.
Implementation
public function get oid():String public function set oid(value:String):voidorganization | property |
organization: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 organization name of the group.
Implementation
public function get organization():String public function set organization(value:String):voidMethod Detail
getMembers | () | method |
public function getMembers():lc.foundation.util:CollectionToken| 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 |
Retrieves the members of the group.
Returnslc.foundation.util:CollectionToken — A CollectionToken object that represents a collection of users or nested groups.
|
Wed Nov 21 2018, 06:34 AM -08:00