File Coverage

lib/eBay/API/XML/Call/ValidateChallengeInput.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::ValidateChallengeInput;
4              
5 1     1   2009 use strict;
  1         3  
  1         28  
6 1     1   6 use warnings;
  1         2  
  1         26  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ValidateChallengeInput.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::ValidateChallengeInput
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::ValidateChallengeInput inherits from the L class
34              
35             =cut
36              
37 1     1   60 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::ValidateChallengeInput::ValidateChallengeInputRequestType;
41             use eBay::API::XML::Call::ValidateChallengeInput::ValidateChallengeInputResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'ValidateChallengeInput';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::ValidateChallengeInput::ValidateChallengeInputRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::ValidateChallengeInput::ValidateChallengeInputResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setChallengeToken()
63              
64             Botblock token that was returned by GetChallengeToken.
65              
66             RequiredInput: Yes
67             # Argument: 'xs:string'
68              
69             =cut
70            
71             sub setChallengeToken {
72             my $self = shift;
73             my $sChallengeToken = shift;
74             $self->getRequestDataType()->setChallengeToken($sChallengeToken);
75             }
76              
77             =head2 setKeepTokenValid()
78              
79             Whether the challenge token should remain valid for up to two minutes.
80              
81             Default: false
82              
83             RequiredInput: No
84             # Argument: 'xs:boolean'
85              
86             =cut
87            
88             sub setKeepTokenValid {
89             my $self = shift;
90             my $sKeepTokenValid = shift;
91             $self->getRequestDataType()->setKeepTokenValid($sKeepTokenValid);
92             }
93              
94             =head2 setUserInput()
95              
96             User response to a botblock challenge.
97              
98             RequiredInput: Yes
99             # Argument: 'xs:string'
100              
101             =cut
102            
103             sub setUserInput {
104             my $self = shift;
105             my $sUserInput = shift;
106             $self->getRequestDataType()->setUserInput($sUserInput);
107             }
108              
109              
110              
111             #
112             # output properties
113             #
114              
115             =head2 isValidToken()
116              
117             Indicates whether the token is valid.
118              
119             Returned: Always
120             # Returns: 'xs:boolean'
121              
122             =cut
123            
124             sub isValidToken {
125             my $self = shift;
126             return $self->getResponseDataType()->isValidToken();
127             }
128              
129              
130              
131              
132              
133             1;