Indy 9 | Content | Index | Reference

TIdAuthenticationItem
Hierarchy, Properties, Methods, See Also, Unit: IdAuthenticationManager
Represents an authentication mechanism used in a TIdAuthenticationCollection collection.

    TIdAuthenticationItem = class(TCollectionItem)

Unit
IdAuthenticationManager
Description
TIdAuthenticationItem is a TCollectionItem descendant that implements items maintained in a TIdAuthenticationCollection collection. TIdAuthenticationItem represents the individual authentication mechanisms used for HTTP client requests, including the URL and identity and authorization values provoded as parameters in a client request.

TIdAuthenticationItem.Params
TIdAuthenticationItem, See Also
Represent arguments used with an authentication mechanism.

    property Params: TStringList;

Description
Params is a TStringList property that represents the arguments provided for an authentication mechanism added to the collection maintained by TIdAuthenticationManager. Params is used with URL to store the information required to use the authentication mechanism.

Params is initialized in the Create constructor, and released in the Destroy destructor. Write access to the Params property calls Assign to transfer the values from a TStringList to the property.

TIdAuthenticationItem.URL
TIdAuthenticationItem, See Also

    property URL: TIdURI;

Description
URL is a TIdURI property that represents the resource location for the authetication added to the colletion maintained by TIdAuthenticationManager. URL is use with Params to store the information required to use the authentication mechanism.

URL is initialized in the Create constructor, and released in the Destroy destructor. Write access to the URL property copies the URI for the new value to the URI for the property.

TIdAuthenticationItem.Create
TIdAuthenticationItem, See Also
Constructor for the authentication object instance.

    constructor Create(ACollection: TCOllection); override;

Parameters
ACollection: TCOllection
Collection that owns the object instance.
Description
Create is the constructor for the authentication object instance. Create calls the inherited Create method using ACollection as the owner of the object instance. Create also allocates resources required for the URL and Params properties for the authentication mechanism.

TIdAuthenticationItem.Destroy
TIdAuthenticationItem, See Also
Destructor for the object instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the object instance. Destroy frees resources allocated in Create for the URL and Params properties. Destroy calls the inherited Destroy method prior to exiting.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.