Class AntiForgeryKeyPolicy

Hierarchy

PolicyBase
- AntiForgeryKeyPolicy

Implements

IPolicy

Index

Constructors

constructor

Properties

token
url

Methods

Constructors

constructor

new AntiForgeryKeyPolicy(settings: IAntiForgeryKeyCtorOptions): AntiForgeryKeyPolicy

Overrides PolicyBase.constructor
- Defined in security/antiforgerykey-policy.ts:57
constructor

AntiForgeryKeyPolicy

Parameters
- settings: IAntiForgeryKeyCtorOptions
Returns AntiForgeryKeyPolicy

Properties

Protected token

token: string

Protected url

url: string

Methods

applyTo

applyTo(options: any): void

Implementation of IPolicy.applyTo

Overrides PolicyBase.applyTo
- Defined in security/antiforgerykey-policy.ts:126
Applys the anti-forgery key and its value to the given options.

function

apply

Parameters
- options: any
  
  The options to be used for making a request.
Returns void

applyToV2

applyToV2(options: any): void

Implementation of IPolicy.applyToV2

Overrides PolicyBase.applyToV2
- Defined in security/antiforgerykey-policy.ts:136
Apply security policy to the given options.

function

applyToV2

Parameters
- options: any
  
  A params field is expected.
Returns void

applyToV3

applyToV3(options: any): void

Implementation of IPolicy.applyToV3

Overrides PolicyBase.applyToV3
- Defined in security/antiforgerykey-policy.ts:142
Parameters
- options: any
Returns void

getTokenInternal

getTokenInternal(): PromiseLike<string>

Implementation of IPolicy.getTokenInternal

Overrides PolicyBase.getTokenInternal
- Defined in security/antiforgerykey-policy.ts:111
Gets the anti-forgery token from the given url or the instance url.

function

getTokenP

throws

{}

Returns PromiseLike<string>

getTokenP

getTokenP(): PromiseLike<string>

Implementation of IPolicy.getTokenP

Inherited from PolicyBase.getTokenP
- Defined in security/policy-base.ts:44
The interface for retrieving the token from a remote server. This method internally dispatches the call to another method and cache the token.

Returns PromiseLike<string>

inputField

inputField(): string

- Defined in security/antiforgerykey-policy.ts:75
Returns string

isExpired

isExpired(): boolean

Implementation of IPolicy.isExpired

Overrides PolicyBase.isExpired
- Defined in security/antiforgerykey-policy.ts:71
Returns boolean

persistent

persistent(): object

Implementation of IPolicy.persistent

Overrides PolicyBase.persistent
- Defined in security/antiforgerykey-policy.ts:95
Returns the object that are persistentable.

function

persistent

Returns object
- token: string

readFrom

readFrom(settings: any): void

Overrides PolicyBase.readFrom
- Defined in security/antiforgerykey-policy.ts:86
Feeds the policy with some settings from outside, usually from local storage

function

readFrom

Parameters
- settings: any
Returns void

reset

reset(): void

Implementation of IPolicy.reset

Overrides PolicyBase.reset
- Defined in security/antiforgerykey-policy.ts:149
Resets the token and expired flag

function

reset

Returns void

Generated using TypeDoc