| Package | lc.foundation |
| Class | public class UserManager |
| Inheritance | UserManager  Manager |
| Implements | IUserManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
UserManager class is the standard implementation of the
IUserManager interface.
Public Methods
| Method | Defined By | ||
|---|---|---|---|
UserManager(session:SessionMap)
Constructor. | UserManager | ||
Retrieves the groups that match the specified substring. | UserManager | ||
Retrieves the users that match the specified substring. | UserManager | ||
findUsersInGroup(groupOid:String, commonNameFilter:String = null):lc.foundation.util:CollectionToken
Retrieves a list of users who have a common name, who are members in the group specified by the group's OID. | UserManager | ||
findUsersWithPermission(commonNameFilter:String, serviceName:String):lc.foundation.util:CollectionToken
Retrieves the users that match the specified substring and have invoke
permissions to the service. | UserManager | ||
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| MSG_GET_GROUPS_ERROR : String = "ALC-WKS-007-121" [static]
A special value that specifies an error occurred retrieving group information. | UserManager | ||
| SESSION_KEY : String = "lc.foundation.IUserManager" [static]
A special value that specifies the manager key name in the SessionMap object. | UserManager | ||
Constructor Detail
UserManager | () | Constructor |
public function UserManager(session:SessionMap)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Parameterssession:SessionMap — Specifies the location of the server URL. If the URL is a value of
null, the default is to access the Document Server at the
same location where Workspace SWF file is loaded from.
|
Method Detail
findGroups | () | method |
public function findGroups(commonNameFilter:String):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the groups that match the specified substring. The matching is performed against the display name of the group. For example, "ample" would match groups named SampleOrganization. Matching is not case-sensitive.
Parameters
commonNameFilter:String — Specifies a substring to match.
|
lc.foundation.util:CollectionToken — A token containing a collection of Group objects
when the request completes. Set result and fault handlers on the
token that executes when the invocation completes and the collection
is populated.
|
findUsers | () | method |
public function findUsers(commonNameFilter:String):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the users that match the specified substring. A match is made against the display name of the user. For example, "ikira" would match "Akira Tanaka". Matching is not case-sensitive.
Parameters
commonNameFilter:String — Specifies a substring to match.
|
lc.foundation.util:CollectionToken — A token containing a collection of User objects
when the request completes. Set result and fault handlers on
the token that executes when the invocation completes and the
collection is populated.
|
findUsersInGroup | () | method |
public function findUsersInGroup(groupOid:String, commonNameFilter:String = null):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a list of users who have a common name, who are members in the group specified by the group's OID.
If the commonNamePattern parameter is not supplied, it will return the users who are members
of the group specified by the groupOID parameter.
Parameters
groupOid:String — Specifies the OID of the group.
| |
commonNameFilter:String (default = null)null.
|
lc.foundation.util:CollectionToken — A token containing a collection of User objects when the request
completes. Set result and fault handlers on the
token that executes when the invocation completes and the collection is populated.
|
findUsersWithPermission | () | method |
public function findUsersWithPermission(commonNameFilter:String, serviceName:String):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the users that match the specified substring and have invoke permissions to the service. The matching is performed against the display name of the user. For example, ikira would match Akira Tanaka. Matching is not case sensitive.
Parameters
commonNameFilter:String — Specifies a substring to match.
| |
serviceName:String — Specifies the service name.
|
lc.foundation.util:CollectionToken — A token containing a collection of User objects
when the request completes. Set result and fault handlers on the
token that executes when the invocation completes and the collection is populated.
|
Constant Detail
MSG_GET_GROUPS_ERROR | Constant |
public static const MSG_GET_GROUPS_ERROR:String = "ALC-WKS-007-121"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies an error occurred retrieving group information.
SESSION_KEY | Constant |
public static const SESSION_KEY:String = "lc.foundation.IUserManager"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies the manager key name in the SessionMap object.
Thu Dec 6 2018, 01:12 PM -08:00