YahooUser Class Reference

Represents a Yahoo! user. More...

List of all members.

Public Member Functions
	getStatus ()
	setStatus ($message)
	getUpdates ($start=0, $count=10)
	getConnectionUpdates ($start=0, $count=10)
	insertUpdate ($suid, $title, $link, $description="", $date=NULL)
	deleteUpdate ($suid)
	getProfile ()
	getConnections (&$start, &$count, &$total)
	getContacts ($start=0, $count=10)
	setSmallView ($content)
	loadProfile ()
	listUpdates ($start=0, $count=10)
	listConnectionUpdates ($start=0, $count=10)
	getPresence ()
	setPresence ($status)

---

Detailed Description

Represents a Yahoo! user.

---

Member Function Documentation

YahooUser::deleteUpdate

(

$

suid

)

Deletes the update of the given SUID. Only allows deleting updates that were inserted by your own application. You won't be able to delete updates from other applications.

Parameters:

$suid

The SUID of the update to be deleted.

Returns:

boolean True on success, false on failure.

YahooUser::getConnections	(	&$	start,
		&$	count,
		&$	total
	)

Gets a list of connections for the current user.

Parameters:

[in,out]	$start	The starting offset.
[in,out]	$count	The number of connections to fetch.
[out]	$total	The total number of contacts available.

Returns:

List of connections for the current user.

YahooUser::getConnectionUpdates	(	$	start = 0,
		$	count = 10
	)

Gets the updates for the connections of the current user.

Parameters:

	$start	The starting offset to list updates from.
	$count	The number of updates to request.

Returns:

A list of updates for the connections of the current user.

YahooUser::getContacts	(	$	start = 0,
		$	count = 10
	)

Gets a list of contacts for the current user.

Parameters:

	$start	The starting offset.
	$count	The number of contacts to fetch.

Returns:

List of contacts for the current user.

YahooUser::getPresence

(

)

Gets the presence of the user, including the status.

Returns:

The presence of the user or NULL if the fetch fails.

Deprecated:

As of 1.2, replaced by getStatus

YahooUser::getProfile

(

)

Loads the extended profile of the current user.

Returns:

The extended profile of the current user.

YahooUser::getStatus

(

)

Gets the user's status message.

Returns:

The status of the user or NULL if the fetch fails.

YahooUser::getUpdates	(	$	start = 0,
		$	count = 10
	)

Gets the updates for the current user.

Parameters:

	$start	The starting offset to list updates from. (default = 0)
	$count	The number of updates to request. (default = 10)

Returns:

An array of updates for the current user.

YahooUser::insertUpdate	(	$	suid,
		$	title,
		$	link,
		$	description = "",
		$	date = NULL
	)

Inserts an update for the current user.

Parameters:

	$suid	Identifier that globally unique for a given collectionId within producing source.
	$title	Title for the update.
	$link	Link back to the cause of the event.
	$description	Descriptive text associated with the update, optional.
	$date	The date of the update event, optional, defaults to now.

YahooUser::listConnectionUpdates	(	$	start = 0,
		$	count = 10
	)

Gets the updates for the connections of the current user.

Deprecated:

As of 1.2, replaced by getConnectionUpdates.

Parameters:

	$start	The starting offset to list updates from.
	$count	The number of updates to request.

Returns:

An array of updates for the connections of the current user.

YahooUser::listUpdates	(	$	start = 0,
		$	count = 10
	)

Lists the updates for the current user.

Deprecated:

As of 1.2, replaced by getUpdates.

Parameters:

	$start	The starting offset to list updates from. (default = 0)
	$count	The number of updates to request. (default = 10)

Returns:

A list of updates for the current user.

YahooUser::loadProfile

(

)

Loads the extended profile of the current user.

Deprecated:

As of 1.2, replaced by getProfile.

Returns:

The extended profile of the current user.

YahooUser::setPresence

(

$

status

)

Sets the presence of the user.

Parameters:

$status

The new status message for the user.

Returns:

The status message on success, NULL on failure.

Deprecated:

As of 1.2, replaced by setStatus

YahooUser::setSmallView

(

$

content

)

Sets the small view for the current user.

Parameters:

$content

The content to set the small view to.

Returns:

True on success, false otherwise.

YahooUser::setStatus

(

$

message

)

Sets the user's status message.

Parameters:

$message

The new status message for the user.

Returns:

The status message on success, NULL on failure.

---

The documentation for this class was generated from the following file:

• lib/Yahoo.inc