Package com.ringcentral.definitions

Class FaxResponse

java.lang.Object

com.ringcentral.definitions.FaxResponse

public class FaxResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
MessageAttachmentInfoIntId[]	attachments	List of message attachments
String	availability	Message availability status.
Long	coverIndex	Cover page identifier.
String	coverPageText	Cover page text, entered by a fax sender and printed on a cover page.
String	creationTime	Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time
String	direction	Text message direction.
Long	faxPageCount	Page count in a fax message Format: int32
String	faxResolution	Fax only.
MessageStoreCallerInfoResponseFrom	from
Long	id	Internal identifier of a message Format: int64
String	lastModifiedTime	Date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time
String	messageStatus	Message status.
String	priority	Message priority Enum: Normal, High
String	readStatus	Message read status Enum: Read, Unread
FaxResponseTo[]	to	Recipient information
String	type	Message type - 'Fax' Enum: Fax
String	uri	Canonical URI of a message Format: uri

Constructor Summary

Constructors

Constructor	Description
FaxResponse()

Method Summary

Modifier and Type	Method	Description
FaxResponse	attachments(MessageAttachmentInfoIntId[] attachments)
FaxResponse	availability(String availability)
FaxResponse	coverIndex(Long coverIndex)
FaxResponse	coverPageText(String coverPageText)
FaxResponse	creationTime(String creationTime)
FaxResponse	direction(String direction)
FaxResponse	faxPageCount(Long faxPageCount)
FaxResponse	faxResolution(String faxResolution)
FaxResponse	from(MessageStoreCallerInfoResponseFrom from)
FaxResponse	id(Long id)
FaxResponse	lastModifiedTime(String lastModifiedTime)
FaxResponse	messageStatus(String messageStatus)
FaxResponse	priority(String priority)
FaxResponse	readStatus(String readStatus)
FaxResponse	to(FaxResponseTo[] to)
FaxResponse	type(String type)
FaxResponse	uri(String uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

public Long id

Internal identifier of a message Format: int64

uri

public String uri

Canonical URI of a message Format: uri

type

public String type

Message type - 'Fax' Enum: Fax

from

public MessageStoreCallerInfoResponseFrom from

to

public FaxResponseTo[] to

Recipient information

creationTime

public String creationTime

Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time

readStatus

public String readStatus

Message read status Enum: Read, Unread

priority

public String priority

Message priority Enum: Normal, High

attachments

public MessageAttachmentInfoIntId[] attachments

List of message attachments

direction

public String direction

Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound Enum: Inbound, Outbound

availability

public String availability

Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly Enum: Alive, Deleted, Purged

messageStatus

public String messageStatus

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned Enum: Queued, Sent, Delivered, DeliveryFailed, SendingFailed, Received

faxResolution

public String faxResolution

Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi Enum: High, Low

faxPageCount

public Long faxPageCount

Page count in a fax message Format: int32

lastModifiedTime

public String lastModifiedTime

Date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time

coverIndex

public Long coverIndex

Cover page identifier. If `coverIndex` is set to '0' (zero), a cover page is not attached. For a list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings') Format: int32

coverPageText

public String coverPageText

Cover page text, entered by a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols

Constructor Details

FaxResponse

public FaxResponse()

Method Details

id

public FaxResponse id(Long id)

uri

public FaxResponse uri(String uri)

type

public FaxResponse type(String type)

from

public FaxResponse from(MessageStoreCallerInfoResponseFrom from)

to

public FaxResponse to(FaxResponseTo[] to)

creationTime

public FaxResponse creationTime(String creationTime)

readStatus

public FaxResponse readStatus(String readStatus)

priority

public FaxResponse priority(String priority)

attachments

public FaxResponse attachments(MessageAttachmentInfoIntId[] attachments)

direction

public FaxResponse direction(String direction)

availability

public FaxResponse availability(String availability)

messageStatus

public FaxResponse messageStatus(String messageStatus)

faxResolution

public FaxResponse faxResolution(String faxResolution)

faxPageCount

public FaxResponse faxPageCount(Long faxPageCount)

lastModifiedTime

public FaxResponse lastModifiedTime(String lastModifiedTime)

coverIndex

public FaxResponse coverIndex(Long coverIndex)

coverPageText

public FaxResponse coverPageText(String coverPageText)