eBay::API::XML::DataType::SiteHostedPictureDetailsType - eBay::API::XML::DataType::SiteHostedPictureDetailsType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::SiteHostedPictureDetailsType

DESCRIPTION

Top

Contains information about an UploadSiteHostedPictures upload.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setBaseURL()

Truncated version of FullURL.

# Argument: 'xs:anyURI'

getBaseURL()

  Calls: UploadSiteHostedPictures
  Returned: Always

# Returns: 'xs:anyURI'

setFullURL()

The URL for the uploaded picture. Store this value for association with an item listing. That is, after you use UploadSiteHostedPictures to upload an image, use the value in FullURL to associate the image with an item (specify the value in Item.PictureDetails.PictureURL in AddItem, ReviseItem, or RelistItem) within 48 hours. Unassociated pictures are automatically deleted after that period.

# Argument: 'xs:anyURI'

getFullURL()

  Calls: UploadSiteHostedPictures
  Returned: Always

# Returns: 'xs:anyURI'

setPictureFormat()

The format into which an uploaded picture has been converted. This value is usually JPG, but may be GIF.

# Argument: 'ns:PictureFormatCodeType'

getPictureFormat()

  Calls: UploadSiteHostedPictures
  Returned: Always

# Returns: 'ns:PictureFormatCodeType'

setPictureName()

Corresponds to the PictureName input value that you specified in the request. You can use the PictureName output field to confirm that the UploadSiteHostedPictures response corresponds to a specific UploadSiteHostedPictures request.

# Argument: 'xs:string'

getPictureName()

  Calls: UploadSiteHostedPictures
  Returned: Conditionally

# Returns: 'xs:string'

setPictureSet()

The size of images generated. This value may differ from the one requested, e.g. if a Supersize image cannot be generated.

# Argument: 'ns:PictureSetCodeType'

getPictureSet()

  Calls: UploadSiteHostedPictures
  Returned: Always

# Returns: 'ns:PictureSetCodeType'

setPictureSetMember()

URL and size information for each generated and stored size. This data is not necessarily needed by your application, but is provided for use in picture previews. This data is used for display control for specific pictures in the generated imageset. This data is supplied for all generated pictures.

# Argument: reference to an array of 'ns:PictureSetMemberType'

getPictureSetMember()

  Calls: UploadSiteHostedPictures
  Returned: Always

# Returns: reference to an array of 'ns:PictureSetMemberType'

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

package eBay::API::XML::DataType::SiteHostedPictureDetailsType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. SiteHostedPictureDetailsType.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::PictureSetMemberType;
use eBay::API::XML::DataType::Enum::PictureFormatCodeType;
use eBay::API::XML::DataType::Enum::PictureSetCodeType;


my @gaProperties = ( [ 'BaseURL', 'xs:anyURI', '', '', '' ]
	, [ 'FullURL', 'xs:anyURI', '', '', '' ]
	, [ 'PictureFormat', 'ns:PictureFormatCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::PictureFormatCodeType', '' ]
	, [ 'PictureName', 'xs:string', '', '', '' ]
	, [ 'PictureSet', 'ns:PictureSetCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::PictureSetCodeType', '' ]
	, [ 'PictureSetMember', 'ns:PictureSetMemberType', '1'
	     ,'eBay::API::XML::DataType::PictureSetMemberType', '1' ]
                    );
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 setBaseURL {
  my $self = shift;
  $self->{'BaseURL'} = shift
}


sub getBaseURL {
  my $self = shift;
  return $self->{'BaseURL'};
}



sub setFullURL {
  my $self = shift;
  $self->{'FullURL'} = shift
}


sub getFullURL {
  my $self = shift;
  return $self->{'FullURL'};
}



sub setPictureFormat {
  my $self = shift;
  $self->{'PictureFormat'} = shift
}


sub getPictureFormat {
  my $self = shift;
  return $self->{'PictureFormat'};
}



sub setPictureName {
  my $self = shift;
  $self->{'PictureName'} = shift
}


sub getPictureName {
  my $self = shift;
  return $self->{'PictureName'};
}



sub setPictureSet {
  my $self = shift;
  $self->{'PictureSet'} = shift
}


sub getPictureSet {
  my $self = shift;
  return $self->{'PictureSet'};
}



sub setPictureSetMember {
  my $self = shift;
  $self->{'PictureSetMember'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getPictureSetMember {
  my $self = shift;
  return $self->_getDataTypeArray('PictureSetMember');
}





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

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



1;