ePages 7.17.0 - DE_EPAGES/OAuthTokenClient/API/OAuth/ConsumerClient.pm

Package DE_EPAGES::OAuthTokenClient::API::OAuth::ConsumerClient

Client for OAuth consumer operations.

Base
DE_EPAGES::EPagesJ::API::Object::RestClient

Functions

create
createConsumer
deleteConsumer
getConsumer
saveConsumer

create

Factory method for a OAuthTokenClient object. Initializes based on the current configuration.

Syntax
$ConsumerClient = DE_EPAGES::OAuthTokenClient::API::OAuth::ConsumerClient->create;
Return
$ConsumerClient (DE_EPAGES::OAuthTokenClient::API::OAuth::ConsumerClient)
ConsumerClient object

createConsumer

Calls service to create a consumer

Syntax
$Consumer = $self->createConsumer( $ConsumerName );
Input
$ConsumerName (string)
Consumer name
Return
$Consumer (DE_EPAGES::OAuthTokenClient::API::Object::OAuthConsumer)
OAuth consumer object

deleteConsumer

Deletes a consumer.

Syntax
$self->deleteConsumer( $ConsumerKey );
Input
$ConsumerKey (string)
consumer key
Return
$IsDeleted (boolean)
true, if response was successful

getConsumer

Gets a consumer.

Syntax
$self->getConsumer( $ConsumerKey );
Input
$ConsumerKey (string)
consumer key
Return
$savedConsumer (Object)
Consumer Object

saveConsumer

Calls service to save a consumer

Syntax
my $hToken = $self->saveConsumer( $Consumer);
Input
$Consumer (Object)
Consumer
Return
$savedConsumer (Object)
Consumer Object