Class YahooUser

Description

Represents a Yahoo! user.

Represents a Yahoo! user.

Located in /Yahoo.inc (line 812)


	
			
Variable Summary
 mixed $client
 mixed $guid
 mixed $session
 mixed $sessioned
Method Summary
 YahooUser YahooUser ( $session,  $guid,  $sessioned)
 void addContact ( $contact)
 boolean deleteUpdate ($suid $suid)
 List getConnections ( &$start,  &$count,  &$total)
 A getConnectionUpdates ([$start $start = 0], [$count $count = 10])
 void getContact ( $contact_id)
 List getContacts ([$start $start = 0], [$count $count = 10])
 void getContactSync ([ $rev = 0])
 The getPresence ()
 The getProfile ()
 The getStatus ()
 An getUpdates ([$start $start = 0], [$count $count = 10])
 void get_resource ( $resource, [ $parameters = array()])
 void insertUpdate ($suid $suid, $title $title, $link $link, [$description $description = ""], [$date $date = NULL])
 An listConnectionUpdates ([$start $start = 0], [$count $count = 10])
 A listUpdates ([$start $start = 0], [$count $count = 10])
 The loadProfile ()
 The setPresence ($status $status)
 True setSmallView ($content $content)
 The setStatus ($message $message)
 void syncContacts ( $contactsync)
Variables
mixed $client = NULL (line 831)
  • private:
mixed $guid = NULL (line 821)
  • private:
mixed $session = NULL (line 816)
  • private:
mixed $sessioned = false (line 826)
  • private:
Methods
Constructor YahooUser (line 836)
  • private:
YahooUser YahooUser ( $session,  $guid,  $sessioned)
  • $session
  • $guid
  • $sessioned
addContact (line 1130)
void addContact ( $contact)
  • $contact
deleteUpdate (line 999)

Deletes the update of the given SUID. that were inserted by your own application. delete updates from other applications.

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.

  • return: True on success, false on failure.
boolean deleteUpdate ($suid $suid)
  • $suid $suid: The SUID of the update to be deleted.
getConnections (line 1045)

Gets a list of connections for the current user.

Gets a list of connections for the current user.

  • return: of connections for the current user.
List getConnections ( &$start,  &$count,  &$total)
  • &$start
  • &$count
  • &$total
getConnectionUpdates (line 928)

Gets the updates for the connections of the current user.

Gets the updates for the connections of the current user.

  • return: list of updates for the connections of the current user.
A getConnectionUpdates ([$start $start = 0], [$count $count = 10])
  • $start $start: The starting offset to list updates from.
  • $count $count: The number of updates to request.
getContact (line 1079)
void getContact ( $contact_id)
  • $contact_id
getContacts (line 1065)

Gets a list of contacts for the current user.

Gets a list of contacts for the current user.

  • return: of contacts for the current user.
List getContacts ([$start $start = 0], [$count $count = 10])
  • $start $start: The starting offset.
  • $count $count: The number of contacts to fetch.
getContactSync (line 1094)
void getContactSync ([ $rev = 0])
  • $rev
getPresence (line 1227)

Gets the presence of the user, including the status.

Gets the presence of the user, including the status.

  • return: presence of the user or NULL if the fetch fails.
  • deprecated: As of 1.2, replaced by getStatus
The getPresence ()
getProfile (line 1029)

Loads the extended profile of the current user.

Loads the extended profile of the current user.

  • return: extended profile of the current user.
The getProfile ()
getStatus (line 848)

Gets the user's status message.

Gets the user's status message.

  • return: status of the user or NULL if the fetch fails.
The getStatus ()
getUpdates (line 914)

Gets the updates for the current user.

Gets the updates for the current user.

  • return: array of updates for the current user.
An getUpdates ([$start $start = 0], [$count $count = 10])
  • $start $start: The starting offset to list updates from. (default = 0)
  • $count $count: The number of updates to request. (default = 10)
get_resource (line 1162)
  • private:
void get_resource ( $resource, [ $parameters = array()])
  • $resource
  • $parameters
insertUpdate (line 946)

Inserts an update for the current user.

Inserts an update for the current user.

void insertUpdate ($suid $suid, $title $title, $link $link, [$description $description = ""], [$date $date = NULL])
  • $suid $suid: Identifier that globally unique for a given collectionId within producing source.
  • $title $title: Title for the update.
  • $link $link: Link back to the cause of the event.
  • $description $description: Descriptive text associated with the update, optional.
  • $date $date: The date of the update event, optional, defaults to now.
listConnectionUpdates (line 1214)

Gets the updates for the connections of the current user.

Gets the updates for the connections of the current user.

  • return: array of updates for the connections of the current user.
  • deprecated: As of 1.2, replaced by getConnectionUpdates.
An listConnectionUpdates ([$start $start = 0], [$count $count = 10])
  • $start $start: The starting offset to list updates from.
  • $count $count: The number of updates to request.
listUpdates (line 1200)

Lists the updates for the current user.

Lists the updates for the current user.

  • return: list of updates for the current user.
  • deprecated: As of 1.2, replaced by getUpdates.
A listUpdates ([$start $start = 0], [$count $count = 10])
  • $start $start: The starting offset to list updates from. (default = 0)
  • $count $count: The number of updates to request. (default = 10)
loadProfile (line 1184)

Loads the extended profile of the current user.

Loads the extended profile of the current user.

  • return: extended profile of the current user.
  • deprecated: As of 1.2, replaced by getProfile.
The loadProfile ()
setPresence (line 1263)

Sets the presence of the user.

Sets the presence of the user.

  • return: status message on success, NULL on failure.
  • deprecated: As of 1.2, replaced by setStatus
The setPresence ($status $status)
  • $status $status: The new status message for the user.
setSmallView (line 1155)

Sets the small view for the current user.

Sets the small view for the current user.

  • return: on success, false otherwise.
True setSmallView ($content $content)
  • $content $content: The content to set the small view to.
setStatus (line 883)

Sets the user's status message.

Sets the user's status message.

  • return: status message on success, NULL on failure.
The setStatus ($message $message)
  • $message $message: The new status message for the user.
syncContacts (line 1109)
void syncContacts ( $contactsync)
  • $contactsync

Documentation generated on Thu, 22 Oct 2009 12:54:52 -0700 by phpDocumentor 1.4.3