eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesResponseType - eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesResponseType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesResponseType

DESCRIPTION

Top

Returns some or all of a user's preferences. The preferences are grouped in sets, according to the sets requested.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

Top

setBidderNoticePreferences()

Contains a seller's preferences for receiving bidder notices. Returned when the request sets ShowBidderNoticePreferences to true.

# Argument: 'ns:BidderNoticePreferencesType'

getBidderNoticePreferences()

  Returned: Conditionally
#    Returns: 'ns:BidderNoticePreferencesType'

setCombinedPaymentPreferences()

DO NOT USE THIS FIELD. Use 'GetShippingDiscountProfiles' to retrieve similar information. Contains a seller's preferences for accepting combined payments. Returned when ShowCombinedPaymentPreferences is true.

# Argument: 'ns:CombinedPaymentPreferencesType'

getCombinedPaymentPreferences()

  Returned: Conditionally
#    Returns: 'ns:CombinedPaymentPreferencesType'

setCrossPromotionPreferences()

Contains a seller's cross-promotion preferences. Returned when ShowCrossPromotionPreferences is true.

# Argument: 'ns:CrossPromotionPreferencesType'

getCrossPromotionPreferences()

  Returned: Conditionally
#    Returns: 'ns:CrossPromotionPreferencesType'

setEmailShipmentTrackingNumberPreference()

Contains the user's preference for the email shipment tracking number.

# Argument: 'xs:boolean'

isEmailShipmentTrackingNumberPreference()

  Returned: Conditionally
#    Returns: 'xs:boolean'

setEndOfAuctionEmailPreferences()

Contains the user's end of auction email preferences.

# Argument: 'ns:EndOfAuctionEmailPreferencesType'

getEndOfAuctionEmailPreferences()

  Returned: Conditionally
#    Returns: 'ns:EndOfAuctionEmailPreferencesType'

setProStoresPreference()

Details about ProStores and checkout preferences. Returned only if requested on input.

# Argument: 'ns:ProStoresCheckoutPreferenceType'

getProStoresPreference()

  Returned: Conditionally
#    Returns: 'ns:ProStoresCheckoutPreferenceType'

setSellerFavoriteItemPreferences()

Contains a seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest.

# Argument: 'ns:SellerFavoriteItemPreferencesType'

getSellerFavoriteItemPreferences()

  Returned: Conditionally
#    Returns: 'ns:SellerFavoriteItemPreferencesType'

setSellerPaymentPreferences()

Contains a seller's preferences for accepting payments. Returned when ShowSellerPaymentPreferences is true.

# Argument: 'ns:SellerPaymentPreferencesType'

getSellerPaymentPreferences()

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

package eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesResponseType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::BidderNoticePreferencesType;
use eBay::API::XML::DataType::CombinedPaymentPreferencesType;
use eBay::API::XML::DataType::CrossPromotionPreferencesType;
use eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType;
use eBay::API::XML::DataType::ProStoresCheckoutPreferenceType;
use eBay::API::XML::DataType::SellerFavoriteItemPreferencesType;
use eBay::API::XML::DataType::SellerPaymentPreferencesType;


my @gaProperties = ( [ 'BidderNoticePreferences', 'ns:BidderNoticePreferencesType', ''
	     ,'eBay::API::XML::DataType::BidderNoticePreferencesType', '1' ]
	, [ 'CombinedPaymentPreferences', 'ns:CombinedPaymentPreferencesType', ''
	     ,'eBay::API::XML::DataType::CombinedPaymentPreferencesType', '1' ]
	, [ 'CrossPromotionPreferences', 'ns:CrossPromotionPreferencesType', ''
	     ,'eBay::API::XML::DataType::CrossPromotionPreferencesType', '1' ]
	, [ 'EmailShipmentTrackingNumberPreference', 'xs:boolean', '', '', '' ]
	, [ 'EndOfAuctionEmailPreferences', 'ns:EndOfAuctionEmailPreferencesType', ''
	     ,'eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType', '1' ]
	, [ 'ProStoresPreference', 'ns:ProStoresCheckoutPreferenceType', ''
	     ,'eBay::API::XML::DataType::ProStoresCheckoutPreferenceType', '1' ]
	, [ 'SellerFavoriteItemPreferences', 'ns:SellerFavoriteItemPreferencesType', ''
	     ,'eBay::API::XML::DataType::SellerFavoriteItemPreferencesType', '1' ]
	, [ 'SellerPaymentPreferences', 'ns:SellerPaymentPreferencesType', ''
	     ,'eBay::API::XML::DataType::SellerPaymentPreferencesType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::ResponseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::ResponseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setBidderNoticePreferences {
  my $self = shift;
  $self->{'BidderNoticePreferences'} = shift
}


sub getBidderNoticePreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BidderNoticePreferences'
		,'eBay::API::XML::DataType::BidderNoticePreferencesType');
}



sub setCombinedPaymentPreferences {
  my $self = shift;
  $self->{'CombinedPaymentPreferences'} = shift
}


sub getCombinedPaymentPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CombinedPaymentPreferences'
		,'eBay::API::XML::DataType::CombinedPaymentPreferencesType');
}



sub setCrossPromotionPreferences {
  my $self = shift;
  $self->{'CrossPromotionPreferences'} = shift
}


sub getCrossPromotionPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CrossPromotionPreferences'
		,'eBay::API::XML::DataType::CrossPromotionPreferencesType');
}



sub setEmailShipmentTrackingNumberPreference {
  my $self = shift;
  $self->{'EmailShipmentTrackingNumberPreference'} = shift
}


sub isEmailShipmentTrackingNumberPreference {
  my $self = shift;
  return $self->{'EmailShipmentTrackingNumberPreference'};
}



sub setEndOfAuctionEmailPreferences {
  my $self = shift;
  $self->{'EndOfAuctionEmailPreferences'} = shift
}


sub getEndOfAuctionEmailPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'EndOfAuctionEmailPreferences'
		,'eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType');
}



sub setProStoresPreference {
  my $self = shift;
  $self->{'ProStoresPreference'} = shift
}


sub getProStoresPreference {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ProStoresPreference'
		,'eBay::API::XML::DataType::ProStoresCheckoutPreferenceType');
}



sub setSellerFavoriteItemPreferences {
  my $self = shift;
  $self->{'SellerFavoriteItemPreferences'} = shift
}


sub getSellerFavoriteItemPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SellerFavoriteItemPreferences'
		,'eBay::API::XML::DataType::SellerFavoriteItemPreferencesType');
}



sub setSellerPaymentPreferences {
  my $self = shift;
  $self->{'SellerPaymentPreferences'} = shift
}


sub getSellerPaymentPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SellerPaymentPreferences'
		,'eBay::API::XML::DataType::SellerPaymentPreferencesType');
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;