eBay::API::XML::DataType::MemberMessageType - eBay::API::XML::DataType::MemberMessageType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::MemberMessageType

DESCRIPTION

Top

Container for individual message information.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setBody()

Message content.

MaxLength: 1000

  Calls: AddMemberMessageAAQToPartner
         AddMemberMessageRTQ
         AddMemberMessagesAAQToBidder
  RequiredInput: Yes

# Argument: 'xs:string'

getBody()

  Calls: GetAdFormatLeads
  Returned: Conditionally
  Details: DetailLevel: ReturnAll

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'xs:string'

setDisplayToPublic()

Specifies if the body should be displayed to the public.

  Calls: AddMemberMessageRTQ
  RequiredInput: No

# Argument: 'xs:boolean'

isDisplayToPublic()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'xs:boolean'

setEmailCopyToSender()

Specifies whether or not to email a copy of the message to the sender. If omitted, this defaults to whatever the user set in preferences.

Default: omitted

  Calls: AddMemberMessageAAQToPartner
         AddMemberMessageRTQ
         AddMemberMessagesAAQToBidder
  RequiredInput: No

# Argument: 'xs:boolean'

isEmailCopyToSender()

# Returns: 'xs:boolean'

setHideSendersEmailAddress()

Specifies whether or not to hide sender's email address from the recipient. If omitted, this defaults to whatever the user set in preferences--or on site policy, which determines whether or not this field is recognized. <br><br> <span class="tablenote"><b>Note:</b> Starting Mid-July 2008 this tag is not operational in the Sandbox environment and is not operational in the Production environment beginning late August 2008. </span>

Default: omitted DeprecationDetails: NoOp DeprecationVersion: 579 UseInstead: Calls: AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder RequiredInput: No

# Argument: 'xs:boolean'

isHideSendersEmailAddress()

# Returns: 'xs:boolean'

setMessageID()

An ID that uniquely identifies a message for a given user. <br /><br /> This value is not the same as the value used for the GetMyMessages MessageID. However, this MessageID value can be used as the GetMyMessages ExternalID.

# Argument: 'xs:string'

getMessageID()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'xs:string'

setMessageType()

The type of message being retrieved. Note that some message types can only be created via the eBay Web site.

  Calls: AddMemberMessagesAAQToBidder
  RequiredInput: Yes

# Argument: 'ns:MessageTypeCodeType'

getMessageType()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'ns:MessageTypeCodeType'

setParentMessageID()

ID number of the question this message is responding to.

  Calls: AddMemberMessageRTQ
  RequiredInput: Yes

# Argument: 'xs:string'

getParentMessageID()

# Returns: 'xs:string'

setQuestionType()

The context of the question (e.g. Shipping, General).

  Calls: AddMemberMessageAAQToPartner
  RequiredInput: Yes

# Argument: 'ns:QuestionTypeCodeType'

getQuestionType()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'ns:QuestionTypeCodeType'

setRecipientID()

Recipient's eBay user ID. For AddMemberMessagesAAQToBidder, must be the seller of an item, that item's bidder, or a user who has made an offer on that item via Best Offer. Note: maxOccurs is a shared schema element and needs to be unbounded for AddMemberMessagesAAQToBidder. For all other uses, there can only be one RecipientID.

  Calls: AddMemberMessageAAQToPartner
         AddMemberMessageRTQ
         AddMemberMessagesAAQToBidder
  RequiredInput: Yes

# Argument: reference to an array of 'xs:string'

getRecipientID()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: reference to an array of 'xs:string'

setSenderEmail()

The email address of the person who asked the question or sent the message. Returned for MessageType = AskSellerQuestion and by the AskSellerQuestion notification.

# Argument: 'xs:string'

getSenderEmail()

  Calls: GetMemberMessages
  Returned: Conditionally
  DeprecationVersion: 573

# Returns: 'xs:string'

setSenderID()

The eBay user ID of the person who asked the question or sent the message.

# Argument: 'xs:string'

getSenderID()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'xs:string'

setSubject()

Subject of this email message.

  Calls: AddMemberMessageAAQToPartner
  RequiredInput: Yes

# Argument: 'xs:string'

getSubject()

  Calls: GetMemberMessages
  Returned: Conditionally

# Returns: 'xs:string'

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

package eBay::API::XML::DataType::MemberMessageType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. MemberMessageType.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");

use eBay::API::XML::DataType::Enum::MessageTypeCodeType;
use eBay::API::XML::DataType::Enum::QuestionTypeCodeType;


my @gaProperties = ( [ 'Body', 'xs:string', '', '', '' ]
	, [ 'DisplayToPublic', 'xs:boolean', '', '', '' ]
	, [ 'EmailCopyToSender', 'xs:boolean', '', '', '' ]
	, [ 'HideSendersEmailAddress', 'xs:boolean', '', '', '' ]
	, [ 'MessageID', 'xs:string', '', '', '' ]
	, [ 'MessageType', 'ns:MessageTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MessageTypeCodeType', '' ]
	, [ 'ParentMessageID', 'xs:string', '', '', '' ]
	, [ 'QuestionType', 'ns:QuestionTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::QuestionTypeCodeType', '' ]
	, [ 'RecipientID', 'xs:string', '1', '', '' ]
	, [ 'SenderEmail', 'xs:string', '', '', '' ]
	, [ 'SenderID', 'xs:string', '', '', '' ]
	, [ 'Subject', '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 setBody {
  my $self = shift;
  $self->{'Body'} = shift
}


sub getBody {
  my $self = shift;
  return $self->{'Body'};
}



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


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



sub setEmailCopyToSender {
  my $self = shift;
  $self->{'EmailCopyToSender'} = shift
}


sub isEmailCopyToSender {
  my $self = shift;
  return $self->{'EmailCopyToSender'};
}



sub setHideSendersEmailAddress {
  my $self = shift;
  $self->{'HideSendersEmailAddress'} = shift
}


sub isHideSendersEmailAddress {
  my $self = shift;
  return $self->{'HideSendersEmailAddress'};
}



sub setMessageID {
  my $self = shift;
  $self->{'MessageID'} = shift
}


sub getMessageID {
  my $self = shift;
  return $self->{'MessageID'};
}



sub setMessageType {
  my $self = shift;
  $self->{'MessageType'} = shift
}


sub getMessageType {
  my $self = shift;
  return $self->{'MessageType'};
}



sub setParentMessageID {
  my $self = shift;
  $self->{'ParentMessageID'} = shift
}


sub getParentMessageID {
  my $self = shift;
  return $self->{'ParentMessageID'};
}



sub setQuestionType {
  my $self = shift;
  $self->{'QuestionType'} = shift
}


sub getQuestionType {
  my $self = shift;
  return $self->{'QuestionType'};
}



sub setRecipientID {
  my $self = shift;
  $self->{'RecipientID'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getRecipientID {
  my $self = shift;
  return $self->_getDataTypeArray('RecipientID');
}



sub setSenderEmail {
  my $self = shift;
  $self->{'SenderEmail'} = shift
}


sub getSenderEmail {
  my $self = shift;
  return $self->{'SenderEmail'};
}



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


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



sub setSubject {
  my $self = shift;
  $self->{'Subject'} = shift
}


sub getSubject {
  my $self = shift;
  return $self->{'Subject'};
}





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

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



1;