JLinkedinGroups
Extends \JLinkedinObjectLinkedin API Groups class for the Joomla Platform.
since |
3.2.0 |
---|---|
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JLinkedinOAuth $oauth = null)
since |
3.2.0 |
---|
Arguments
- $options
\Joomla\Registry\Registry
Linkedin options object.- $client
\JHttp
The HTTP client object.- $oauth
\JLinkedinOAuth
The OAuth client.
_followUnfollow
Method to follow or unfollow a post.
_followUnfollow(string $post_id, boolean $follow) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.- $follow
boolean
True to like post, false otherwise.
Response
array
The decoded JSON response
_likeUnlike
Method to like or unlike a post.
_likeUnlike(string $post_id, boolean $like) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.- $like
boolean
True to like post, false otherwise.
Response
array
The decoded JSON response
addComment
Method to add a comment to a post
addComment(string $post_id, string $comment) : string
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.- $comment
string
The post comment's text.
Response
string
The created comment's id.
booleanToString
Method to convert boolean to string.
booleanToString(boolean $bool) : string
since |
3.2.0 |
---|
Arguments
- $bool
boolean
The boolean value to convert.
Response
string
String with the converted boolean.
changeSettings
Method to change a groups settings.
changeSettings(string $group_id, boolean $show_logo = null, string $digest_frequency = null, boolean $announcements = null, boolean $allow_messages = null, boolean $new_post = null) : array
since |
3.2.0 |
---|
Arguments
- $group_id
string
The unique identifier for a group.- $show_logo
boolean
Show group logo in profile.- $digest_frequency
string
Email digest frequency.- $announcements
boolean
Email announcements from managers.- $allow_messages
boolean
Allow messages from members.- $new_post
boolean
Email for every new post.
Response
array
The decoded JSON response
createPost
Method to retrieve all comments of a post.
createPost(string $group_id, string $title, string $summary) : string
since |
3.2.0 |
---|
Arguments
- $group_id
string
The unique identifier for a group.- $title
string
Post title.- $summary
string
Post summary.
Response
string
The created post's id.
deleteComment
Method to delete a comment if the current user is the creator or flag it as inappropriate otherwise.
deleteComment(string $comment_id) : array
since |
3.2.0 |
---|
Arguments
- $comment_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
deletePost
Method to delete a post if the current user is the creator or flag it as inappropriate otherwise.
deletePost(string $post_id) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
deleteSuggestion
Method to delete a group suggestion for a user.
deleteSuggestion(string $suggestion_id, string $person_id = null) : array
since |
3.2.0 |
---|
Arguments
- $suggestion_id
string
The unique identifier for a suggestion.- $person_id
string
The unique identifier for a user.
Response
array
The decoded JSON response
flagPost
Method to flag a post as a Promotion or Job.
flagPost(string $post_id, string $flag) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.- $flag
string
Flag as a 'promotion' or 'job'.
Response
array
The decoded JSON response
followPost
Method used to follow a post.
followPost(string $post_id) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
getComment
Method to access the comments resource.
getComment(string $comment_id, string $fields = null) : array
since |
3.2.0 |
---|
Arguments
- $comment_id
string
The unique identifier for a comment.- $fields
string
Request fields beyond the default ones.
Response
array
The decoded JSON response
getDiscussions
Method to get dicussions for a group.
getDiscussions(string $id, string $fields = null, integer $start, integer $count, string $order = null, string $category = 'discussion', string $modified_since = null) : array
since |
3.2.0 |
---|
Arguments
- $id
string
The unique identifier for a group.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.- $order
string
Sort order for posts. Valid for: recency, popularity.- $category
string
Category of posts. Valid for: discussion- $modified_since
string
Timestamp filter for posts created after the specified value.
Response
array
The decoded JSON response
getGroup
Method to get a group.
getGroup(string $id, string $fields = null, integer $start, integer $count = 5) : array
since |
3.2.0 |
---|
Arguments
- $id
string
The unique identifier for a group.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.
Response
array
The decoded JSON response
getMemberships
Method to find the groups a member belongs to.
getMemberships(string $id = null, string $fields = null, integer $start, integer $count = 5, string $membership_state = null) : array
since |
3.2.0 |
---|
Arguments
- $id
string
The unique identifier for a user.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.- $membership_state
string
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.
Response
array
The decoded JSON response
getOption
Get an option from the JLinkedinObject instance.
getOption(string $key) : mixed
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to get.
Response
mixed
The option value.
getPost
Method to retrieve details about a post.
getPost(string $post_id, string $fields = null) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a post.- $fields
string
Request fields beyond the default ones.
Response
array
The decoded JSON response
getPostComments
Method to retrieve all comments of a post.
getPostComments(string $post_id, string $fields = null, integer $start, integer $count) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a post.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.
Response
array
The decoded JSON response
getSettings
Method to find the groups a member belongs to.
getSettings(string $person_id = null, string $group_id = null, string $fields = null, integer $start, integer $count = 5) : array
since |
3.2.0 |
---|
Arguments
- $person_id
string
The unique identifier for a user.- $group_id
string
The unique identifier for a group.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.
Response
array
The decoded JSON response
getSuggested
Method to get suggested groups for a user.
getSuggested(string $person_id = null, string $fields = null) : array
since |
3.2.0 |
---|
Arguments
- $person_id
string
The unique identifier for a user.- $fields
string
Request fields beyond the default ones.
Response
array
The decoded JSON response
getUserPosts
Method to get posts a user started / participated in / follows for a group.
getUserPosts(string $group_id, string $role, string $person_id = null, string $fields = null, integer $start, integer $count, string $order = null, string $category = 'discussion', string $modified_since = null) : array
since |
3.2.0 |
---|
Arguments
- $group_id
string
The unique identifier for a group.- $role
string
Filter for posts related to the caller. Valid for: creator, commenter, follower.- $person_id
string
The unique identifier for a user.- $fields
string
Request fields beyond the default ones.- $start
integer
Starting location within the result set for paginated returns.- $count
integer
The number of results returned.- $order
string
Sort order for posts. Valid for: recency, popularity.- $category
string
Category of posts. Valid for: discussion- $modified_since
string
Timestamp filter for posts created after the specified value.
Response
array
The decoded JSON response
joinGroup
Method to join a group.
joinGroup(string $group_id, boolean $show_logo = null, string $digest_frequency = null, boolean $announcements = null, boolean $allow_messages = null, boolean $new_post = null) : array
since |
3.2.0 |
---|
Arguments
- $group_id
string
The unique identifier for a group.- $show_logo
boolean
Show group logo in profile.- $digest_frequency
string
Email digest frequency.- $announcements
boolean
Email announcements from managers.- $allow_messages
boolean
Allow messages from members.- $new_post
boolean
Email for every new post.
Response
array
The decoded JSON response
leaveGroup
Method to leave a group.
leaveGroup(string $group_id) : array
since |
3.2.0 |
---|
Arguments
- $group_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
likePost
Method used to like a post.
likePost(string $post_id) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
setOption
Set an option for the JLinkedinObject instance.
setOption(string $key, mixed $value) : \JLinkedinObject
since |
3.2.0 |
---|
Arguments
- $key
string
The name of the option to set.- $value
mixed
The option value to set.
Response
\JLinkedinObject
This object for method chaining.
unfollowPost
Method used to unfollow a post.
unfollowPost(string $post_id) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
unlikePost
Method used to unlike a post.
unlikePost(string $post_id) : array
since |
3.2.0 |
---|
Arguments
- $post_id
string
The unique identifier for a group.
Response
array
The decoded JSON response
Properties
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp
oauth
The OAuth client.
since |
3.2.0 |
---|
Type(s)
\JLinkedinOAuth