/ 
WWW-Salesforce-0.200_2
River stage zero No dependents
/ WWW::Salesforce::GetUserInfoResult

NAME

WWW::Salesforce::GetUserInfoResult - A class to help with the "GetUserInfo" in WWW::Salesforce method

DESCRIPTION

WWW::Salesforce::GetUserInfoResult is a subclass of WWW::Salesforce::SObject. This is one of the complex types Salesforce returns from a method call.

SYNOPSIS

use WWW::Salesforce;
my $sforce = WWW::Salesforce->new();

#the login method returns a WWW::Salesforce::GetUserInfoResult on success
my $uir = $sforce->login( 'username', 'password' );
die $sforce->errstr() unless $uir;

#alternately, the GetUserInfo method also returns a WWW::Salesforce::GetUserInfo
$uir = $sforce->GetUserInfo();
print $uir->userId();

METHODS

new HASH

Creates a new WWW::Salesforce::GetUserInfoResult object.

my $uir = WWW::Salesforce::GetUserInfoRequest->new();

The following are the accepted input parameters:

accessibilityMode

Boolean, defaulted to 0 (false)

currencySymbol

String. Such as $

userType

String.

profileId

IDs are valid if: ^[a-zA-Z0-9]{15,18}$

organizationId

IDs are valid if: ^[a-zA-Z0-9]{15,18}$

organizationMultiCurrency

Boolean, defaulted to 0 (false)

organizationName

String.

roleId

IDs are valid if: ^[a-zA-Z0-9]{15,18}$

userDefaultCurrencyIsoCode

String

userEmail

String

userFullName

String

userId

IDs are valid if: ^[a-zA-Z0-9]{15,18}$

userLanguage

String

userLocale

String

userName

String

userTimeZone

String

userUiSkin

String

accessibilityMode BOOLEAN
accessibilityMode

Available in API version 7.0 and later. Indicates whether user interface modifications for the visually impaired are on (true 1) or off (false 0). The modifications facilitate the use of screen readers such as JAWS.

$uir->accessibilityMode( 1 );
print $uir->accessibilityMode();
currencySymbol SYMBOL
currencySymbol

Currency symbol to use for displaying currency values. Applicable only when organizationMultiCurrency is false.

$uir->currencySymbol( '$' );
print $uir->currencySymbol();
userType TYPE
userType

Type of user license assigned to the Profile associated with the user.

$uir->userType( 'Standard' );
print $uir->userType();
profileId ID
profileId

ID of the profile associated with the role currently assigned to the user.

$uir->profileId( 'D0000002anc00000CF' );
print $uir->profileId();
organizationId ID
organizationId

ID of the organization. Allows third-party tools to uniquely identify individual organizations in Salesforce.com, which is useful for retrieving billing or organization-wide setup information.

$uir->organizationId( 'D0000003anc00000CF' );
print $uir->organizationId();
organizationMultiCurrency BOOLEAN
organizationMultiCurrency

Indicates whether the user's organization uses multiple currencies (true) or not (false).

$uir->organizationMultiCurrency( 1 );
print $uir->organizationMultiCurrency();
organizationName NAME
organizationName

Name of the user's organization or company.

$uir->organizationName( 'The Food Company' );
print $uir->organizationName();
roleId ID
roleId

Role ID of the role currently assigned to the user.

$uir->roleId( 'D0000004anc00000CF' );
print $uir->roleId();
userDefaultCurrencyIsoCode CURRENCY_CODE
userDefaultCurrencyIsoCode

Default currency ISO code. Applicable only when organizationMultiCurrency is true. When the logged-in user creates any objects that have a currency ISO code, the API uses this currency ISO code if it is not explicitly specified in the create() call.

$uir->userDefaultCurrencyIsoCode( 'USD' );
print $uir->userDefaultCurrencyIsoCode();
userEmail EMAIL_ADDRESS
userEmail

User's email address.

$uir->userEmail( 'foo@bar.com' );
print $uir->userEmail();
userFullName NAME
userFullName

User's full name.

$uir->userFullName( 'Bill Gates' );
print $uir->userFullName();
userId ID
userId

User ID.

$uir->userId( 'D0000005anc00000CF' );
print $uir->userId();
userLanguage( scalar string )

User's language, which controls the language for labels displayed in an application. String is 2-5 characters long. The first two characters are always an ISO language code, for example "fr" or "en." If the value is further qualified by country, then the string also has an underscore (_) and another ISO country code, for example "US" or "UK". For example, the string for the United States is "en_US", and the string for French Canadian is "fr_CA." For a list of the languages that Salesforce.com supports, see the Salesforce.com online help topic "What languages does Salesforce.com support?"

userLocale( scalar string )

User's locale, which controls the formatting of dates and choice of symbols for currency. The first two characters are always an ISO language code, for example "fr" or "en." If the value is further qualified by country, then the string also has an underscore (_) and another ISO country code, for example "US" or "UK". For example, the string for the United States is "en_US", and the string for French Canadian is "fr_CA."

userName( scalar string )

User's login name.

userTimeZone( scalar string )

User's time zone.

userUiSkin SKIN_NAME
userUiSkin

Available in API version 7.0 and later. Returns the value Theme2 if the user is using the newer user interface theme of the online application, labeled "Salesforce.com." Returns Theme1 if the user is using the older user interface theme, labeled "Salesforce.com Classic." In the online application, this look and feel setting is configurable at Setup | Customize | User Interface. See http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_partner_themes.htm#topic-title.

SUPPORT

Please visit Salesforce.com's user/developer forums online for assistance with this module. You are free to contact the author directly if you are unable to resolve your issue online.

SEE ALSO

WWW::Salesforce by Chase Whitener

DBD::Salesforce by Jun Shimizu

SOAP::Lite by Byrne Reese

Examples on Salesforce website:

http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_getuserinfo_getuserinforesult.htm

http://www.salesforce.com/us/developer/docs/api/index.htm

AUTHORS

Chase Whitener <cwhitener at gmail dot com>

COPYRIGHT

Copyright 2003-2004 Chase Whitener. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.