com.adobe.livecycle.ria.security.api

# IPin - AS3 ADEP Security

Package | com.adobe.livecycle.ria.security.api
Interface | public interface IPin
Implementors | 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

An `IPin` 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

| Property | Defined By
--- | --- | ---
|  | enabled : Boolean A flag that indicates whether a pin is enabled. | IPin
|  | expiry : Date The date and time when the pin expires. | IPin
|  | id : String An identifier to uniquely identify a pin on the server-side. | IPin
|  | maxUse : int The maximum number of times a pin can be used. | IPin
|  | owner : String The user who the pin is assigned or issued to. | IPin
|  | useCounter : int The number of times the current pin has been used in calls made to Experience Server. | IPin

Public Methods

| Method | Defined By
--- | --- | ---
|  | isPinExpired():Boolean Determines whether the current pin has expired. | IPin
|  | isUseCounterExceededMaxUsage():Boolean Determines whether a pin usage has exceeded the maximum usage limit. | IPin
|  | isValid():Boolean Determines whether a pin is valid and can be used. | IPin

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):void`

### expiry

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):void`

### id

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):void`

### maxUse

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):void`

### owner

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):void`

### useCounter

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):void`
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.

Returns

| `Boolean` — 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.

Returns

| `Boolean` — 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.

Returns

| `Boolean` — A boolean value that indicates whether the pin is valid. A value of `True` indicates that the pin is valid.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00