Package com.ringcentral.definitions

Class InstantMessageEventBody

java.lang.Object

com.ringcentral.definitions.InstantMessageEventBody

public class InstantMessageEventBody
extends Object

Notification payload body

Field Summary

Fields

Modifier and Type	Field	Description
MessageAttachmentInfo[]	attachments	Message attachment data
String	availability	Message availability status.
ConversationInfo	conversation
String	conversationId	Deprecated.
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.
SenderInfo	from
String	id	Internal identifier of a message
String	lastModifiedTime	Date/time when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time
String	messageStatus	Message status.
String	ownerId	Internal identifier of a subscription owner extension
String	priority	Message priority Enum: Normal, High
String	readStatus	Message read status Enum: Read, Unread
String	subject	Message subject.
NotificationRecipientInfo[]	to	Message receiver(s) information
String	type	Type of message.

Constructor Summary

Constructors

Constructor	Description
InstantMessageEventBody()

Method Summary

Modifier and Type	Method	Description
InstantMessageEventBody	attachments(MessageAttachmentInfo[] attachments)
InstantMessageEventBody	availability(String availability)
InstantMessageEventBody	conversation(ConversationInfo conversation)
InstantMessageEventBody	conversationId(String conversationId)
InstantMessageEventBody	creationTime(String creationTime)
InstantMessageEventBody	direction(String direction)
InstantMessageEventBody	from(SenderInfo from)
InstantMessageEventBody	id(String id)
InstantMessageEventBody	lastModifiedTime(String lastModifiedTime)
InstantMessageEventBody	messageStatus(String messageStatus)
InstantMessageEventBody	ownerId(String ownerId)
InstantMessageEventBody	priority(String priority)
InstantMessageEventBody	readStatus(String readStatus)
InstantMessageEventBody	subject(String subject)
InstantMessageEventBody	to(NotificationRecipientInfo[] to)
InstantMessageEventBody	type(String type)

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

Internal identifier of a message

to

public NotificationRecipientInfo[] to

Message receiver(s) information

from

public SenderInfo from

type

public String type

Type of message. The default value is 'SMS'

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

lastModifiedTime

public String lastModifiedTime

Date/time when the message was modified 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 MessageAttachmentInfo[] attachments

Message attachment data

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

subject

public String subject

Message subject. It replicates message text which is also returned as an attachment

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

conversationId

public String conversationId

Deprecated. Identifier of a conversation the message belongs to

conversation

public ConversationInfo conversation

ownerId

public String ownerId

Internal identifier of a subscription owner extension

Constructor Details

InstantMessageEventBody

public InstantMessageEventBody()

Method Details

id

public InstantMessageEventBody id(String id)

to

public InstantMessageEventBody to(NotificationRecipientInfo[] to)

from

public InstantMessageEventBody from(SenderInfo from)

type

public InstantMessageEventBody type(String type)

creationTime

public InstantMessageEventBody creationTime(String creationTime)

lastModifiedTime

public InstantMessageEventBody lastModifiedTime(String lastModifiedTime)

readStatus

public InstantMessageEventBody readStatus(String readStatus)

priority

public InstantMessageEventBody priority(String priority)

attachments

public InstantMessageEventBody attachments(MessageAttachmentInfo[] attachments)

direction

public InstantMessageEventBody direction(String direction)

availability

public InstantMessageEventBody availability(String availability)

subject

public InstantMessageEventBody subject(String subject)

messageStatus

public InstantMessageEventBody messageStatus(String messageStatus)

conversationId

public InstantMessageEventBody conversationId(String conversationId)

conversation

public InstantMessageEventBody conversation(ConversationInfo conversation)

ownerId

public InstantMessageEventBody ownerId(String ownerId)