(Beta)
| Package | lc.foundation |
| Interface | public interface ISessionManager extends IManager , IEventDispatcher |
| Implementors | SessionManager |
| 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 |
ISessionManager interface is implemented to expose operations and properties related
to the LiveCycle ES server session. You implement this interface to authenticate a user and provide
the session that is required for all other server operations.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| authenticatedUser : User
The authenticated user, after the successful
call using the login or singleSignOn methods. | ISessionManager | ||
| buildDate : String [read-only]
The build date. | ISessionManager | ||
| buildNumber : String [read-only]
The build number. | ISessionManager | ||
| channelSet : ChannelSet [read-only]
The ChannelSet object that is used by the base connectivity. | ISessionManager | ||
| clientUrl : String [read-only]
The server address, as a URL, for the client collateral. | ISessionManager | ||
 | faultHandler : Function
The default fault handler function. | IManager | |
| loadLocationUrl : String [read-only]
The server URL from which the SWF file is loaded. | ISessionManager | ||
| remotingChannelSet : ChannelSet [read-only]
A ChannelSet object that is appropriate for use with LiveCycle Remoting. | ISessionManager | ||
| serverUrl : String [read-only]
The server address, as a URL, for the server session. | ISessionManager | ||
| userAssertion : String [read-only]
The SAML assertion data that can be used to pass authentication to
LiveCycle Data Services ES2. | ISessionManager | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
Retrieves a RemoteObject object
configured with the authenticated user's credentials for invoking
the specified LiveCycle Remoting endpoint. | ISessionManager | ||
|
Determines whether the default operation is prevented. | IManager | |
|
Determines whether the default operation is prevented. | IManager | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Logs in to the server, authenticating the user. | ISessionManager | ||
Logs off the server, which invalidates the server session. | ISessionManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Determines whether an authenticated session to the LiveCycle ES2 server already
exists or can be established without additional information, such as in single sign-on (SSO). | ISessionManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Property Detail
authenticatedUser | property |
authenticatedUser:User| 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 authenticated user, after the successful
call using the login or singleSignOn methods.
Implementation
public function get authenticatedUser():User public function set authenticatedUser(value:User):voidbuildDate | property |
buildNumber | property |
channelSet | property |
channelSet:ChannelSet [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 |
The ChannelSet object that is used by the base connectivity.
Implementation
public function get channelSet():ChannelSetclientUrl | property |
clientUrl:String [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 |
The server address, as a URL, for the client collateral.
Implementation
public function get clientUrl():StringloadLocationUrl | property |
loadLocationUrl:String [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 |
The server URL from which the SWF file is loaded. The URL does not include the name of the SWF file.
Implementation
public function get loadLocationUrl():StringremotingChannelSet | property |
remotingChannelSet:ChannelSet [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 ChannelSet object that is appropriate for use with LiveCycle Remoting.
Generally, using the getRemotingEndpoint method is more convenient.
Implementation
public function get remotingChannelSet():ChannelSetRelated API Elements
serverUrl | property |
serverUrl:String [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 |
The server address, as a URL, for the server session.
Implementation
public function get serverUrl():StringuserAssertion | property |
userAssertion:String [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 |
The SAML assertion data that can be used to pass authentication to LiveCycle Data Services ES2.
Implementation
public function get userAssertion():StringMethod Detail
getRemotingEndpoint | () | method |
public function getRemotingEndpoint(endpointName:String):RemoteObject| 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 a RemoteObject object
configured with the authenticated user's credentials for invoking
the specified LiveCycle Remoting endpoint. Successful authentication
is a prerequisite.
Parameters
endpointName:String — Specifies the name of the LiveCycle Remoting endpoint.
|
RemoteObject — An object configured to invoke the specified process as the
currently authenticated user.
|
login | () | method |
public function login(userid:String, password:String):lc.foundation.util:Token| 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 |
Logs in to the server, authenticating the user.
Parameters
userid:String — Specifies the user profile.
| |
password:String — Specifies the password.
|
lc.foundation.util:Token — A Token object used to set result and fault handlers that execute when the
operation completes.
|
logout | () | method |
public function logout():lc.foundation.util:Token| 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 |
Logs off the server, which invalidates the server session.
Returnslc.foundation.util:Token — A token used to set result and fault handlers that execute when the
operation completes.
|
singleSignOn | () | method |
public function singleSignOn():lc.foundation.util:Token| 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 |
Determines whether an authenticated session to the LiveCycle ES2 server already exists or can be established without additional information, such as in single sign-on (SSO). If an authenticated session is established, the server session is valid and the result handler on the returned token is called. If an authenticated session is not established, the fault handler is called.
Returnslc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
Wed Nov 21 2018, 06:34 AM -08:00