Functions
| Function | Description |
|---|---|
getActivity |
Returns information about a given activity ID. |
getActivities |
Returns a list of public activities made by the given user ID. |
getCircledPeople |
Returns a list of people the given user has in one or more circles. |
getComment |
Returns a comment with the given ID. |
getComments |
Returns comments for a given activity ID. |
getPerson |
Returns a person for the given user ID. |
searchActivities |
Searches for public activities. |
searchPeople |
Searches for people. |
getActivity
Returns information about a given activity ID.
Return Value: A BigTreeGooglePlusActivity object.
getActivity($id)| Parameter | Description |
|---|---|
$id |
The ID of the activity. |
getActivities
Returns a list of public activities made by the given user ID.
Returns the authenticated user's activities if no ID is passed in.
Return Value: A BigTreeGoogleResultSet of BigTreeGooglePlusActivity objects.
getActivities($user, $count, $params)| Parameter | Description |
|---|---|
$user |
The ID of the person to return activities for. You may pass "me" to use the authenticated user (default) |
$count |
The number of results to return, (defaults to 100, max 100) |
$params |
Additional parameters to pass to the people/{userId}/activities API call. |
getCircledPeople
Returns a list of people the given user has in one or more circles.
Returns circled people for the authenticated user if no ID is passed in.
Return Value: A BigTreeGoogleResultSet of BigTreeGooglePlusPeople objects.
getCircledPeople($user, $count, $order, $params)| Parameter | Description |
|---|---|
$user |
The ID of the person to return circled people for. You may pass "me" to use the authenticated user (default) |
$count |
The number of results to return, (defaults to 100, max 100) |
$order |
The sort order for the results (options are "best" and "alphabetical", defaults to "best") |
$params |
Additional parameters to pass to the people/{userId}/people API call. |
getComment
Returns a comment with the given ID.
Return Value: A BigTreeGooglePlusComment object.
getComment($id)| Parameter | Description |
|---|---|
$id |
The comment ID. |
getComments
Returns comments for a given activity ID.
Return Value: A BigTreeGoogleResultSet of BigTreeGooglePlusComment objects.
getComments($activity, $count, $order, $params)| Parameter | Description |
|---|---|
$activity |
The activity ID to pull comments for. |
$count |
The number of comments to return (defaults to 500, max 500) |
$order |
The sort order for the results (options are "ascending" and "descending", defaults to "ascending" or oldest first) |
$params |
Additional parameters to pass to the activities/{activityId}/comments API call. |
getPerson
Returns a person for the given user ID.
Returns the authenticated user if no ID is passed in.
Return Value: A BigTreeGooglePlusPerson object.
getPerson($user = "me")| Parameter | Description |
|---|---|
$user |
The ID of the person to return. |
searchActivities
Searches for public activities.
Return Value: A BigTreeGoogleResultSet of BigTreeGooglePlusActivity objects.
searchActivities($query, $count, $order, $params)| Parameter | Description |
|---|---|
$query |
A string to search for. |
$count |
Number of results to return (defaults to 10, max 20) |
$order |
Sort order for results (options are "best" and "recent", defaults to "best") |
$params |
Additional parameters to pass to the activities API call. |
searchPeople
Searches for people.
Return Value: A BigTreeGoogleResultSet of BigTreeGooglePlusPerson objects.
searchPeople($query, $count, $params)| Parameter | Description |
|---|---|
$query |
A string to search for. |
$count |
Number of results to return (defaults to 10, max 20) |
$params |
Additional parameters to pass to the people API call. |