eBay::API::XML::Call::GetMemberMessages::GetMemberMessagesRequestType - eBay::API::XML::Call::GetMemberMessages::GetMemberMessagesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetMemberMessages::GetMemberMessagesRequestType

DESCRIPTION

Top

Retrieves a list of the messages buyers have posted about your active item listings.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetMemberMessages::GetMemberMessagesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setDisplayToPublic()

Specifies if the message should be displayed on the website with the item listing.

  RequiredInput: No
#    Argument: 'xs:boolean'

isDisplayToPublic()

# Returns: 'xs:boolean'

setEndCreationTime()

Used as end of date range filter. If specified, filters the returned messages to only those with a creation date less than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

getEndCreationTime()

# Returns: 'xs:dateTime'

setItemID()

The ID of the item the message is about. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. ItemID is otherwise ignored.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

  RequiredInput: Conditionally
#    Argument: 'ns:ItemIDType'

getItemID()

# Returns: 'ns:ItemIDType'

setMailMessageType()

The type of message.

  RequiredInput: Yes
#    Argument: 'ns:MessageTypeCodeType'

getMailMessageType()

# Returns: 'ns:MessageTypeCodeType'

setMemberMessageID()

An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only.

  RequiredInput: No
#    Argument: 'xs:string'

getMemberMessageID()

# Returns: 'xs:string'

setMessageStatus()

The status of the message.

  RequiredInput: Conditionally
#    Argument: 'ns:MessageStatusTypeCodeType'

getMessageStatus()

# Returns: 'ns:MessageStatusTypeCodeType'

setPagination()

Standard pagination argument used to reduce response.

  RequiredInput: Yes
#    Argument: 'ns:PaginationType'

getPagination()

# Returns: 'ns:PaginationType'

setSenderID()

An eBay ID that uniquely identifies a user. For GetMemberMessages, this is the sender of the message. If included in the request, returns only messages from the specified sender.

  RequiredInput: No
#    Argument: 'ns:UserIDType'

getSenderID()

# Returns: 'ns:UserIDType'

setStartCreationTime()

Used as beginning of date range filter. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

getStartCreationTime()

# Returns: 'xs:dateTime'

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

package eBay::API::XML::Call::GetMemberMessages::GetMemberMessagesRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetMemberMessagesRequestType.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::ItemIDType;
use eBay::API::XML::DataType::PaginationType;
use eBay::API::XML::DataType::UserIDType;
use eBay::API::XML::DataType::Enum::MessageStatusTypeCodeType;
use eBay::API::XML::DataType::Enum::MessageTypeCodeType;


my @gaProperties = ( [ 'DisplayToPublic', 'xs:boolean', '', '', '' ]
	, [ 'EndCreationTime', 'xs:dateTime', '', '', '' ]
	, [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'MailMessageType', 'ns:MessageTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MessageTypeCodeType', '' ]
	, [ 'MemberMessageID', 'xs:string', '', '', '' ]
	, [ 'MessageStatus', 'ns:MessageStatusTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MessageStatusTypeCodeType', '' ]
	, [ 'Pagination', 'ns:PaginationType', ''
	     ,'eBay::API::XML::DataType::PaginationType', '1' ]
	, [ 'SenderID', 'ns:UserIDType', ''
	     ,'eBay::API::XML::DataType::UserIDType', '1' ]
	, [ 'StartCreationTime', '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 setDisplayToPublic {
  my $self = shift;
  $self->{'DisplayToPublic'} = shift
}


sub isDisplayToPublic {
  my $self = shift;
  return $self->{'DisplayToPublic'};
}



sub setEndCreationTime {
  my $self = shift;
  $self->{'EndCreationTime'} = shift
}


sub getEndCreationTime {
  my $self = shift;
  return $self->{'EndCreationTime'};
}



sub setItemID {
  my $self = shift;
  $self->{'ItemID'} = shift
}


sub getItemID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ItemID'
		,'eBay::API::XML::DataType::ItemIDType');
}



sub setMailMessageType {
  my $self = shift;
  $self->{'MailMessageType'} = shift
}


sub getMailMessageType {
  my $self = shift;
  return $self->{'MailMessageType'};
}



sub setMemberMessageID {
  my $self = shift;
  $self->{'MemberMessageID'} = shift
}


sub getMemberMessageID {
  my $self = shift;
  return $self->{'MemberMessageID'};
}



sub setMessageStatus {
  my $self = shift;
  $self->{'MessageStatus'} = shift
}


sub getMessageStatus {
  my $self = shift;
  return $self->{'MessageStatus'};
}



sub setPagination {
  my $self = shift;
  $self->{'Pagination'} = shift
}


sub getPagination {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Pagination'
		,'eBay::API::XML::DataType::PaginationType');
}



sub setSenderID {
  my $self = shift;
  $self->{'SenderID'} = shift
}


sub getSenderID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SenderID'
		,'eBay::API::XML::DataType::UserIDType');
}



sub setStartCreationTime {
  my $self = shift;
  $self->{'StartCreationTime'} = shift
}


sub getStartCreationTime {
  my $self = shift;
  return $self->{'StartCreationTime'};
}





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

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



1;