Interface yii\authclient\ClientInterface

All Classes | Methods

Implemented by	yii\authclient\BaseClient, yii\authclient\BaseOAuth, yii\authclient\OAuth1, yii\authclient\OAuth2, yii\authclient\OpenId, yii\authclient\OpenIdConnect, yii\authclient\clients\Facebook, yii\authclient\clients\GitHub, yii\authclient\clients\Google, yii\authclient\clients\GoogleHybrid, yii\authclient\clients\LinkedIn, yii\authclient\clients\Live, yii\authclient\clients\Oauth2Client, yii\authclient\clients\Twitter, yii\authclient\clients\TwitterOAuth2, yii\authclient\clients\VKontakte, yii\authclient\clients\Yandex
Available since extension's version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/src/ClientInterface.php

ClientInterface declares basic interface all Auth clients should follow.

Public Methods

Method	Description	Defined By
getId()		yii\authclient\ClientInterface
getName()		yii\authclient\ClientInterface
getTitle()		yii\authclient\ClientInterface
getUserAttributes()		yii\authclient\ClientInterface
getViewOptions()		yii\authclient\ClientInterface
setId()		yii\authclient\ClientInterface
setName()		yii\authclient\ClientInterface
setTitle()		yii\authclient\ClientInterface

getId() public abstract method

public abstract getId( ): string
return	string	Service id

                public function getId();

getName() public abstract method

public abstract getName( ): string
return	string	Service name.

                public function getName();

getTitle() public abstract method

public abstract getTitle( ): string
return	string	Service title.

                public function getTitle();

getUserAttributes() public abstract method

public abstract getUserAttributes( ): array
return	array	List of user attributes

                public function getUserAttributes();

getViewOptions() public abstract method

public abstract getViewOptions( ): array
return	array	View options in format: optionName => optionValue

                public function getViewOptions();

setId() public abstract method

public abstract setId( string $id ): mixed
$id	string	Service id.

                public function setId($id);

setName() public abstract method

public abstract setName( string $name ): mixed
$name	string	Service name.

                public function setName($name);

setTitle() public abstract method

public abstract setTitle( string $title ): mixed
$title	string	Service title.

                public function setTitle($title);