File Coverage

lib/eBay/API/XML/Call/GetNotificationPreferences.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 10 12 83.3


line stmt bran cond sub pod time code
1             #!/usr/bin/perl
2              
3             package eBay::API::XML::Call::GetNotificationPreferences;
4              
5 1     1   2451 use strict;
  1         3  
  1         27  
6 1     1   4 use warnings;
  1         1  
  1         26  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetNotificationPreferences.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 08/24/2008 16:44
14             # API Release Number: ... 579
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::Call::GetNotificationPreferences
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetNotificationPreferences inherits from the L class
34              
35             =cut
36              
37 1     1   33 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesRequestType;
41             use eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetNotificationPreferences';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetNotificationPreferences::GetNotificationPreferencesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setPreferenceLevel()
63              
64             Specifies what type of Preference to retrieve.
65              
66             RequiredInput: Yes
67             # Argument: 'ns:NotificationRoleCodeType'
68              
69             =cut
70            
71             sub setPreferenceLevel {
72             my $self = shift;
73             my $sPreferenceLevel = shift;
74             $self->getRequestDataType()->setPreferenceLevel($sPreferenceLevel);
75             }
76              
77              
78              
79             #
80             # output properties
81             #
82              
83             =head2 getApplicationDeliveryPreferences()
84              
85             Specifies application-based event preferences that have been enabled.
86              
87             Returned: Conditionally
88             # Returns: 'ns:ApplicationDeliveryPreferencesType'
89              
90             =cut
91            
92             sub getApplicationDeliveryPreferences {
93             my $self = shift;
94             return $self->getResponseDataType()->getApplicationDeliveryPreferences();
95             }
96              
97             =head2 getDeliveryURLName()
98              
99             Specifies application delivery URL Name associated with this user.
100              
101             Returned: Conditionally
102             # Returns: 'xs:string'
103              
104             =cut
105            
106             sub getDeliveryURLName {
107             my $self = shift;
108             return $self->getResponseDataType()->getDeliveryURLName();
109             }
110              
111             =head2 getEventProperty()
112              
113             Characteristics or details of an event such as type, name and value.
114              
115             Returned: Conditionally
116             # Returns: reference to an array
117             of 'ns:NotificationEventPropertyType'
118              
119             =cut
120            
121             sub getEventProperty {
122             my $self = shift;
123             return $self->getResponseDataType()->getEventProperty();
124             }
125              
126             =head2 getUserData()
127              
128             return user data for notification settings such as set mobile phone number etc.
129              
130             Returned: Conditionally
131             # Returns: 'ns:NotificationUserDataType'
132              
133             =cut
134            
135             sub getUserData {
136             my $self = shift;
137             return $self->getResponseDataType()->getUserData();
138             }
139              
140             =head2 getUserDeliveryPreferenceArray()
141              
142             Specifies user-based event preferences that have been enabled or disabled.
143              
144             Returned: Conditionally
145             # Returns: 'ns:NotificationEnableArrayType'
146              
147             =cut
148            
149             sub getUserDeliveryPreferenceArray {
150             my $self = shift;
151             return $self->getResponseDataType()->getUserDeliveryPreferenceArray();
152             }
153              
154              
155              
156              
157              
158             1;