dom.objects.UserProfile

	Method	Defined By
		Non-Standard Obsolete addReadRequest(attributeName:DOMString, reserved:* = null):Boolean Adds an entry to the queue for read requests.	UserProfile
		Non-Standard Obsolete clearRequest():void Clears all requests in the read-requests queue to prepare for new profile-information requests.	UserProfile
		Non-Standard Obsolete doReadRequest(usageCode:Number, friendlyName:DOMString = null, domain:DOMString = null, path:DOMString = null, expiration:* = null, reserved:* = null):void Performs all requests located in the read-requests queue.	UserProfile
		Non-Standard Obsolete getAttribute(attributeName:DOMString):void Returns the value of the named attribute from the userProfile object.	UserProfile
		Non-Standard Obsolete setAttribute(attrName:DOMString, value:Number, caseSensitive:*):void Sets the value of the specified attribute.	UserProfile

Method Detail

Non-Standard Obsolete addReadRequest

()

method

public function addReadRequest(attributeName:DOMString, reserved:* = null):Boolean

Non-standard (Microsoft)

Obsolete

Adds an entry to the queue for read requests.

Note: This method appends a vCard name to the read-requests queue. The read-requests queue is a list of read requests waiting to be initiated. To initiate the accumulated, or compound, read requests in the queue, call doReadRequest. To clear the queue, call clearRequest.

Parameters

	`attributeName:DOMString` — Specifies one of the standard vCard names. If anything else is used, the request is ignored and nothing is added to the read-requests queue.

	`reserved:*` (default = `null`) — Windows Internet Explorer currently ignores this parameter.

Returns

Boolean — True if the request has been successfully added to the queue. False if the attribute name was not recognized or the attribute already appeared in the request queue.

See also

MSDN - addReadRequest Method

Non-Standard Obsolete clearRequest

()

method

public function clearRequest():void

Non-standard (Microsoft)

Obsolete

Clears all requests in the read-requests queue to prepare for new profile-information requests.

See also

MSDN - clearRequest Method

Non-Standard Obsolete doReadRequest

()

method

 public function doReadRequest(usageCode:Number, friendlyName:DOMString = null, domain:DOMString = null, path:DOMString = null, expiration:* = null, reserved:* = null):void

Non-standard (Microsoft)

Obsolete

Performs all requests located in the read-requests queue.

Parameters

usageCode:Number — Specifies the code that notifies the user of the type of access requested. This usage code should be one of the following 13 codes defined by the Internet Privacy Working Group (IPWG).

Title	Value
0	Used for system administration.
1	Used for research and product development.
2	Used for completion and support of the current transaction.
3	Used to customize the content and design of a site.
4	Used to improve the content of a site that includes advertisements.
5	Used for notifying visitors about updates to the site.
6	Used for contacting visitors for marketing of services or products.
7	Used for linking other collected information.
8	Used by a site for other purposes.
9	Disclosed to others for customization or improvement of the content and design of the site.
10	Disclosed to others, who may contact the user, for marketing of services or products.
11	Disclosed to others, who may contact the user, for marketing of services or products. The user can ask a site not to do this.
12	Disclosed to others for any other purpose.

friendlyName:DOMString (default = null) — Specifies the display name of the party requesting access to private information. For security reasons, it is not sufficient for the user agent to show this display name to the user. In addition to display name, the user agent must display the URL that originates the script requesting profile access. If this script originates from a secure connection (for example, SSL), the Web author can use the SSL certificate to reliably identify the party requesting access.

domain:DOMString (default = null) — Specifies the pages that the user's choice will apply to in addition to the current page. The specification follows the cookie standard.

path:DOMString (default = null) — Specifies the path to the domain server requesting access. When vExpiration is set, the path is saved with the requested attributes.

expiration:* (default = null) — Specifies the amount of time the site has requested access to these attributes. This is currently ignored by Windows Internet Explorer.

reserved:* (default = null) — This parameter is reserved.

