Class JLinkedinGroups

Description
Description | Vars | Methods (details)

Linkedin API Groups class for the Joomla Platform.

  • since: 13.1

Located in /libraries/joomla/linkedin/groups.php (line 19) 

JLinkedinObject
   |
   --JLinkedinGroups
Method Summary
Description | Vars | Methods (details)
string addComment (string $post_id, string $comment)
array changeSettings (string $group_id, [boolean $show_logo = null], [string $digest_frequency = null], [boolean $announcements = null], [boolean $allow_messages = null], [boolean $new_post = null])
string createPost (string $group_id, string $title, string $summary)
array deleteComment (string $comment_id)
array deletePost (string $post_id)
array deleteSuggestion (string $suggestion_id, [string $person_id = null])
array flagPost (string $post_id, string $flag)
array followPost (string $post_id)
array getComment (string $comment_id, [string $fields = null])
array getDiscussions (string $id, [string $fields = null], [integer $start = 0], [integer $count = 0], [string $order = null], [string $category = 'discussion'], [string $modified_since = null])
array getGroup (string $id, [string $fields = null], [integer $start = 0], [integer $count = 5])
array getMemberships ([string $id = null], [string $fields = null], [integer $start = 0], [integer $count = 5], [string $membership_state = null])
array getPost (string $post_id, [string $fields = null])
array getPostComments (string $post_id, [string $fields = null], [integer $start = 0], [integer $count = 0])
array getSettings ([string $person_id = null], [string $group_id = null], [string $fields = null], [integer $start = 0], [integer $count = 5])
array getSuggested ([string $person_id = null], [string $fields = null])
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])
array joinGroup (string $group_id, [boolean $show_logo = null], [string $digest_frequency = null], [boolean $announcements = null], [boolean $allow_messages = null], [boolean $new_post = null])
array leaveGroup (string $group_id)
array likePost (string $post_id)
array unfollowPost (string $post_id)
array unlikePost (string $post_id)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JLinkedinObject

JLinkedinObject::$client
 JLinkedinObject::$oauth
 JLinkedinObject::$options
Methods
Description | Vars Methods (details)
addComment (line 941)

Method to add a comment to a post

  • return: The created comment's id.
  • since: 13.1
  • access: public
string addComment (string $post_id, string $comment)
  • string $post_id: The unique identifier for a group.
  • string $comment: The post comment's text.
changeSettings (line 229)

Method to change a groups settings.

  • return: The decoded JSON response
  • since: 13.1
  • access: 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])
  • string $group_id: The unique identifier for a group.
  • boolean $show_logo: Show group logo in profile.
  • string $digest_frequency: E-mail digest frequency.
  • boolean $announcements: E-mail announcements from managers.
  • boolean $allow_messages: Allow messages from members.
  • boolean $new_post: E-mail for every new post.
createPost (line 654)

Method to retrieve all comments of a post.

  • return: The created post's id.
  • since: 13.1
  • access: public
string createPost (string $group_id, string $title, string $summary)
  • string $group_id: The unique identifier for a group.
  • string $title: Post title.
  • string $summary: Post summary.
deleteComment (line 982)

Method to delete a comment if the current user is the creator or flag it as inappropriate otherwise.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array deleteComment (string $comment_id)
  • string $comment_id: The unique identifier for a group.
deletePost (line 868)

Method to delete a post if the current user is the creator or flag it as inappropriate otherwise.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array deletePost (string $post_id)
  • string $post_id: The unique identifier for a group.
deleteSuggestion (line 1065)

Method to delete a group suggestion for a user.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array deleteSuggestion (string $suggestion_id, [string $person_id = null])
  • string $suggestion_id: The unique identifier for a suggestion.
  • string $person_id: The unique identifier for a user.
flagPost (line 830)

Method to flag a post as a Promotion or Job.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array flagPost (string $post_id, string $flag)
  • string $post_id: The unique identifier for a group.
  • string $flag: Flag as a 'promotion' or 'job'.
followPost (line 801)

Method used to follow a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array followPost (string $post_id)
  • string $post_id: The unique identifier for a group.
