Graphe d'héritage de JLinkedinGroups:

Fonctions membres publiques
	getGroup ($id, $fields=null, $start=0, $count=5)

	getMemberships ($id=null, $fields=null, $start=0, $count=5, $membershipState=null)

	getSettings ($personId=null, $groupId=null, $fields=null, $start=0, $count=5)

	changeSettings ($groupId, $showLogo=null, $digestFrequency=null, $announcements=null, $allowMessages=null, $newPost=null)

	joinGroup ($groupId, $showLogo=null, $digestFrequency=null, $announcements=null, $allowMessages=null, $newPost=null)

	leaveGroup ($groupId)

	getDiscussions ($id, $fields=null, $start=0, $count=0, $order=null, $category='discussion', $modifiedSince=null)

	getUserPosts ($groupId, $role, $personId=null, $fields=null, $start=0, $count=0, $order=null, $category='discussion', $modifiedSince=null)

	getPost ($postId, $fields=null)

	getPostComments ($postId, $fields=null, $start=0, $count=0)

	createPost ($groupId, $title, $summary)

	likePost ($postId)

	unlikePost ($postId)

	followPost ($postId)

	unfollowPost ($postId)

	flagPost ($postId, $flag)

	deletePost ($postId)

	getComment ($commentId, $fields=null)

	addComment ($postId, $comment)

	deleteComment ($commentId)

	getSuggested ($personId=null, $fields=null)

	deleteSuggestion ($suggestionId, $personId=null)

Fonctions membres publiques hérités de JLinkedinObject
	__construct (Registry $options=null, JHttp $client=null, JLinkedinOAuth $oauth=null)

	booleanToString ($bool)

	getOption ($key)

	setOption ($key, $value)

Fonctions membres privées
	_likeUnlike ($postId, $like)

	_followUnfollow ($postId, $follow)

Membres hérités additionnels
Attributs protégés hérités de JLinkedinObject
	$options

	$client

	$oauth

Description détaillée

Linkedin API Groups class for the Joomla Platform.

Depuis: 3.2.0

Documentation des fonctions membres

◆ _followUnfollow()

_followUnfollow	(	$postId,
		$follow
	)

private

Method to follow or unfollow a post.

Paramètres

string	$postId	The unique identifier for a group.
boolean	$follow	True to like post, false otherwise.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ _likeUnlike()

_likeUnlike	(	$postId,
		$like
	)

private

Method to like or unlike a post.

Paramètres

string	$postId	The unique identifier for a group.
boolean	$like	True to like post, false otherwise.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ addComment()

addComment	(	$postId,
		$comment
	)

Method to add a comment to a post

Paramètres

string	$postId	The unique identifier for a group.
string	$comment	The post comment's text.

Renvoie: string The created comment's id.

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ changeSettings()

changeSettings	(	$groupId,
		$showLogo = `null`,
		$digestFrequency = `null`,
		$announcements = `null`,
		$allowMessages = `null`,
		$newPost = `null`
	)

Method to change a groups settings.

Paramètres

string	$groupId	The unique identifier for a group.
boolean	$showLogo	Show group logo in profile.
string	$digestFrequency	Email digest frequency.
boolean	$announcements	Email announcements from managers.
boolean	$allowMessages	Allow messages from members.
boolean	$newPost	Email for every new post.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ createPost()

createPost	(	$groupId,
		$title,
		$summary
	)

Method to retrieve all comments of a post.

Paramètres

string	$groupId	The unique identifier for a group.
string	$title	Post title.
string	$summary	Post summary.

Renvoie: string The created post's id.

Depuis: 3.2.0

Références $base, $parameters, $path, et $title.

◆ deleteComment()

deleteComment ( $commentId )

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

Paramètres

string $commentId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ deletePost()

deletePost ( $postId )

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

Paramètres

string $postId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ deleteSuggestion()

deleteSuggestion	(	$suggestionId,
		$personId = `null`
	)

Method to delete a group suggestion for a user.

Paramètres

string	$suggestionId	The unique identifier for a suggestion.
string	$personId	The unique identifier for a user.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ flagPost()

flagPost	(	$postId,
		$flag
	)

Method to flag a post as a Promotion or Job.

Paramètres

string	$postId	The unique identifier for a group.
string	$flag	Flag as a 'promotion' or 'job'.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ followPost()

followPost ( $postId )

Method used to follow a post.

Paramètres

string $postId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

◆ getComment()

getComment	(	$commentId,
		$fields = `null`
	)

Method to access the comments resource.

Paramètres

string	$commentId	The unique identifier for a comment.
string	$fields	Request fields beyond the default ones.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $data, $fields, $parameters, et $path.

