| Package | com.adobe.livecycle.ria.security.service |
| Class | public class Pin |
| Inheritance | Pin  Object |
| Implements | IPin |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Pin object is a type of ticket which can be used to authenticate a user in remote call.
A pin instance is typically used to perform authentication for file uploads. The pin can be
obtained by using the ISecurityManager.getTicket method.
Related API Elements
ISecurityManager.getTicket
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 | |
| enabled : Boolean
A flag that indicates whether a pin is enabled. | Pin | ||
| expiry : Date
The date and time when the pin expires. | Pin | ||
| id : String
An identifier to uniquely identify a pin on the server-side. | Pin | ||
| maxUse : int
The maximum number of times a pin can be used. | Pin | ||
| owner : String
The user who the pin is assigned or issued to. | Pin | ||
| useCounter : int
The number of times the current pin has been used in calls made to Experience Server. | Pin | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Pin()
Constructor. | Pin | ||
|
Indicates whether an object has a specified property defined. | Object | |
Determines whether the current pin has expired. | Pin | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Determines whether a pin usage has exceeded the maximum usage limit. | Pin | ||
Determines whether a pin is valid and can be used. | Pin | ||
|
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
enabled | property |
enabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A flag that indicates whether a pin is enabled. A value of True specifies that the pin is enabled.
Implementation
public function get enabled():Boolean public function set enabled(value:Boolean):voidexpiry | property |
expiry:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The date and time when the pin expires.
Implementation
public function get expiry():Date public function set expiry(value:Date):voidid | property |
id:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
An identifier to uniquely identify a pin on the server-side.
Implementation
public function get id():String public function set id(value:String):voidmaxUse | property |
maxUse:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The maximum number of times a pin can be used.
Implementation
public function get maxUse():int public function set maxUse(value:int):voidowner | property |
owner:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The user who the pin is assigned or issued to.
Implementation
public function get owner():String public function set owner(value:String):voiduseCounter | property |
useCounter:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The number of times the current pin has been used in calls made to Experience Server.
Implementation
public function get useCounter():int public function set useCounter(value:int):voidConstructor Detail
Pin | () | Constructor |
public function Pin()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
Method Detail
isPinExpired | () | method |
public function isPinExpired():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Determines whether the current pin has expired.
ReturnsBoolean — A boolean value to indicate whether the pin has expired. A value of True indicates that the
pin expired.
|
isUseCounterExceededMaxUsage | () | method |
public function isUseCounterExceededMaxUsage():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Determines whether a pin usage has exceeded the maximum usage limit.
ReturnsBoolean — A flag to indicate whether the pin usage exceeds the maximum usage.
A value of True indicates that the pin usage count exceeds the maximum use limit.
|
isValid | () | method |
public function isValid():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Determines whether a pin is valid and can be used.
A pin is considered to be valid if it has not expired and its usage count is less than the maximum allowed limit.
ReturnsBoolean — A boolean value that indicates whether the pin is valid. A value of True indicates that the pin is valid.
|
Thu Dec 6 2018, 01:12 PM -08:00