eBay::API::XML::DataType::NotificationDetailsType - eBay::API::XML::DataType::NotificationDetailsType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::NotificationDetailsType

DESCRIPTION

Top

Information about a single notification. Notification information includes the reference ID, notification type, current status, time delivered, error code, and error message for the notification. If notification details are included in the response, all of the detail fields are returned.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setDeliveryStatus()

Returns the notification status. Possible values include Delivered, Failed, Rejected, and MarkedDown.

# Argument: 'ns:NotificationEventStateCodeType'

getDeliveryStatus()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'ns:NotificationEventStateCodeType'

setDeliveryTime()

Returns the time when the notification was delivered.

# Argument: 'xs:dateTime'

getDeliveryTime()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:dateTime'

setDeliveryURL()

Returns the destination address for the notification. This is the value set using SetNotificationPreferences.

# Argument: 'xs:anyURI'

getDeliveryURL()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:anyURI'

setDeliveryURLName()

Returns the delivery URL name for the notification. This is the value set using SetNotificationPreferences.

# Argument: 'xs:string'

getDeliveryURLName()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:string'

setErrorMessage()

Returns the error message.

# Argument: 'xs:string'

getErrorMessage()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:string'

setExpirationTime()

Date and time when this notification will be removed from the eBay system.

# Argument: 'xs:dateTime'

getExpirationTime()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:dateTime'

setNextRetryTime()

Returns the time when the notification is scheduled for retry. This won't be included if the DeliveryStatus is Delivered.

# Argument: 'xs:dateTime'

getNextRetryTime()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:dateTime'

setReferenceID()

Reference identifier for the notification.

# Argument: 'xs:string'

getReferenceID()

# Returns: 'xs:string'

setRetries()

Returns the total number of retries for the given notification.

# Argument: 'xs:int'

getRetries()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'xs:int'

setType()

Returns the notification type. Possible values include: AskSellerQuestion, AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction, Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived, MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute, UPISellerOpenedDispute, and UPISellerRespondedToDispute.

# Argument: 'ns:NotificationEventTypeCodeType'

getType()

  Calls: GetNotificationsUsage
  Returned: Conditionally

# Returns: 'ns:NotificationEventTypeCodeType'

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

package eBay::API::XML::DataType::NotificationDetailsType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. NotificationDetailsType.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::NotificationEventStateCodeType;
use eBay::API::XML::DataType::Enum::NotificationEventTypeCodeType;


my @gaProperties = ( [ 'DeliveryStatus', 'ns:NotificationEventStateCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::NotificationEventStateCodeType', '' ]
	, [ 'DeliveryTime', 'xs:dateTime', '', '', '' ]
	, [ 'DeliveryURL', 'xs:anyURI', '', '', '' ]
	, [ 'DeliveryURLName', 'xs:string', '', '', '' ]
	, [ 'ErrorMessage', 'xs:string', '', '', '' ]
	, [ 'ExpirationTime', 'xs:dateTime', '', '', '' ]
	, [ 'NextRetryTime', 'xs:dateTime', '', '', '' ]
	, [ 'ReferenceID', 'xs:string', '', '', '' ]
	, [ 'Retries', 'xs:int', '', '', '' ]
	, [ 'Type', 'ns:NotificationEventTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::NotificationEventTypeCodeType', '' ]
                    );
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 setDeliveryStatus {
  my $self = shift;
  $self->{'DeliveryStatus'} = shift
}


sub getDeliveryStatus {
  my $self = shift;
  return $self->{'DeliveryStatus'};
}



sub setDeliveryTime {
  my $self = shift;
  $self->{'DeliveryTime'} = shift
}


sub getDeliveryTime {
  my $self = shift;
  return $self->{'DeliveryTime'};
}



sub setDeliveryURL {
  my $self = shift;
  $self->{'DeliveryURL'} = shift
}


sub getDeliveryURL {
  my $self = shift;
  return $self->{'DeliveryURL'};
}



sub setDeliveryURLName {
  my $self = shift;
  $self->{'DeliveryURLName'} = shift
}


sub getDeliveryURLName {
  my $self = shift;
  return $self->{'DeliveryURLName'};
}



sub setErrorMessage {
  my $self = shift;
  $self->{'ErrorMessage'} = shift
}


sub getErrorMessage {
  my $self = shift;
  return $self->{'ErrorMessage'};
}



sub setExpirationTime {
  my $self = shift;
  $self->{'ExpirationTime'} = shift
}


sub getExpirationTime {
  my $self = shift;
  return $self->{'ExpirationTime'};
}



sub setNextRetryTime {
  my $self = shift;
  $self->{'NextRetryTime'} = shift
}


sub getNextRetryTime {
  my $self = shift;
  return $self->{'NextRetryTime'};
}



sub setReferenceID {
  my $self = shift;
  $self->{'ReferenceID'} = shift
}


sub getReferenceID {
  my $self = shift;
  return $self->{'ReferenceID'};
}



sub setRetries {
  my $self = shift;
  $self->{'Retries'} = shift
}


sub getRetries {
  my $self = shift;
  return $self->{'Retries'};
}



sub setType {
  my $self = shift;
  $self->{'Type'} = shift
}


sub getType {
  my $self = shift;
  return $self->{'Type'};
}





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

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



1;