File Coverage

lib/eBay/API/XML/Call/GetMessagePreferences.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::GetMessagePreferences;
4              
5 1     1   2266 use strict;
  1         3  
  1         24  
6 1     1   5 use warnings;
  1         1  
  1         24  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetMessagePreferences.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::GetMessagePreferences
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetMessagePreferences inherits from the L class
34              
35             =cut
36              
37 1     1   34 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesRequestType;
41             use eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetMessagePreferences';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetMessagePreferences::GetMessagePreferencesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setIncludeASQPreferences()
63              
64             If true, indicates that the ASQ subjects for the
65             specified user should be returned.
66              
67             RequiredInput: No
68             # Argument: 'xs:boolean'
69              
70             =cut
71            
72             sub setIncludeASQPreferences {
73             my $self = shift;
74             my $sIncludeASQPreferences = shift;
75             $self->getRequestDataType()->setIncludeASQPreferences($sIncludeASQPreferences);
76             }
77              
78             =head2 setSellerID()
79              
80             The ID of the user to retrieve ASQ subjects for. This
81             value must be specified in the request, but does not
82             need to be the same user as the user making the
83             request.
84              
85             RequiredInput: Yes
86             # Argument: 'ns:UserIDType'
87              
88             =cut
89            
90             sub setSellerID {
91             my $self = shift;
92             my $pSellerID = shift;
93             $self->getRequestDataType()->setSellerID($pSellerID);
94             }
95              
96              
97              
98             #
99             # output properties
100             #
101              
102             =head2 getASQPreferences()
103              
104             Returns a seller's ASQ subjects, each in its own Subject
105             node. If the seller has not customized the ASQ subjects
106             using SetMessagePreferences, the call will return the
107             current default values. Returned if
108             IncludeASQPreferences = true was specified in the
109             request.
110              
111             Returned: Conditionally
112             # Returns: 'ns:ASQPreferencesType'
113              
114             =cut
115            
116             sub getASQPreferences {
117             my $self = shift;
118             return $self->getResponseDataType()->getASQPreferences();
119             }
120              
121              
122              
123              
124              
125             1;