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

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesRequestType

DESCRIPTION

Top

Retrieves some or all of a user's preferences. The set of preferences retrieved depends on the set of flags specified in the request.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetUserPreferences::GetUserPreferencesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setShowBidderNoticePreferences()

If true, requests a seller's preferences for receiving bidder notices.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowBidderNoticePreferences()

# Returns: 'xs:boolean'

setShowCombinedPaymentPreferences()

DO NOT USE THIS FIELD. Use 'GetShippingDiscountProfiles' to access similar information. If true, requests a seller's preferences for accepting payments that combine item purchases into one order.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowCombinedPaymentPreferences()

# Returns: 'xs:boolean'

setShowCrossPromotionPreferences()

If true, requests a seller's cross-promotion preferences, such as whether cross-promotions are enabled and the sort filters used.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowCrossPromotionPreferences()

# Returns: 'xs:boolean'

setShowEmailShipmentTrackingNumberPreference()

If true, returns the preference related to emailing the email shipment tracking number.

Default: false

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowEmailShipmentTrackingNumberPreference()

# Returns: 'xs:boolean'

setShowEndOfAuctionEmailPreferences()

If true, displays the seller's end of auction email preferences.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowEndOfAuctionEmailPreferences()

# Returns: 'xs:boolean'

setShowProStoresPreferences()

If true, returns ProStores checkout preferences.

Default: false

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowProStoresPreferences()

# Returns: 'xs:boolean'

setShowSellerFavoriteItemPreferences()

If true, retrieves preferences the seller has set for displaying items on a buyer's favorite sellers page and in the favorite sellers email digest.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowSellerFavoriteItemPreferences()

# Returns: 'xs:boolean'

setShowSellerPaymentPreferences()

If true, displays a seller's payment preferences, for displaying a Pay Now button, accepting PayPal, and so on.

  RequiredInput: No
#    Argument: 'xs:boolean'

isShowSellerPaymentPreferences()

# Returns: 'xs:boolean'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

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

use strict;
use warnings;  

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


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



my @gaProperties = ( [ 'ShowBidderNoticePreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowCombinedPaymentPreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowCrossPromotionPreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowEmailShipmentTrackingNumberPreference', 'xs:boolean', '', '', '' ]
	, [ 'ShowEndOfAuctionEmailPreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowProStoresPreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowSellerFavoriteItemPreferences', 'xs:boolean', '', '', '' ]
	, [ 'ShowSellerPaymentPreferences', 'xs:boolean', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setShowBidderNoticePreferences {
  my $self = shift;
  $self->{'ShowBidderNoticePreferences'} = shift
}


sub isShowBidderNoticePreferences {
  my $self = shift;
  return $self->{'ShowBidderNoticePreferences'};
}



sub setShowCombinedPaymentPreferences {
  my $self = shift;
  $self->{'ShowCombinedPaymentPreferences'} = shift
}


sub isShowCombinedPaymentPreferences {
  my $self = shift;
  return $self->{'ShowCombinedPaymentPreferences'};
}



sub setShowCrossPromotionPreferences {
  my $self = shift;
  $self->{'ShowCrossPromotionPreferences'} = shift
}


sub isShowCrossPromotionPreferences {
  my $self = shift;
  return $self->{'ShowCrossPromotionPreferences'};
}



sub setShowEmailShipmentTrackingNumberPreference {
  my $self = shift;
  $self->{'ShowEmailShipmentTrackingNumberPreference'} = shift
}


sub isShowEmailShipmentTrackingNumberPreference {
  my $self = shift;
  return $self->{'ShowEmailShipmentTrackingNumberPreference'};
}



sub setShowEndOfAuctionEmailPreferences {
  my $self = shift;
  $self->{'ShowEndOfAuctionEmailPreferences'} = shift
}


sub isShowEndOfAuctionEmailPreferences {
  my $self = shift;
  return $self->{'ShowEndOfAuctionEmailPreferences'};
}



sub setShowProStoresPreferences {
  my $self = shift;
  $self->{'ShowProStoresPreferences'} = shift
}


sub isShowProStoresPreferences {
  my $self = shift;
  return $self->{'ShowProStoresPreferences'};
}



sub setShowSellerFavoriteItemPreferences {
  my $self = shift;
  $self->{'ShowSellerFavoriteItemPreferences'} = shift
}


sub isShowSellerFavoriteItemPreferences {
  my $self = shift;
  return $self->{'ShowSellerFavoriteItemPreferences'};
}



sub setShowSellerPaymentPreferences {
  my $self = shift;
  $self->{'ShowSellerPaymentPreferences'} = shift
}


sub isShowSellerPaymentPreferences {
  my $self = shift;
  return $self->{'ShowSellerPaymentPreferences'};
}





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

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



1;