Package com.apple.itunes.storekit.model

Class UploadMessageRequestBody

java.lang.Object

com.apple.itunes.storekit.model.UploadMessageRequestBody

public class UploadMessageRequestBody
extends Object

The request body for uploading a message, which includes the message text and an optional image reference.

See Also:

• UploadMessageRequestBody

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UploadMessageRequestBody()
	UploadMessageRequestBody(String header, String body)
	UploadMessageRequestBody(String header, String body, UploadMessageImage image)	Deprecated. Use UploadMessageRequestBody(String, String) instead.

Method Summary

Modifier and Type	Method	Description
UploadMessageRequestBody	body(String body)
UploadMessageRequestBody	bulletPoints(List<BulletPoint> bulletPoints)
boolean	equals(Object o)
String	getBody()	The body text of the retention message that the system displays to customers.
List<BulletPoint>	getBulletPoints()	An optional array of bullet points.
String	getHeader()	The header text of the retention message that the system displays to customers.
HeaderPosition	getHeaderPosition()	The position of header text, which defaults to placing header text above the body.
UploadMessageImage	getImage()	The optional image identifier and its alternative text to appear as part of a text-based message with an image.
String	getRawHeaderPosition()
int	hashCode()
UploadMessageRequestBody	header(String header)
UploadMessageRequestBody	headerPosition(HeaderPosition headerPosition)
UploadMessageRequestBody	image(UploadMessageImage image)
void	setBody(String body)
void	setBulletPoints(List<BulletPoint> bulletPoints)
void	setHeader(String header)
void	setHeaderPosition(HeaderPosition headerPosition)
void	setImage(UploadMessageImage image)
void	setRawHeaderPosition(String rawHeaderPosition)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UploadMessageRequestBody

protected UploadMessageRequestBody()

UploadMessageRequestBody

@Deprecated
public UploadMessageRequestBody(String header,
 String body,
 UploadMessageImage image)

Deprecated.

Use UploadMessageRequestBody(String, String) instead.

UploadMessageRequestBody

public UploadMessageRequestBody(String header,
 String body)

Method Details

header

public UploadMessageRequestBody header(String header)

getHeader

public String getHeader()

The header text of the retention message that the system displays to customers.

Returns:

header

See Also:

• header

setHeader

public void setHeader(String header)

body

public UploadMessageRequestBody body(String body)

getBody

public String getBody()

The body text of the retention message that the system displays to customers.

Returns:

body

See Also:

• body

setBody

public void setBody(String body)

image

public UploadMessageRequestBody image(UploadMessageImage image)

getImage

public UploadMessageImage getImage()

The optional image identifier and its alternative text to appear as part of a text-based message with an image.

Returns:

image

See Also:

• UploadMessageImage

setImage

public void setImage(UploadMessageImage image)

headerPosition

public UploadMessageRequestBody headerPosition(HeaderPosition headerPosition)

getHeaderPosition

public HeaderPosition getHeaderPosition()

The position of header text, which defaults to placing header text above the body.

Returns:

headerPosition

See Also:

• headerPosition

getRawHeaderPosition

public String getRawHeaderPosition()

See Also:

• getHeaderPosition()

setHeaderPosition

public void setHeaderPosition(HeaderPosition headerPosition)

setRawHeaderPosition

public void setRawHeaderPosition(String rawHeaderPosition)

bulletPoints

public UploadMessageRequestBody bulletPoints(List<BulletPoint> bulletPoints)

getBulletPoints

public List<BulletPoint> getBulletPoints()

An optional array of bullet points.

Returns:

bulletPoints

See Also:

• BulletPoint

setBulletPoints

public void setBulletPoints(List<BulletPoint> bulletPoints)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object