Class SocialLoginAPI

Class for SocialLoginAPI.

This is the main class to communicate with LoginRadius Unified Social API.

Namespace: LoginRadiusSDK\CustomerRegistration\Social
Located at LoginRadiusSDK/CustomerRegistration/Social/SocialLoginAPI.php

Methods summary
`public`	# `__construct( type $apikey = '', type $apisecret = '', type $options = array() )` Parameters `$apikey` `$apisecret` `$options`
`public mixed`	# `exchangeAccessToken( string $request_token, $fields = '*' )` LoginRadius function - Fetch LoginRadius access token after authentication. It will be valid for the specific duration of time specified in the response. Parameters `$request_token` LoginRadius API token `$fields` Returns mixed string\|object LoginRadius access token.
`public object`	# `getUserProfiledata( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch social profile data from the user's social account after authentication. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format. LoginRadius function - To fetch social profile data from the user's social account after authentication. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User profile data.
`public object`	# `getUserCustomFields( string $apikey, string $secret, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch custom fileds of raas. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format. LoginRadius function - To fetch custom fileds of raas. The social profile will be retrieved via oAuth and OpenID protocols. The data is normalized into LoginRadius' standard data format. Parameters `$apikey` LoginRadius api key `$secret` LoginRadius secret key `$raw` If true, raw data is fetched `$fields` Returns object custom fields of raas.
`public object`	# `getPhotoAlbums( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get the Albums data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get the Albums data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's albums data.
`public object`	# `getPhotos( string $access_token, string $album_id, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch photo data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To fetch photo data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$album_id` ID of the album to fetch photos from `$raw` If true, raw data is fetched `$fields` Returns object User's photo data.
`public object`	# `getCheckins( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch check-ins data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To fetch check-ins data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's check-ins.
`public object`	# `getAudio( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch user's audio files data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To fetch user's audio files data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's audio files data.
`public object`	# `getContacts( string $access_token, integer $next_cursor = '', boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch user's contacts/friends/connections data from the user's social account. The data will normalized into LoginRadius' data format. LoginRadius function - To fetch user's contacts/friends/connections data from the user's social account. The data will normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$next_cursor` Offset to start fetching contacts from `$raw` If true, raw data is fetched `$fields` Returns object User's contacts/friends/followers.
`public object`	# `getMentions( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get mention data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get mention data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's twitter mentions.
`public object`	# `getFollowing( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To fetch information of the people, user is following on Twitter. LoginRadius function - To fetch information of the people, user is following on Twitter. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object Information of the people, user is following.
`public object`	# `getEvents( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get the event data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get the event data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's event data.
`public object`	# `getPosts( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get posted messages from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get posted messages from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object User's posted messages.
`public object`	# `getFollowedCompanies( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get the followed company's data in the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get the followed company's data in the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object Companies followed by user.
`public object`	# `getGroups( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get group data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get group data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object Group data.
`public object`	# `getStatus( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get the status messages from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get the status messages from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object Status messages.
`public object`	# `getVideos( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get videos data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get videos data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object Videos data.
`public object`	# `getLikes( string $access_token, boolean $raw = false, $fields = '*' )` LoginRadius function - To get likes data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get likes data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$raw` If true, raw data is fetched `$fields` Returns object likes data.
`public object`	# `getPages( string $access_token, string $page_name, boolean $raw = false, $fields = '*' )` LoginRadius function - To get the page data from the user's social account. The data will be normalized into LoginRadius' data format. LoginRadius function - To get the page data from the user's social account. The data will be normalized into LoginRadius' data format. Parameters `$access_token` LoginRadius access token `$page_name` Page name `$raw` If true, raw data is fetched `$fields` Returns object Page data.
`public boolean`	# `postStatus( string $access_token, string $status, string $title = '', string $url = '', string $imageurl = '', string $caption = '', string $description = '', $fields = '*' )` LoginRadius function - To update the status on the user's wall. LoginRadius function - To update the status on the user's wall. Parameters `$access_token` LoginRadius access token `$status` The status message text (Required). `$title` Title for status message (Optional). `$url` A web link of the status message (Optional). `$imageurl` An image URL of the status message (Optional). `$caption` Caption of the status message (Optional). `$description` Description of the status message (Optional). `$fields` Returns boolean Returns true if successful, false otherwise.
`public boolean`	# `sendMessage( string $access_token, string $to, string $subject, string $message, $fields = '*' )` LoginRadius function - Post messages to the user's contacts. After using the Contact API, you can send messages to the retrieved contacts. LoginRadius function - Post messages to the user's contacts. After using the Contact API, you can send messages to the retrieved contacts. Parameters `$access_token` LoginRadius access token `$to` Social ID of the receiver `$subject` Subject of the message `$message` Message `$fields` Returns boolean True on success, false otherwise
`public object`	# `tokenValidate( string $access_token, $fields = '*' )` LoginRadius function - This API is used to validate access_token, check it is valid, expired or active. LoginRadius function - This API is used to validate access_token, check it is valid, expired or active. Parameters `$access_token` LoginRadius access token `$fields` Returns object User profile data.
`public object`	# `tokenInvalidate( string $access_token, $fields = '*' )` LoginRadius function - This API is used to invalidate access token, means expiring token. After this API call passed access_token no longer be active and will not accepted by LoginRadius APIs. LoginRadius function - This API is used to invalidate access token, means expiring token. After this API call passed access_token no longer be active and will not accepted by LoginRadius APIs. Parameters `$access_token` LoginRadius access token `$fields` Returns object User profile data.
`public object.`	# `validateKeyandSecret( $fields = '*' )` LoginRadius function - This API is used to validate API key and Secret. LoginRadius function - This API is used to validate API key and Secret. Returns object.

Namespaces

Classes

Class SocialLoginAPI

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns