BodyTypeResponseType
extends Enumeration
in package
Defines how the body text is formatted in the response.
Table of Contents
Constants
- BEST = 'Best'
- The response will return the richest available content of body text.
- HTML = 'HTML'
- The response will return an item body as HTML.
- TEXT = 'Text'
- The response will return an item body as plain text.
Properties
- $_ : string
- Element value.
Methods
- __clone() : mixed
- Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
- __toString() : string
- Returns the value of this enumeration as a string.
Constants
BEST
The response will return the richest available content of body text.
public
string
BEST
= 'Best'
This is useful if it is unknown whether the content is text or HTML. The returned body will be text if the stored body is plain text. Otherwise, the response will return HTML if the stored body is in either HTML or RTF format.
This is the default value.
Tags
HTML
The response will return an item body as HTML.
public
string
HTML
= 'HTML'
Tags
TEXT
The response will return an item body as plain text.
public
string
TEXT
= 'Text'
Tags
Properties
$_
Element value.
public
string
$_
Tags
Methods
__clone()
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
public
__clone() : mixed
__toString()
Returns the value of this enumeration as a string.
public
__toString() : string
.