ConsumerInterface Interface Reference

Inheritance diagram for ConsumerInterface:

Public Member Functions
	validate ()
	getId ()
	getKey ()
	getSecret ()
	getCallbackUrl ()
	getCreatedAt ()
	isValidForTokenExchange ()

Detailed Description

Oauth consumer interface.

@api

Since

100.0.2

Definition at line 14 of file ConsumerInterface.php.

Member Function Documentation

getCallbackUrl()

getCallbackUrl

(

)

Get consumer callback Url.

Returns

string

Implemented in Consumer.

getCreatedAt()

getCreatedAt

(

)

Get when the consumer was created.

Returns

string

Implemented in Consumer.

getId()

getId

(

)

Get the consumer Id.

Returns

int

getKey()

getKey

(

)

Get consumer key.

Returns

string

Implemented in Consumer.

getSecret()

getSecret

(

)

Get consumer secret.

Returns

string

Implemented in Consumer.

isValidForTokenExchange()

isValidForTokenExchange

(

)

Check if the consumer key has not expired for Oauth token exchange usage

Returns

bool

Implemented in Consumer.

validate()

validate

(

)

Validate consumer data (e.g. Key and Secret length).

Returns

bool True if the consumer data is valid.

Exceptions

Implemented in Consumer.

---

The documentation for this interface was generated from the following file:

• vendor/magento/framework/Oauth/ConsumerInterface.php