eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType - eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType

DESCRIPTION

Top

Used to retrieve information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text. <br /><br /> Note that this call requires a DetailLevel in the request. Omitting the Detail Level returns an error. <br /><br /> ItemID is not returned with this call. Use GetMemberMessages instead.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setAlertIDs()

Contains a list of up to 10 AlertID values. When AlertID values are used as input, you must generally specify either AlertID values, or MessageID values, or both.

  RequiredInput: Conditionally
#    Argument: 'ns:MyMessagesAlertIDArrayType'

getAlertIDs()

# Returns: 'ns:MyMessagesAlertIDArrayType'

setEndTime()

Used as end of date range filter.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

getEndTime()

# Returns: 'xs:dateTime'

setExternalMessageIDs()

An ID that Uniquely identifies a message for a given user.If provided at the time of message creation this ID will be used to retrieve messages and will take precedence over message ID.

  RequiredInput: Conditionally
#    Argument: 'ns:MyMessagesExternalMessageIDArrayType'

getExternalMessageIDs()

# Returns: 'ns:MyMessagesExternalMessageIDArrayType'

setFolderID()

An ID that uniquely identifies the My Messages folder from which to retrieve alerts or messages.

  RequiredInput: No
#    Argument: 'xs:long'

getFolderID()

# Returns: 'xs:long'

setMessageIDs()

Contains a list of up to 10 MessageID values. When MessageID values are used as input, you must generally specify either AlertID values, or MessageID values, or both.

  RequiredInput: Conditionally
#    Argument: 'ns:MyMessagesMessageIDArrayType'

getMessageIDs()

# Returns: 'ns:MyMessagesMessageIDArrayType'

setStartTime()

Used as beginning of date range filter.

  RequiredInput: No
#    Argument: 'xs:dateTime'

getStartTime()

# Returns: 'xs:dateTime'

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

package eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::MyMessagesAlertIDArrayType;
use eBay::API::XML::DataType::MyMessagesExternalMessageIDArrayType;
use eBay::API::XML::DataType::MyMessagesMessageIDArrayType;


my @gaProperties = ( [ 'AlertIDs', 'ns:MyMessagesAlertIDArrayType', ''
	     ,'eBay::API::XML::DataType::MyMessagesAlertIDArrayType', '1' ]
	, [ 'EndTime', 'xs:dateTime', '', '', '' ]
	, [ 'ExternalMessageIDs', 'ns:MyMessagesExternalMessageIDArrayType', ''
	     ,'eBay::API::XML::DataType::MyMessagesExternalMessageIDArrayType', '1' ]
	, [ 'FolderID', 'xs:long', '', '', '' ]
	, [ 'MessageIDs', 'ns:MyMessagesMessageIDArrayType', ''
	     ,'eBay::API::XML::DataType::MyMessagesMessageIDArrayType', '1' ]
	, [ 'StartTime', 'xs:dateTime', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setAlertIDs {
  my $self = shift;
  $self->{'AlertIDs'} = shift
}


sub getAlertIDs {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AlertIDs'
		,'eBay::API::XML::DataType::MyMessagesAlertIDArrayType');
}



sub setEndTime {
  my $self = shift;
  $self->{'EndTime'} = shift
}


sub getEndTime {
  my $self = shift;
  return $self->{'EndTime'};
}



sub setExternalMessageIDs {
  my $self = shift;
  $self->{'ExternalMessageIDs'} = shift
}


sub getExternalMessageIDs {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ExternalMessageIDs'
		,'eBay::API::XML::DataType::MyMessagesExternalMessageIDArrayType');
}



sub setFolderID {
  my $self = shift;
  $self->{'FolderID'} = shift
}


sub getFolderID {
  my $self = shift;
  return $self->{'FolderID'};
}



sub setMessageIDs {
  my $self = shift;
  $self->{'MessageIDs'} = shift
}


sub getMessageIDs {
  my $self = shift;
  return $self->_getDataTypeInstance( 'MessageIDs'
		,'eBay::API::XML::DataType::MyMessagesMessageIDArrayType');
}



sub setStartTime {
  my $self = shift;
  $self->{'StartTime'} = shift
}


sub getStartTime {
  my $self = shift;
  return $self->{'StartTime'};
}





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

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



1;