Package com.ringcentral.definitions

Class MthListMessagesParameters

java.lang.Object

com.ringcentral.definitions.MthListMessagesParameters

public class MthListMessagesParameters
extends Object

Query parameters for operation mthListMessages

Field Summary

Fields

Modifier and Type	Field	Description
String[]	availability	Availability filter (by default only `Alive` records are returned) Default: Alive Enum: Alive, Deleted
String	creationTimeFrom	Start date/time for resulting message threads or messages (depending on path resource) in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
String	creationTimeTo	End date/time for resulting message threads or messages (depending on path resource) in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone.
String[]	messageIds	Message IDs to filter the list of results
String[]	ownerExtensionIds	Thread owner extension IDs
Long	page	The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1
Long	perPage	The number of items per page.
String[]	threadIds	Thread ID(s) to filter messages
String	threadStatus	Thread status Enum: Open, Resolved

Constructor Summary

Constructors

Constructor	Description
MthListMessagesParameters()

Method Summary

Modifier and Type	Method	Description
MthListMessagesParameters	availability(String[] availability)
MthListMessagesParameters	creationTimeFrom(String creationTimeFrom)
MthListMessagesParameters	creationTimeTo(String creationTimeTo)
MthListMessagesParameters	messageIds(String[] messageIds)
MthListMessagesParameters	ownerExtensionIds(String[] ownerExtensionIds)
MthListMessagesParameters	page(Long page)
MthListMessagesParameters	perPage(Long perPage)
MthListMessagesParameters	threadIds(String[] threadIds)
MthListMessagesParameters	threadStatus(String threadStatus)

Methods inherited from class java.lang.Object

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

Field Details

threadStatus

public String threadStatus

Thread status Enum: Open, Resolved

ownerExtensionIds

public String[] ownerExtensionIds

Thread owner extension IDs

availability

public String[] availability

Availability filter (by default only `Alive` records are returned) Default: Alive Enum: Alive, Deleted

messageIds

public String[] messageIds

Message IDs to filter the list of results

threadIds

public String[] threadIds

Thread ID(s) to filter messages

creationTimeFrom

public String creationTimeFrom

Start date/time for resulting message threads or messages (depending on path resource) in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone. This parameter is supported if `creationTimeTo` is specified

creationTimeTo

public String creationTimeTo

End date/time for resulting message threads or messages (depending on path resource) in [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339) format including timezone. This parameter is supported if `creationTimeFrom` is specified

perPage

public Long perPage

The number of items per page. If the provided value in the request is greater than a maximum, the maximum value is applied Maximum: 1000 Minimum: 1 Format: int32 Example: 100 Default: 100

page

public Long page

The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1

Constructor Details

MthListMessagesParameters

public MthListMessagesParameters()

Method Details

threadStatus

public MthListMessagesParameters threadStatus(String threadStatus)

ownerExtensionIds

public MthListMessagesParameters ownerExtensionIds(String[] ownerExtensionIds)

availability

public MthListMessagesParameters availability(String[] availability)

messageIds

public MthListMessagesParameters messageIds(String[] messageIds)

threadIds

public MthListMessagesParameters threadIds(String[] threadIds)

creationTimeFrom

public MthListMessagesParameters creationTimeFrom(String creationTimeFrom)

creationTimeTo

public MthListMessagesParameters creationTimeTo(String creationTimeTo)

perPage

public MthListMessagesParameters perPage(Long perPage)

page

public MthListMessagesParameters page(Long page)