eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType - eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType

DESCRIPTION

Top

Contains the seller's preferences for the end of auction (EOA) email to the buyer.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setCopyEmail()

Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isCopyEmail()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:boolean'

setEmailCustomized()

Indicates whether or not the seller wishes to send a customized email to winning buyers.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isEmailCustomized()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:boolean'

setLogoCustomized()

Indicates whether or not the seller wishes to include a logo in the customized email.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isLogoCustomized()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:boolean'

setLogoType()

The type of logo to include in the customized email.

  Calls: SetUserPreferences
  RequiredInput: No
  AllValuesExcept: None

# Argument: 'ns:EndOfAuctionLogoTypeCodeType'

getLogoType()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'ns:EndOfAuctionLogoTypeCodeType'

setLogoURL()

The URL of the logo to include in the customized email.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:anyURI'

getLogoURL()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:anyURI'

setTemplateText()

The text of the custom message for the end of auction (for auctions) or end of transaction (for Buy It Now) emails.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:string'

getTemplateText()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:string'

setTextCustomized()

Indicates whether or not the text of the customized message will be customized.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isTextCustomized()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:boolean'

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

package eBay::API::XML::DataType::EndOfAuctionEmailPreferencesType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::Enum::EndOfAuctionLogoTypeCodeType;


my @gaProperties = ( [ 'CopyEmail', 'xs:boolean', '', '', '' ]
	, [ 'EmailCustomized', 'xs:boolean', '', '', '' ]
	, [ 'LogoCustomized', 'xs:boolean', '', '', '' ]
	, [ 'LogoType', 'ns:EndOfAuctionLogoTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::EndOfAuctionLogoTypeCodeType', '' ]
	, [ 'LogoURL', 'xs:anyURI', '', '', '' ]
	, [ 'TemplateText', 'xs:string', '', '', '' ]
	, [ 'TextCustomized', 'xs:boolean', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setCopyEmail {
  my $self = shift;
  $self->{'CopyEmail'} = shift
}


sub isCopyEmail {
  my $self = shift;
  return $self->{'CopyEmail'};
}



sub setEmailCustomized {
  my $self = shift;
  $self->{'EmailCustomized'} = shift
}


sub isEmailCustomized {
  my $self = shift;
  return $self->{'EmailCustomized'};
}



sub setLogoCustomized {
  my $self = shift;
  $self->{'LogoCustomized'} = shift
}


sub isLogoCustomized {
  my $self = shift;
  return $self->{'LogoCustomized'};
}



sub setLogoType {
  my $self = shift;
  $self->{'LogoType'} = shift
}


sub getLogoType {
  my $self = shift;
  return $self->{'LogoType'};
}



sub setLogoURL {
  my $self = shift;
  $self->{'LogoURL'} = shift
}


sub getLogoURL {
  my $self = shift;
  return $self->{'LogoURL'};
}



sub setTemplateText {
  my $self = shift;
  $self->{'TemplateText'} = shift
}


sub getTemplateText {
  my $self = shift;
  return $self->{'TemplateText'};
}



sub setTextCustomized {
  my $self = shift;
  $self->{'TextCustomized'} = shift
}


sub isTextCustomized {
  my $self = shift;
  return $self->{'TextCustomized'};
}





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

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



1;