File Coverage

lib/eBay/API/XML/DataType/BotBlockResponseType.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::DataType::BotBlockResponseType;
4              
5 1     1   1523 use strict;
  1         2  
  1         61  
6 1     1   5 use warnings;
  1         3  
  1         35  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. BotBlockResponseType.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::DataType::BotBlockResponseType
21              
22             =head1 DESCRIPTION
23              
24             Container of token and image URL and Audio URL.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::DataType::BotBlockResponseType inherits from the L class
36              
37             =cut
38              
39 1     1   46 use eBay::API::XML::BaseDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::BaseDataType");
41              
42              
43              
44             my @gaProperties = ( [ 'BotBlockAudioUrl', 'xs:string', '', '', '' ]
45             , [ 'BotBlockToken', 'xs:string', '', '', '' ]
46             , [ 'BotBlockUrl', 'xs:string', '', '', '' ]
47             );
48             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
49              
50             my @gaAttributes = (
51             );
52             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
53              
54             =head1 Subroutines:
55              
56             =cut
57              
58             sub new {
59             my $classname = shift;
60             my %args = @_;
61             my $self = $classname->SUPER::new(%args);
62             return $self;
63             }
64              
65             sub isScalar {
66             return 0;
67             }
68              
69              
70              
71             =head2 setBotBlockAudioUrl()
72              
73             The URL of the audio-clip that your application should provide for sight-impaired users.
74             The BotBlockAudioUrl audio-clip corresponds to the BotBlockUrl image.
75              
76             # Argument: 'xs:string'
77              
78             =cut
79              
80             sub setBotBlockAudioUrl {
81             my $self = shift;
82             $self->{'BotBlockAudioUrl'} = shift
83             }
84              
85             =head2 getBotBlockAudioUrl()
86              
87             Calls: PlaceOffer
88             Returned: Conditionally
89              
90             # Returns: 'xs:string'
91              
92             =cut
93              
94             sub getBotBlockAudioUrl {
95             my $self = shift;
96             return $self->{'BotBlockAudioUrl'};
97             }
98              
99              
100             =head2 setBotBlockToken()
101              
102             An encrypted token generated by eBay when the botblock
103             mechanism is triggered. This token is mapped to BotBlockUrl
104             and BotBlockAudioUrl.
105              
106             # Argument: 'xs:string'
107              
108             =cut
109              
110             sub setBotBlockToken {
111             my $self = shift;
112             $self->{'BotBlockToken'} = shift
113             }
114              
115             =head2 getBotBlockToken()
116              
117             Calls: PlaceOffer
118             Returned: Conditionally
119              
120             # Returns: 'xs:string'
121              
122             =cut
123              
124             sub getBotBlockToken {
125             my $self = shift;
126             return $self->{'BotBlockToken'};
127             }
128              
129              
130             =head2 setBotBlockUrl()
131              
132             The URL of the image that your application should display to
133             the user for a botblock challenge.
134              
135             # Argument: 'xs:string'
136              
137             =cut
138              
139             sub setBotBlockUrl {
140             my $self = shift;
141             $self->{'BotBlockUrl'} = shift
142             }
143              
144             =head2 getBotBlockUrl()
145              
146             Calls: PlaceOffer
147             Returned: Conditionally
148              
149             # Returns: 'xs:string'
150              
151             =cut
152              
153             sub getBotBlockUrl {
154             my $self = shift;
155             return $self->{'BotBlockUrl'};
156             }
157              
158              
159              
160              
161              
162             ## Attribute and Property lists
163             sub getPropertiesList {
164             my $self = shift;
165             return \@gaProperties;
166             }
167              
168             sub getAttributesList {
169             my $self = shift;
170             return \@gaAttributes;
171             }
172              
173              
174              
175             1;