eBay::API::XML::DataType::BotBlockRequestType - eBay::API::XML::DataType::BotBlockRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::BotBlockRequestType

DESCRIPTION

Top

Container of token and user reply.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::BotBlockRequestType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setBotBlockToken()

An encrypted token that eBay generates and that applications need to pass as input to subsquent calls. One use of this might be to block users from the site due to multiple call requests.

  Calls: PlaceOffer
  RequiredInput: Conditionally

# Argument: 'xs:string'

getBotBlockToken()

# Returns: 'xs:string'

setBotBlockUserInput()

The user's response to being asked to type the message in the botblock challenge image (that is, the image corresponding to BotBlockUrl that has been returned in a previous call).

  Calls: PlaceOffer
  RequiredInput: Conditionally

# Argument: 'xs:string'

getBotBlockUserInput()

# Returns: 'xs:string'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::BotBlockRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. BotBlockRequestType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");



my @gaProperties = ( [ 'BotBlockToken', 'xs:string', '', '', '' ]
	, [ 'BotBlockUserInput', 'xs:string', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setBotBlockToken {
  my $self = shift;
  $self->{'BotBlockToken'} = shift
}


sub getBotBlockToken {
  my $self = shift;
  return $self->{'BotBlockToken'};
}



sub setBotBlockUserInput {
  my $self = shift;
  $self->{'BotBlockUserInput'} = shift
}


sub getBotBlockUserInput {
  my $self = shift;
  return $self->{'BotBlockUserInput'};
}





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

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



1;