Overview

Namespaces

  • LoginRadiusSDK
    • Advance
    • Clients
    • CustomerRegistration
      • Account
      • Authentication
      • Social
    • Utility

Classes

  • AdvanceSocialLoginAPI
  • SocialLoginAPI
  • Overview
  • Namespace
  • Class

Class AdvanceSocialLoginAPI

Class for AdvanceSocialLoginAPI.

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

Namespace: LoginRadiusSDK\CustomerRegistration\Social
Located at LoginRadiusSDK/CustomerRegistration/Social/AdvanceSocialLoginAPI.php
Methods summary
public
# __construct( type $apikey = '', type $apisecret = '', type $options = array() )

Parameters

$apikey
$apisecret
$options
public type
# getAccessTokenByPassingFacebookToken( $fb_access_token, $fields = '*' )

Get LoginRadius Access token by Passing Facebook token

Get LoginRadius Access token by Passing Facebook token

Parameters

$fb_access_token
$fields

Returns

type
public type
# getAccessTokenByPassingTwitterToken( $tw_access_token, $tw_token_secret, $fields = '*' )

Get LoginRadius Access token by Passing Twitter token

Get LoginRadius Access token by Passing Twitter token

Parameters

$tw_access_token
$tw_token_secret
$fields

Returns

type
public type
# refreshUserProfile( $access_token, $fields = '*' )

The User Profile API is used to get the latest updated 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. This API should be called using the access token retrieved from the refresh access token API.

The User Profile API is used to get the latest updated 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. This API should be called using the access token retrieved from the refresh access token API.

Parameters

$access_token
$fields

Returns

type
public type
# refreshAccessToken( $access_token, $fields = '*' )

The Refresh Access Token API is used to refresh the provider access token after authentication. It will be valid for 60 days on LoginRadius' side but it also depends on the provider side. In order to use the access token in other APIs always refresh the token with this API. Supported Providers : Facebook,Yahoo,Google,Twitter, Linkedin Contact LoginRadius support team to enable this API.

The Refresh Access Token API is used to refresh the provider access token after authentication. It will be valid for 60 days on LoginRadius' side but it also depends on the provider side. In order to use the access token in other APIs always refresh the token with this API. Supported Providers : Facebook,Yahoo,Google,Twitter, Linkedin Contact LoginRadius support team to enable this API.

Parameters

$access_token
$fields

Returns

type
public type
# getActiveSessionByToken( $access_token, $fields = '*' )

Get all active seesions by Access Token

Get all active seesions by Access Token

Parameters

$access_token
$fields

Returns

type
public type
# trackableStatus( $post_id, $fields = '*' )

This API is used to retrieve a tracked post based on the passed in post ID value. This API requires setting permissions in your LoginRadius Dashboard.

This API is used to retrieve a tracked post based on the passed in post ID value. This API requires setting permissions in your LoginRadius Dashboard.

Parameters

$post_id
$fields

Returns

type
public type
# postMessage( $access_token, $to, $subject, $message, $fields = '*' )

The Message API is used to post messages to the user’s contacts. Supported Providers: LinkedIn, Twitter.

The Message API is used to post messages to the user’s contacts. Supported Providers: LinkedIn, Twitter.

Parameters

$access_token
$to
$subject
$message
$fields

Returns

type
public type
# postStatus( $access_token, $status, $title = '', $url = '', $imageurl = '', $caption = '', $description = '', $fields = '*' )

The Status API is used to update the status on the user’s wall. It is commonly referred to as Permission based sharing or Push notifications. This API requires setting permissions in your LoginRadius Dashboard.

The Status API is used to update the status on the user’s wall. It is commonly referred to as Permission based sharing or Push notifications. This API requires setting permissions in your LoginRadius Dashboard.

Parameters

$access_token
$status
$title
$url
$imageurl
$caption
$description
$fields

Returns

type
public type
# shortenUrl( $url, $fields = '*' )

The Shorten URL API is used to convert your URLs to the LoginRadius short URL - ish.re

The Shorten URL API is used to convert your URLs to the LoginRadius short URL - ish.re

Parameters

$url
$fields

Returns

type
public type
# trackableStatusStats( $access_token, $status, $title = '', $url = '', $imageurl = '', $caption = '', $description = '', $fields = '*' )

The Trackable status API works very similar to the Status API but it returns a Post id that you can use to track the stats(shares, likes, comments) for a specific share/post/status update. This API requires setting permissions in your LoginRadius Dashboard.

The Trackable status API works very similar to the Status API but it returns a Post id that you can use to track the stats(shares, likes, comments) for a specific share/post/status update. This API requires setting permissions in your LoginRadius Dashboard.

Parameters

$access_token
$status
$title
$url
$imageurl
$caption
$description
$fields

Returns

type
public type
# trackableStatusPosting( $access_token, $status, $title = '', $url = '', $imageurl = '', $caption = '', $description = '', $fields = '*' )

The Trackable Status API is used to update the status on the user’s wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications.

The Trackable Status API is used to update the status on the user’s wall and return an Post ID value. It is commonly referred to as Permission based sharing or Push notifications.

Parameters

$access_token
$status
$title
$url
$imageurl
$caption
$description
$fields

Returns

type
API documentation generated by ApiGen