getComment (line 902)

Method to access the comments resource.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getComment (string $comment_id, [string $fields = null])
  • string $comment_id: The unique identifier for a comment.
  • string $fields: Request fields beyond the default ones.
getDiscussions (line 402)

Method to get dicussions for a group.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getDiscussions (string $id, [string $fields = null], [integer $start = 0], [integer $count = 0], [string $order = null], [string $category = 'discussion'], [string $modified_since = null])
  • string $id: The unique identifier for a group.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
  • string $order: Sort order for posts. Valid for: recency, popularity.
  • string $category: Category of posts. Valid for: discussion
  • string $modified_since: Timestamp filter for posts created after the specified value.
getGroup (line 33)

Method to get a group.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getGroup (string $id, [string $fields = null], [integer $start = 0], [integer $count = 5])
  • string $id: The unique identifier for a group.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
getMemberships (line 88)

Method to find the groups a member belongs to.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getMemberships ([string $id = null], [string $fields = null], [integer $start = 0], [integer $count = 5], [string $membership_state = null])
  • string $id: The unique identifier for a user.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
  • 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.
getPost (line 561)

Method to retrieve details about a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getPost (string $post_id, [string $fields = null])
  • string $post_id: The unique identifier for a post.
  • string $fields: Request fields beyond the default ones.
getPostComments (line 602)

Method to retrieve all comments of a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getPostComments (string $post_id, [string $fields = null], [integer $start = 0], [integer $count = 0])
  • string $post_id: The unique identifier for a post.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
getSettings (line 158)

Method to find the groups a member belongs to.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getSettings ([string $person_id = null], [string $group_id = null], [string $fields = null], [integer $start = 0], [integer $count = 5])
  • string $person_id: The unique identifier for a user.
  • string $group_id: The unique identifier for a group.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
getSuggested (line 1016)

Method to get suggested groups for a user.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array getSuggested ([string $person_id = null], [string $fields = null])
  • string $person_id: The unique identifier for a user.
  • string $fields: Request fields beyond the default ones.
getUserPosts (line 478)

Method to get posts a user started / participated in / follows for a group.

  • return: The decoded JSON response
  • since: 13.1
  • access: 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])
  • string $group_id: The unique identifier for a group.
  • string $role: Filter for posts related to the caller. Valid for: creator, commenter, follower.
  • string $person_id: The unique identifier for a user.
  • string $fields: Request fields beyond the default ones.
  • integer $start: Starting location within the result set for paginated returns.
  • integer $count: The number of results returned.
  • string $order: Sort order for posts. Valid for: recency, popularity.
  • string $category: Category of posts. Valid for: discussion
  • string $modified_since: Timestamp filter for posts created after the specified value.
joinGroup (line 297)

Method to join a group.

  • return: The decoded JSON response
  • since: 13.1
  • access: 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])
  • string $group_id: The unique identifier for a group.
  • boolean $show_logo: Show group logo in profile.
  • string $digest_frequency: E-mail digest frequency.
  • boolean $announcements: E-mail announcements from managers.
  • boolean $allow_messages: Allow messages from members.
  • boolean $new_post: E-mail for every new post.
leaveGroup (line 363)

Method to leave a group.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array leaveGroup (string $group_id)
  • string $group_id: The unique identifier for a group.
likePost (line 734)

Method used to like a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array likePost (string $post_id)
  • string $post_id: The unique identifier for a group.
unfollowPost (line 815)

Method used to unfollow a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array unfollowPost (string $post_id)
  • string $post_id: The unique identifier for a group.
unlikePost (line 748)

Method used to unlike a post.

  • return: The decoded JSON response
  • since: 13.1
  • access: public
array unlikePost (string $post_id)
  • string $post_id: The unique identifier for a group.

Inherited Methods

Inherited From JLinkedinObject

JLinkedinObject::__construct()
JLinkedinObject::booleanToString()
JLinkedinObject::getOption()
JLinkedinObject::setOption()

Documentation generated on Tue, 19 Nov 2013 15:04:09 +0100 by phpDocumentor 1.4.3