Class Socialveo\WebApi\Controllers\SocialProfilesController

InheritanceSocialveo\WebApi\Controllers\SocialProfilesController » Socialveo\WebApi\Controllers\RestApiController » Phalcon\Mvc\Controller
Uses TraitsSocialveo\Core\Translatable

Class SocialProfilesController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
_handleException() Handle exceptions Socialveo\WebApi\Controllers\RestApiController
_t() Gets translations Socialveo\Core\Translatable
afterExecuteRoute() After execute route, change return value to json Socialveo\WebApi\Controllers\RestApiController
beforeExecuteRoute() Before execute route, remove extra params Socialveo\WebApi\Controllers\RestApiController
checkClientCredentials() Checks client credentials Socialveo\WebApi\Controllers\RestApiController
decrypt() Decrypt value Socialveo\WebApi\Controllers\RestApiController
disconnectProviderAction() Disconnect provider Socialveo\WebApi\Controllers\SocialProfilesController
encrypt() Encrypt value Socialveo\WebApi\Controllers\RestApiController
getArrayFromParam() Returns array from params Socialveo\WebApi\Controllers\RestApiController
getLanguage() Gets language code Socialveo\WebApi\Controllers\RestApiController
getParams() Gets request params for Socialveo::filteredFind() Socialveo\WebApi\Controllers\RestApiController
getRequestData() Returns request data Socialveo\WebApi\Controllers\RestApiController
getRequiredParam() Get required param Socialveo\WebApi\Controllers\RestApiController
getSocialProfileAction() Get user social profile Socialveo\WebApi\Controllers\SocialProfilesController
getToken() Get token Socialveo\WebApi\Controllers\RestApiController
getTranslation() Gets translations Socialveo\WebApi\Controllers\RestApiController
handleError() Handle errors Socialveo\WebApi\Controllers\RestApiController
handleException() Handle exceptions Socialveo\WebApi\Controllers\RestApiController
initialize() Initialize controller Socialveo\WebApi\Controllers\RestApiController
invalidMethodAction() Action trigger when invalid action tried run Socialveo\WebApi\Controllers\RestApiController
notFoundAction() Not found action Socialveo\WebApi\Controllers\RestApiController
posts() Gets posts Socialveo\WebApi\Controllers\RestApiController
replaceParam() Replace param Socialveo\WebApi\Controllers\RestApiController
respondWithItem() Response with item // * @deprecated Socialveo\WebApi\Controllers\RestApiController
sendJsonContent() Send response as json content and exit Socialveo\WebApi\Controllers\RestApiController
sendJsonContentRaw() Send json content Socialveo\WebApi\Controllers\RestApiController
sendJsonContentRawStatic() Send json content static Socialveo\WebApi\Controllers\RestApiController
setDefaultParam() Set default option Socialveo\WebApi\Controllers\RestApiController
socialProfileInvitationsAction() Sends email invitations to join site, to user connections exposed by a given social profile Socialveo\WebApi\Controllers\SocialProfilesController
t() Gets translations Socialveo\Core\Translatable
unsetParam() Unset get param Socialveo\WebApi\Controllers\RestApiController

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
checkAccess() Checks during the init of controller whether user is a guest. Socialveo\WebApi\Controllers\RestApiController
log() Log full request data for debug Socialveo\WebApi\Controllers\RestApiController
objectsToArray() Convert objects to arrays Socialveo\WebApi\Controllers\RestApiController

Method Details

disconnectProviderAction() public method

Disconnect provider

/social-profiles/disconnect/{user_uuid}

Method: POST

Access: Owner

Parameters:

{user_uuid} required string user uuid
provider required string provider name (e.g. Google, Facebook)
language optional string language code

Sample response:

{
    'status': 'OK',
    "timestamp": 1234567890
}

public Phalcon\Translate\Adapter\Gettext|string|void disconnectProviderAction ( $user_uuid )
$user_uuid
throws Exception
getSocialProfileAction() public method

Get user social profile

/social-profiles/{user_social_profile_uuid}

Method: GET

Access: Owner

Parameters:

{user_social_profile_uuid} required string social profile uuid

Returns: UserSocialProfile

Sample response:

{
    "status": "OK",
    "data":{
        "uuid": "23beca96-d23a-11e5-afc6-1c6f658b33e3",
        "provider": "Facebook",
        "provider_id": "1043592369041381",
        "user_uuid": "26ba85fe-c917-11e5-8b3a-1c6f658b33e3",
        ...
    },
    "timestamp": 1234567890
}

public mixed getSocialProfileAction ( $user_social_profile_uuid )
$user_social_profile_uuid string

UUID is passed in the request URI

socialProfileInvitationsAction() public method

Sends email invitations to join site, to user connections exposed by a given social profile

/social-profiles/{user_social_profile_uuid}/invitations

Method: POST

Access: Owner

Parameters:

{user_social_profile_uuid} required string social profile uuid

Sample response:

{
    'status': 'OK',
    "timestamp": 1234567890
}

public mixed socialProfileInvitationsAction ( $user_social_profile_uuid )
$user_social_profile_uuid string

UUID is passed in the request URI