See also

MSDN - doReadRequest Method

Non-Standard Obsolete getAttribute

()

method

public function getAttribute(attributeName:DOMString):void

Non-standard (Microsoft)

Obsolete

Returns the value of the named attribute from the userProfile object.

Note: The following schema is used for the field names of the user data store. These names are specified when you use the getAttribute method on the userProfile object. Note that the format has changed from vCard_xxx to vCard.xxx, and that the older format no longer is supported.

Note: An asterisk ( denotes extensions to the vCard schema. Extensions are referenced as X- elements, as defined in the vCard schema.

vCard Names
vCard.Business.City	vCard.Business.Country	vCard.Business.Fax
vCard.Business.Phone	vCard.Business.State	vCard.Business.StreetAddress
vCard.Business.URL	vCard.Business.Zipcode	vCard.Cellular
vCard.Company	vCard.Department	vCard.DisplayName
vCard.Email	vCard.FirstName	vCard.Gender*
vCard.Home.City	vCard.Home.Country	vCard.Home.Fax
vCard.Home.Phone	vCard.Home.State	vCard.Home.StreetAddress
vCard.Home.Zipcode	vCard.Homepage	vCard.JobTitle
vCard.LastName	vCard.MiddleName	vCard.Notes
vCard.Office	vCard.Pager

Parameters

attributeName:DOMString — One of the standard vCard names listed in Remarks. If one of these names is not used, the request is ignored.

See also

MSDN - getAttribute Method

Non-Standard Obsolete setAttribute

()

method

public function setAttribute(attrName:DOMString, value:Number, caseSensitive:*):void

Non-standard (Microsoft)

Obsolete

Sets the value of the specified attribute.

Note (IE8): Internet Explorer 8 and later. IE8 mode enables several enhancements to the setAttribute, getAttribute, and removeAttribute methods that are not available when pages are displayed in earlier document modes.

The attrName parameter requires the name of the desired content attribute and not the Document Object Model (DOM) attribute. For example, in IE8 mode, this method no longer requires attrName to be "className" when setting, getting, or removing a CLASS attribute. Earlier versions of Internet Explorer and Internet Explorer 8 in compatibility mode still require attrName to specify the corresponding DOM property name.
The attrName parameter is not case sensitive. As a result, the iCaseSensitive parameter is no longer supported and should not be used.
The methods support event handlers. For example, the following code example defines an event handler to call a function called SomeFunction when the body of the page is loaded.
```
document.body.setAttribute('onload', 'SomeFunction()');
```

If the specified attribute is not already present, the setAttribute method adds the attribute to the object and sets the value.

Note: If your pages are displayed in IE5 mode or IE7 mode, be careful when spelling attribute names. If you set caseSensitive to 1 and the attrName parameter does not have the same uppercase and lowercase letters as the attribute, a new attribute is created for the object. If two or more attributes have the same name, differing only in case, and caseSensitive is set to 0, this method assigns values only to the first attribute created with this name. All other attributes of the same name are ignored.

Note (IE8): Internet Explorer 8 and later. When pages are displayed in IE8 mode, the value parameter only supports string values. Non-string values are not automatically converted to string values. For best results, formally convert values to strings before using them as parameter values. For example, do not attempt to pass an object directly to the value parameter; call the object's toString method instead.

Parameters

	`attrName:DOMString` — The name of the attribute.

	`value:Number` — The string, number, or Boolean to assign to the attribute.

	`caseSensitive:*` (default = `NaN`) — Whether to use a case-sensitive search to locate the attribute. Can be one of the following values: 1 - The case of attrName is respected. 0 - TMatch attrName regardless of case.

See also

MSDN - getAttribute Method

Mon Aug 17 2009, 10:08 AM -04:00

DOM Reference Manual		All Packages \| All Classes \| Index \| Frames No Frames
UserProfile	Methods

Package	dom.objects
Class	public class UserProfile
Inheritance	UserProfile Object