eBay::API::XML::Call::FetchToken - eBay::API::XML::Call::FetchToken documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::Call::FetchToken

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::FetchToken inherits from the eBay::API::XML::BaseCall class

Subroutines:

Top

setIncludeRESTToken()

Specified if you want to retrieve a REST token for a user.

  RequiredInput: No
#    Argument: 'xs:boolean'

setSecretID()

A value that is associated with the token retrieval request. SecretID is defined by the application, and is passed in redirect URL to the eBay signin page. eBay recommends using a UUID for the secret ID value. You must also set Username (part of the RequesterCredentials) for the particular user of interest. SecretID and Username are not required if SessionID is present.

  RequiredInput: No
#    Argument: 'xs:string'

setSessionID()

A value that is associated with the token retrieval request. The session ID is generated by eBay by the application making GetSessionID call, and is passed in redirect URL to the eBay signin page. The advantage of using SessionID is that it does not require UserID as part of the FetchToken request. SessionID is not required if SecretID is present.

  RequiredInput: No
#    Argument: 'xs:string'

getHardExpirationTime()

Date and time at which the token returned in eBayAuthToken expires and can no longer be used to authenticate the user for that application.

  Returned: Always
#    Returns: 'xs:dateTime'

getRESTToken()

The REST authentication token for the user.

  Returned: Conditionally
#    Returns: 'xs:string'

getEBayAuthToken()

The authentication token for the user.

  Returned: Always
#    Returns: 'xs:string'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::FetchToken;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. FetchToken.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseCall;
our @ISA = ("eBay::API::XML::BaseCall");

use eBay::API::XML::Call::FetchToken::FetchTokenRequestType;
use eBay::API::XML::Call::FetchToken::FetchTokenResponseType;



sub getApiCallName {
   return 'FetchToken';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::FetchToken::FetchTokenRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::FetchToken::FetchTokenResponseType';
}

#
# input properties
#


       
sub setIncludeRESTToken {
   my $self   = shift;
   my $sIncludeRESTToken = shift;
   $self->getRequestDataType()->setIncludeRESTToken($sIncludeRESTToken);
}


       
sub setSecretID {
   my $self   = shift;
   my $sSecretID = shift;
   $self->getRequestDataType()->setSecretID($sSecretID);
}


       
sub setSessionID {
   my $self   = shift;
   my $sSessionID = shift;
   $self->getRequestDataType()->setSessionID($sSessionID);
}



#
# output properties
#


       
sub getHardExpirationTime {
   my $self = shift;
   return $self->getResponseDataType()->getHardExpirationTime();
}


       
sub getRESTToken {
   my $self = shift;
   return $self->getResponseDataType()->getRESTToken();
}


       
sub getEBayAuthToken {
   my $self = shift;
   return $self->getResponseDataType()->getEBayAuthToken();
}





1;