media.logShare

Syntax

media.logShare ( int mid, string sharetype, mixed post = NULL, int uid = 1, string logShareSetting = 'AnonMultShares' )

Argument Info

Name	Type	Required	Default value	Description
mid	int	Required	none	The id of the media you want to log a share for.
sharetype	string	Required	none	The share type, which can be one of the following: 'facebook share','facebook like','linkedin','twitter','pinterest','googleplus','digg'.
post	mixed	Optional	NULL	This field contains any information that you want to store that is a result of the share.
uid	int	Optional	1	The id of the user of the logshare.
logShareSetting	string	Optional	'AnonMultShares'	The log share setting: can be one of the following: 'AnonMultShares' - anonymous users are allowed multiple shares (This is the default for anonymous users) 'Anon0Shares' - anonymous users are not allowed any shares 'LoggedIn1Share' - logged in users are allowed only 1 share 'LoggedInMultShares' - logged in users are allowed multiple shares

Sharetype parameters

A list of the different sharetypes that can be passed to this method.

Name	Type	Description
facebook	STRING	Use this share type when logging a Facebook share.
linkedin	STRING	This is for a LinkedIn share event, obviously it too can be logged.
twitter	STRING	Twitter is another share type that can be logged.
pinterest	STRING	Pinterest is another share type that can be logged.
reddit	STRING	This is a Google+ share event that can be logged.
digg	STRING	This is a Digg share event that can be logged.
stumbleupon	STRING	This is a stumbleupon based share that can be logged.
delicious	STRING	This is a delicious based share that can be logged.
email	STRING	This is an email based share that can be logged.

Response

The response returned on success and failure of media update.

Name	Type	Description	Possible Values
result	String	The returned result of the request to log a share. Returns 1 upon success; upon failure, the error is returned.	true / Error type
status	boolean	The status of the request as a whole. Unrelated to the success of updating the media item but rather was the request executed in full.	true/false

Return Values

Field	Description	Possible Values