| Package | com.yahoo.social |
| Class | public class YahooUser |
// create a yahoo session object and pass into it the OAuth credentials, appid and a guid
YahooSession.YAP_VIEWER = "12345";
YahooSession.YAP_OWNER = "67890"
YahooSession.YAP_APPID = "your-appid";
var session:YahooSession = new YahooSession('$consumerKey', '$consumerSecret', '$accessToken', '$accessTokenSecret');
// retrieve the sessioned user
var user:YahooUser = session.getSessionedUser();
| Property | Defined by | ||
|---|---|---|---|
| connections : ConnectionsRequest
[read-only]
The instance of the ConnectionsRequest API for this user.
| YahooUser | ||
| contacts : ContactsRequest
[read-only]
The instance of the ContactsRequest API for this user.
| YahooUser | ||
| guid : String [read-only]
The GUID of this user, a 26-character string which represents a Yahoo! user.
| YahooUser | ||
| lang : String = "en-US"
The language code query parameter used in all requests by an API method attached to this user.
| YahooUser | ||
| profile : ProfileRequest
[read-only]
The instance of the ProfileRequest API for this user.
| YahooUser | ||
| region : String = "US"
The region code query parameter represents a country territory in all requests by an API method attached to this user.
| YahooUser | ||
| session : YahooSession
[read-only]
The global YahooSession object.
| YahooUser | ||
| sessioned : Boolean [read-only]
Returns a boolean, true if this user is the currently sessioned viewer of the app.
| YahooUser | ||
| status : StatusRequest
[read-only]
The instance of the StatusRequest API for this user.
| YahooUser | ||
| updates : UpdatesRequest
[read-only]
The instance of the UpdatesRequest API for this user.
| YahooUser | ||
| yql : YQL
[read-only]
The instance of the YQL API for this user.
| YahooUser | ||
| Method | Defined by | ||
|---|---|---|---|
|
YahooUser(session:YahooSession, guid:String)
Class constructor.
| YahooUser | ||
|
setSmallView(content:String):void
Sets the small view for this user.
| YahooUser | ||
| connections | property |
connections:ConnectionsRequest [read-only]The instance of the ConnectionsRequest API for this user.
Implementation public function get connections():ConnectionsRequest
See also
| contacts | property |
contacts:ContactsRequest [read-only]The instance of the ContactsRequest API for this user.
Implementation public function get contacts():ContactsRequest
See also
| guid | property |
guid:String [read-only]The GUID of this user, a 26-character string which represents a Yahoo! user.
Implementation public function get guid():String
See also
| lang | property |
public var lang:String = "en-US"The language code query parameter used in all requests by an API method attached to this user. The language code must conform to RFC 4646.
Examples language codes:
The default value is en-US
See also
var user:YahooUser = _session.getSessionedUser();
user.lang = "fr-CA";
| profile | property |
profile:ProfileRequest [read-only]The instance of the ProfileRequest API for this user.
Implementation public function get profile():ProfileRequest
See also
| region | property |
public var region:String = "US"The region code query parameter represents a country territory in all requests by an API method attached to this user. The region code must conform to an ISO 3166-1 alpha-2 country code.
Example regions codes:
The default value is en-US
See also
var user:YahooUser = _session.getSessionedUser();
user.region = "DE";
| session | property |
session:YahooSession [read-only]The global YahooSession object.
Implementation public function get session():YahooSession
| sessioned | property |
sessioned:Boolean [read-only]Returns a boolean, true if this user is the currently sessioned viewer of the app.
Implementation public function get sessioned():Boolean
| status | property |
status:StatusRequest [read-only]The instance of the StatusRequest API for this user.
Implementation public function get status():StatusRequest
See also
| updates | property |
updates:UpdatesRequest [read-only]The instance of the UpdatesRequest API for this user.
Implementation public function get updates():UpdatesRequest
See also
| yql | property |
yql:YQL [read-only]The instance of the YQL API for this user.
Implementation public function get yql():YQL
See also
| YahooUser | () | constructor |
public function YahooUser(session:YahooSession, guid:String)
Class constructor.
Creates a new YahooUser object.
This should not be called directly, but through the getUser or getSessionedUser methods of YahooSession.
This is in order to provide session and authentication information to the API methods attached to this user.
session:YahooSession — A YahooSession object.
|
|
guid:String — The GUID of the user.
|
See also
| setSmallView | () | method |
public function setSmallView(content:String):voidSets the small view for this user. Supports only HTML and YML Lite
Parameterscontent:String — HTML and YML Lite contents.
|