Interface yii\authclient\ClientInterface

Implemented byyii\authclient\BaseClient, yii\authclient\BaseOAuth, yii\authclient\OAuth1, yii\authclient\OAuth2, yii\authclient\OpenId, yii\authclient\clients\Facebook, yii\authclient\clients\GitHub, yii\authclient\clients\GoogleHybrid, yii\authclient\clients\GoogleOAuth, yii\authclient\clients\GoogleOpenId, yii\authclient\clients\LinkedIn, yii\authclient\clients\Live, yii\authclient\clients\Twitter, yii\authclient\clients\VKontakte, yii\authclient\clients\YandexOAuth, yii\authclient\clients\YandexOpenId
Available since version2.0
Source Code https://github.com/yiisoft/yii2-authclient/blob/master/ClientInterface.php

ClientInterface declares basic interface all Auth clients should follow.

Method Details

getId() public method

string getId( )
return string

Service id

getName() public method

string getName( )
return string

Service name.

getTitle() public method

string getTitle( )
return string

Service title.

getUserAttributes() public method

array getUserAttributes( )
return array

List of user attributes

getViewOptions() public method

array getViewOptions( )
return array

View options in format: optionName => optionValue

setId() public method

void setId$id )
$id string

Service id.

setName() public method

void setName$name )
$name string

Service name.

setTitle() public method

void setTitle$title )
$title string

Service title.