public
array
|
#
getGroup( string $id, string $fields = null, integer $start = 0, integer $count = 5 )
Method to get a group.
Parameters
- $id
string - $id The unique identifier for a group.
- $fields
string - $fields Request fields beyond the default ones.
- $start
integer - $start Starting location within the result set for paginated returns.
- $count
integer - $count The number of results returned.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getMemberships( string $id = null, string $fields = null, integer $start = 0, integer $count = 5, string $membership_state = null )
Method to find the groups a member belongs to.
Method to find the groups a member belongs to.
Parameters
- $id
string - $id The unique identifier for a user.
- $fields
string - $fields Request fields beyond the default ones.
- $start
integer - $start Starting location within the result set for paginated returns.
- $count
integer - $count The number of results returned.
- $membership_state
string - $membership_state The state of the caller’s membership to the specified group.
Values are: non-member, awaiting-confirmation,
awaiting-parent-group-confirmation, member, moderator, manager, owner.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getSettings( string $person_id = null, string $group_id = null, string $fields = null, integer $start = 0, integer $count = 5 )
Method to find the groups a member belongs to.
Method to find the groups a member belongs to.
Parameters
- $person_id
string - $person_id The unique identifier for a user.
- $group_id
string - $group_id The unique identifier for a group.
- $fields
string - $fields Request fields beyond the default ones.
- $start
integer - $start Starting location within the result set for paginated returns.
- $count
integer - $count The number of results returned.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
changeSettings( string $group_id, boolean $show_logo = null, string $digest_frequency = null, boolean $announcements = null, boolean $allow_messages = null, boolean $new_post = null )
Method to change a groups settings.
Method to change a groups settings.
Parameters
- $group_id
string - $group_id The unique identifier for a group.
- $show_logo
boolean - $show_logo Show group logo in profile.
- $digest_frequency
string - $digest_frequency Email digest frequency.
- $announcements
boolean - $announcements Email announcements from managers.
- $allow_messages
boolean - $allow_messages Allow messages from members.
- $new_post
boolean - $new_post Email for every new post.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
joinGroup( string $group_id, boolean $show_logo = null, string $digest_frequency = null, boolean $announcements = null, boolean $allow_messages = null, boolean $new_post = null )
Method to join a group.
Parameters
- $group_id
string - $group_id The unique identifier for a group.
- $show_logo
boolean - $show_logo Show group logo in profile.
- $digest_frequency
string - $digest_frequency Email digest frequency.
- $announcements
boolean - $announcements Email announcements from managers.
- $allow_messages
boolean - $allow_messages Allow messages from members.
- $new_post
boolean - $new_post Email for every new post.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
leaveGroup( string $group_id )
Method to leave a group.
Parameters
- $group_id
string - $group_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getDiscussions( string $id, string $fields = null, integer $start = 0, integer $count = 0, string $order = null, string $category = 'discussion', string $modified_since = null )
Method to get dicussions for a group.
Method to get dicussions for a group.
Parameters
- $id
string - $id The unique identifier for a group.
- $fields
string - $fields Request fields beyond the default ones.
- $start
integer - $start Starting location within the result set for paginated returns.
- $count
integer - $count The number of results returned.
- $order
string - $order Sort order for posts. Valid for: recency, popularity.
- $category
string - $category Category of posts. Valid for: discussion
- $modified_since
string - $modified_since Timestamp filter for posts created after the specified value.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getUserPosts( string $group_id, string $role, string $person_id = null, string $fields = null, integer $start = 0, integer $count = 0, string $order = null, string $category = 'discussion', string $modified_since = null )
Method to get posts a user started / participated in / follows for a
group.
Method to get posts a user started / participated in / follows for a
group.
Parameters
- $group_id
string - $group_id The unique identifier for a group.
- $role
string - $role Filter for posts related to the caller. Valid for: creator, commenter,
follower.
- $person_id
string - $person_id The unique identifier for a user.
- $fields
string - $fields Request fields beyond the default ones.
- $start
integer - $start Starting location within the result set for paginated returns.
- $count
integer - $count The number of results returned.
- $order
string - $order Sort order for posts. Valid for: recency, popularity.
- $category
string - $category Category of posts. Valid for: discussion
- $modified_since
string - $modified_since Timestamp filter for posts created after the specified value.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getPost( string $post_id, string $fields = null )
Method to retrieve details about a post.
Method to retrieve details about a post.
Parameters
- $post_id
string - $post_id The unique identifier for a post.
- $fields
string - $fields Request fields beyond the default ones.
Returns
array - The decoded JSON response
Since
13.1
|
public
string
|
#
createPost( string $group_id, string $title, string $summary )
Method to retrieve all comments of a post.
Method to retrieve all comments of a post.
Parameters
- $group_id
string - $group_id The unique identifier for a group.
- $title
string - $title Post title.
- $summary
string - $summary Post summary.
Returns
string - The created post's id.
Since
13.1
|
public
array
|
#
likePost( string $post_id )
Method used to like a post.
Method used to like a post.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
unlikePost( string $post_id )
Method used to unlike a post.
Method used to unlike a post.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
followPost( string $post_id )
Method used to follow a post.
Method used to follow a post.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
unfollowPost( string $post_id )
Method used to unfollow a post.
Method used to unfollow a post.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
flagPost( string $post_id, string $flag )
Method to flag a post as a Promotion or Job.
Method to flag a post as a Promotion or Job.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
- $flag
string - $flag Flag as a 'promotion' or 'job'.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
deletePost( string $post_id )
Method to delete a post if the current user is the creator or flag it as
inappropriate otherwise.
Method to delete a post if the current user is the creator or flag it as
inappropriate otherwise.
Parameters
- $post_id
string - $post_id The unique identifier for a group.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
getSuggested( string $person_id = null, string $fields = null )
Method to get suggested groups for a user.
Method to get suggested groups for a user.
Parameters
- $person_id
string - $person_id The unique identifier for a user.
- $fields
string - $fields Request fields beyond the default ones.
Returns
array - The decoded JSON response
Since
13.1
|
public
array
|
#
deleteSuggestion( string $suggestion_id, string $person_id = null )
Method to delete a group suggestion for a user.
Method to delete a group suggestion for a user.
Parameters
- $suggestion_id
string - $suggestion_id The unique identifier for a suggestion.
- $person_id
string - $person_id The unique identifier for a user.
Returns
array - The decoded JSON response
Since
13.1
|