eBay::API::XML::Call::GetMessagePreferences - eBay::API::XML::Call::GetMessagePreferences documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetMessagePreferences

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setIncludeASQPreferences()

If true, indicates that the ASQ subjects for the specified user should be returned.

  RequiredInput: No
#    Argument: 'xs:boolean'

setSellerID()

The ID of the user to retrieve ASQ subjects for. This value must be specified in the request, but does not need to be the same user as the user making the request.

  RequiredInput: Yes
#    Argument: 'ns:UserIDType'

getASQPreferences()

Returns a seller's ASQ subjects, each in its own Subject node. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values. Returned if IncludeASQPreferences = true was specified in the request.

  Returned: Conditionally
#    Returns: 'ns:ASQPreferencesType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetMessagePreferences;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetMessagePreferences.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::GetMessagePreferences::GetMessagePreferencesRequestType;
use eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesResponseType;



sub getApiCallName {
   return 'GetMessagePreferences';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesResponseType';
}

#
# input properties
#


       
sub setIncludeASQPreferences {
   my $self   = shift;
   my $sIncludeASQPreferences = shift;
   $self->getRequestDataType()->setIncludeASQPreferences($sIncludeASQPreferences);
}


       
sub setSellerID {
   my $self   = shift;
   my $pSellerID = shift;
   $self->getRequestDataType()->setSellerID($pSellerID);
}



#
# output properties
#


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





1;