Inheritance diagram for Samy\OAuth2\RequestInterface:
Public Member Functions | |
| getGrantType () | |
| withGrantType (string $GrantType) | |
| getClientId () | |
| withClientId (string $ClientId) | |
| getClientSecret () | |
| withClientSecret (string $ClientSecret) | |
| getUsername () | |
| withUsername (string $Username) | |
| getPassword () | |
| withPassword (string $Password) | |
| getScope () | |
| withScope (string $Scope) | |
Detailed Description
Describes OAuth2 Request interface.
Member Function Documentation
◆ getClientId()
| Samy\OAuth2\RequestInterface::getClientId | ( | ) |
Retrieve provided client id.
- Returns
- string
◆ getClientSecret()
| Samy\OAuth2\RequestInterface::getClientSecret | ( | ) |
Retrieve provided client secret.
- Returns
- string
◆ getGrantType()
| Samy\OAuth2\RequestInterface::getGrantType | ( | ) |
Retrieve provided grant type.
- Returns
- string
◆ getPassword()
| Samy\OAuth2\RequestInterface::getPassword | ( | ) |
Retrieve provided password.
- Returns
- string
◆ getScope()
| Samy\OAuth2\RequestInterface::getScope | ( | ) |
Retrieve provided scope.
- Returns
- string
◆ getUsername()
| Samy\OAuth2\RequestInterface::getUsername | ( | ) |
Retrieve provided username.
- Returns
- string
◆ withClientId()
| Samy\OAuth2\RequestInterface::withClientId | ( | string | $ClientId | ) |
Return an instance with provided client id.
- Parameters
-
[in] string $ClientId Client id
- Returns
- static
◆ withClientSecret()
| Samy\OAuth2\RequestInterface::withClientSecret | ( | string | $ClientSecret | ) |
Return an instance with provided client secret.
- Parameters
-
[in] string $ClientSecret Client secret
- Returns
- static
◆ withGrantType()
| Samy\OAuth2\RequestInterface::withGrantType | ( | string | $GrantType | ) |
Return an instance with provided grant type.
- Parameters
-
[in] string $GrantType Grant type
- Returns
- static
◆ withPassword()
| Samy\OAuth2\RequestInterface::withPassword | ( | string | $Password | ) |
Return an instance with provided password.
- Parameters
-
[in] string $Password Password
- Returns
- static
◆ withScope()
| Samy\OAuth2\RequestInterface::withScope | ( | string | $Scope | ) |
Return an instance with provided scope.
- Parameters
-
[in] string $Scope Scope
- Returns
- static
◆ withUsername()
| Samy\OAuth2\RequestInterface::withUsername | ( | string | $Username | ) |
Return an instance with provided username.
- Parameters
-
[in] string $Username Username
- Returns
- static
The documentation for this interface was generated from the following file:
- oauth2/RequestInterface.php
