Class Horde_Service_Facebook_Users
Users methods for Horde_Service_Facebook
Copyright 2009-2012 Horde LLC (http://www.horde.org/)
-
Horde_Service_Facebook_Base
-
Horde_Service_Facebook_Users
Methods summary
public
array
&
|
#
getInfo( string $uids, string $fields )
Returns the requested info fields for the requested set of users.
Returns the requested info fields for the requested set of users.
Parameters
- $uids
- A comma-separated list of user ids
- $fields
- A comma-separated list of info field names desired
Returns
array An array of user objects
|
public
array
&
|
#
getStandardInfo( string $uids, string $fields )
Returns the requested info fields for the requested set of users. A
session key must not be specified. Only data about users that have
authorized your application will be returned.
Returns the requested info fields for the requested set of users. A
session key must not be specified. Only data about users that have
authorized your application will be returned.
Check the wiki for fields that can be queried through this API call.
Data returned from here should not be used for rendering to application
users, use users.getInfo instead, so that proper privacy rules will be
applied.
Parameters
- $uids
- A comma-separated list of user ids
- $fields
- A comma-separated list of info field names desired
Returns
array An array of user objects
|
public
integer
&
|
#
hasAppPermission( string $ext_perm, string $uid = null )
Returns 1 if the user has the specified permission, 0 otherwise.
http://wiki.developers.facebook.com/index.php/Users.hasAppPermission
Returns 1 if the user has the specified permission, 0 otherwise.
http://wiki.developers.facebook.com/index.php/Users.hasAppPermission
Parameters
- $ext_perm
- The perm to check for.
- $uid
- The facebook userid to check.
Returns
integer 1 or 0
Throws
|
public
boolean
&
|
#
isAppUser( string $uid = null )
Returns whether or not the user corresponding to the current
session object has the give the app basic authorization.
Returns whether or not the user corresponding to the current
session object has the give the app basic authorization.
Parameters
Returns
boolean true if the user has authorized the app
Throws
|
public
boolean
&
|
#
isVerified( )
Returns whether or not the user corresponding to the current
session object is verified by Facebook. See the documentation
for Users.isVerified for details.
Returns whether or not the user corresponding to the current
session object is verified by Facebook. See the documentation
for Users.isVerified for details.
Returns
boolean true if the user is verified
Throws
|
public
boolean
&
|
#
setStatus( string $status, string $uid = null, boolean $clear = false, boolean $includeVerb = true )
Sets the users' current status message. Message does NOT contain the
word "is" , so make sure to include a verb.
Sets the users' current status message. Message does NOT contain the
word "is" , so make sure to include a verb.
Example: setStatus("is loving the API!")
will produce the status "Luke is loving the API!"
Parameters
- $status
- text-only message to set
- $uid
- <p>user to set for (defaults to the
logged-in user)</p>
- $clear
- <p>whether or not to clear the status, instead
of setting it</p>
- $includeVerb
- <p>If true, the word "is" will <em>not</em> be
prepended to the status message</p>
Returns
boolean
|
public
mixed
&
|
#
getStatus( string $uid = null, integer $limit = 1 )
Get user's status
Parameters
Returns
mixed
|