eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType - eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType

DESCRIPTION

Top

Contains the requesting application's notification preferences. GetNotificationPreferences retrieves preferences that you have deliberately set. For example, if you enable the EndOfAuction event and then later disable it, the response shows the EndOfAuction event preference as Disabled. But if you have never set a preference for the EndOfAuction event, no EndOfAuction preference is returned at all.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

Top

setApplicationDeliveryPreferences()

Specifies application-based event preferences that have been enabled.

# Argument: 'ns:ApplicationDeliveryPreferencesType'

getApplicationDeliveryPreferences()

  Returned: Conditionally
#    Returns: 'ns:ApplicationDeliveryPreferencesType'

setDeliveryURLName()

Specifies application delivery URL Name associated with this user.

# Argument: 'xs:string'

getDeliveryURLName()

  Returned: Conditionally
#    Returns: 'xs:string'

setEventProperty()

Characteristics or details of an event such as type, name and value.

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

getEventProperty()

  Returned: Conditionally
#    Returns: reference to an array  
                      of 'ns:NotificationEventPropertyType'

setUserData()

return user data for notification settings such as set mobile phone number etc.

# Argument: 'ns:NotificationUserDataType'

getUserData()

  Returned: Conditionally
#    Returns: 'ns:NotificationUserDataType'

setUserDeliveryPreferenceArray()

Specifies user-based event preferences that have been enabled or disabled.

# Argument: 'ns:NotificationEnableArrayType'

getUserDeliveryPreferenceArray()

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

package eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetNotificationPreferencesResponseType.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::ApplicationDeliveryPreferencesType;
use eBay::API::XML::DataType::NotificationEnableArrayType;
use eBay::API::XML::DataType::NotificationEventPropertyType;
use eBay::API::XML::DataType::NotificationUserDataType;


my @gaProperties = ( [ 'ApplicationDeliveryPreferences', 'ns:ApplicationDeliveryPreferencesType', ''
	     ,'eBay::API::XML::DataType::ApplicationDeliveryPreferencesType', '1' ]
	, [ 'DeliveryURLName', 'xs:string', '', '', '' ]
	, [ 'EventProperty', 'ns:NotificationEventPropertyType', '1'
	     ,'eBay::API::XML::DataType::NotificationEventPropertyType', '1' ]
	, [ 'UserData', 'ns:NotificationUserDataType', ''
	     ,'eBay::API::XML::DataType::NotificationUserDataType', '1' ]
	, [ 'UserDeliveryPreferenceArray', 'ns:NotificationEnableArrayType', ''
	     ,'eBay::API::XML::DataType::NotificationEnableArrayType', '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 setApplicationDeliveryPreferences {
  my $self = shift;
  $self->{'ApplicationDeliveryPreferences'} = shift
}


sub getApplicationDeliveryPreferences {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ApplicationDeliveryPreferences'
		,'eBay::API::XML::DataType::ApplicationDeliveryPreferencesType');
}



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


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



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


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



sub setUserData {
  my $self = shift;
  $self->{'UserData'} = shift
}


sub getUserData {
  my $self = shift;
  return $self->_getDataTypeInstance( 'UserData'
		,'eBay::API::XML::DataType::NotificationUserDataType');
}



sub setUserDeliveryPreferenceArray {
  my $self = shift;
  $self->{'UserDeliveryPreferenceArray'} = shift
}


sub getUserDeliveryPreferenceArray {
  my $self = shift;
  return $self->_getDataTypeInstance( 'UserDeliveryPreferenceArray'
		,'eBay::API::XML::DataType::NotificationEnableArrayType');
}





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

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



1;