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

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

Index

Code Index:

NAME

Top

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

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetMyMessages inherits from the eBay::API::XML::BaseCall 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'

setEndTime()

Used as end of date range filter.

  RequiredInput: Conditionally
#    Argument: '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'

setFolderID()

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

  RequiredInput: No
#    Argument: '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'

setStartTime()

Used as beginning of date range filter.

  RequiredInput: No
#    Argument: 'xs:dateTime'

getAlerts()

Contains the alert information for each alert specified in AlertIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesAlertType object per alert. Returned as an empty node if user has no alerts.

  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages
#    Returns: 'ns:MyMessagesAlertArrayType'

getMessages()

Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesMessageType object per message. Returned as an empty node if user has no messages.

  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages
#    Returns: 'ns:MyMessagesMessageArrayType'

getSummary()

Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages. The amount and type of data returned is the same whether or not the request included specific AlertID or MessageID values. Always/Conditionally returned logic assumes a detail level of ReturnMessages.

  Returned: Conditionally
  Details: DetailLevel: ReturnSummary
#    Returns: 'ns:MyMessagesSummaryType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

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

use strict;
use warnings;  

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


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

use eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType;
use eBay::API::XML::Call::GetMyMessages::GetMyMessagesResponseType;



sub getApiCallName {
   return 'GetMyMessages';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetMyMessages::GetMyMessagesRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetMyMessages::GetMyMessagesResponseType';
}

#
# input properties
#


       
sub setAlertIDs {
   my $self   = shift;
   my $pAlertIDs = shift;
   $self->getRequestDataType()->setAlertIDs($pAlertIDs);
}


       
sub setEndTime {
   my $self   = shift;
   my $sEndTime = shift;
   $self->getRequestDataType()->setEndTime($sEndTime);
}


       
sub setExternalMessageIDs {
   my $self   = shift;
   my $pExternalMessageIDs = shift;
   $self->getRequestDataType()->setExternalMessageIDs($pExternalMessageIDs);
}


       
sub setFolderID {
   my $self   = shift;
   my $sFolderID = shift;
   $self->getRequestDataType()->setFolderID($sFolderID);
}


       
sub setMessageIDs {
   my $self   = shift;
   my $pMessageIDs = shift;
   $self->getRequestDataType()->setMessageIDs($pMessageIDs);
}


       
sub setStartTime {
   my $self   = shift;
   my $sStartTime = shift;
   $self->getRequestDataType()->setStartTime($sStartTime);
}



#
# output properties
#


       
sub getAlerts {
   my $self = shift;
   return $self->getResponseDataType()->getAlerts();
}


       
sub getMessages {
   my $self = shift;
   return $self->getResponseDataType()->getMessages();
}


       
sub getSummary {
   my $self = shift;
   return $self->getResponseDataType()->getSummary();
}





1;