◆ getDiscussions()

getDiscussions	(	$id,
		$fields = `null`,
		$start = `0`,
		$count = `0`,
		$order = `null`,
		$category = `'discussion'`,
		$modifiedSince = `null`
	)

Method to get discussions for a group.

Paramètres

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	$modifiedSince	Timestamp filter for posts created after the specified value.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $category, $count, $data, $fields, $id, $parameters, $path, et $start.

◆ getGroup()

getGroup	(	$id,
		$fields = `null`,
		$start = `0`,
		$count = `5`
	)

Method to get a group.

Paramètres

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.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $count, $data, $fields, $id, $parameters, $path, et $start.

◆ getMemberships()

getMemberships	(	$id = `null`,
		$fields = `null`,
		$start = `0`,
		$count = `5`,
		$membershipState = `null`
	)

Method to find the groups a member belongs to.

Paramètres

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	$membershipState	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.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $count, $data, $fields, $id, $parameters, $path, et $start.

◆ getPost()

getPost	(	$postId,
		$fields = `null`
	)

Method to retrieve details about a post.

Paramètres

string	$postId	The unique identifier for a post.
string	$fields	Request fields beyond the default ones.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $data, $fields, $parameters, et $path.

◆ getPostComments()

getPostComments	(	$postId,
		$fields = `null`,
		$start = `0`,
		$count = `0`
	)

Method to retrieve all comments of a post.

Paramètres

string	$postId	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.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $count, $data, $fields, $parameters, $path, et $start.

◆ getSettings()

getSettings	(	$personId = `null`,
		$groupId = `null`,
		$fields = `null`,
		$start = `0`,
		$count = `5`
	)

Method to find the groups a member belongs to.

Paramètres

string	$personId	The unique identifier for a user.
string	$groupId	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.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $count, $data, $fields, $parameters, $path, et $start.

◆ getSuggested()

getSuggested	(	$personId = `null`,
		$fields = `null`
	)

Method to get suggested groups for a user.

Paramètres

string	$personId	The unique identifier for a user.
string	$fields	Request fields beyond the default ones.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $data, $fields, $parameters, et $path.

◆ getUserPosts()

getUserPosts	(	$groupId,
		$role,
		$personId = `null`,
		$fields = `null`,
		$start = `0`,
		$count = `0`,
		$order = `null`,
		$category = `'discussion'`,
		$modifiedSince = `null`
	)

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

Paramètres

string	$groupId	The unique identifier for a group.
string	$role	Filter for posts related to the caller. Valid for: creator, commenter, follower.
string	$personId	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	$modifiedSince	Timestamp filter for posts created after the specified value.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $category, $count, $data, $fields, $parameters, $path, et $start.

◆ joinGroup()

joinGroup	(	$groupId,
		$showLogo = `null`,
		$digestFrequency = `null`,
		$announcements = `null`,
		$allowMessages = `null`,
		$newPost = `null`
	)

Method to join a group.

Paramètres

string	$groupId	The unique identifier for a group.
boolean	$showLogo	Show group logo in profile.
string	$digestFrequency	Email digest frequency.
boolean	$announcements	Email announcements from managers.
boolean	$allowMessages	Allow messages from members.
boolean	$newPost	Email for every new post.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ leaveGroup()

leaveGroup ( $groupId )

Method to leave a group.

Paramètres

string $groupId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

Références $base, $parameters, et $path.

◆ likePost()

likePost ( $postId )

Method used to like a post.

Paramètres

string $postId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

◆ unfollowPost()

unfollowPost ( $postId )

Method used to unfollow a post.

Paramètres

string $postId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

◆ unlikePost()

unlikePost ( $postId )

Method used to unlike a post.

Paramètres

string $postId The unique identifier for a group.

Renvoie: array The decoded JSON response

Depuis: 3.2.0

La documentation de cette classe a été générée à partir du fichier suivant :

libraries/joomla/linkedin/groups.php

Fonctions membres publiques

Fonctions membres privées

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ _followUnfollow()

◆ _likeUnlike()

◆ addComment()

◆ changeSettings()

◆ createPost()

◆ deleteComment()

◆ deletePost()

◆ deleteSuggestion()

◆ flagPost()

◆ followPost()

◆ getComment()

◆ getDiscussions()

◆ getGroup()

◆ getMemberships()

◆ getPost()

◆ getPostComments()

◆ getSettings()

◆ getSuggested()

◆ getUserPosts()

◆ joinGroup()

◆ leaveGroup()

◆ likePost()

◆ unfollowPost()

◆ unlikePost()