Package com.ringcentral.definitions

Class MthListNotesParameters

java.lang.Object

com.ringcentral.definitions.MthListNotesParameters

public class MthListNotesParameters
extends Object

Query parameters for operation mthListNotes

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[]	noteIds	List of note 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	List of thread IDs to filter the list of results

Constructor Summary

Constructors

Constructor	Description
MthListNotesParameters()

Method Summary

Modifier and Type	Method	Description
MthListNotesParameters	availability(String[] availability)
MthListNotesParameters	noteIds(String[] noteIds)
MthListNotesParameters	ownerExtensionIds(String[] ownerExtensionIds)
MthListNotesParameters	page(Long page)
MthListNotesParameters	perPage(Long perPage)
MthListNotesParameters	threadIds(String[] threadIds)

Methods inherited from class java.lang.Object

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

Field Details

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

threadIds

public String[] threadIds

List of thread IDs to filter the list of results

noteIds

public String[] noteIds

List of note IDs to filter the list of results

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

MthListNotesParameters

public MthListNotesParameters()

Method Details

ownerExtensionIds

public MthListNotesParameters ownerExtensionIds(String[] ownerExtensionIds)

availability

public MthListNotesParameters availability(String[] availability)

threadIds

public MthListNotesParameters threadIds(String[] threadIds)

noteIds

public MthListNotesParameters noteIds(String[] noteIds)

perPage

public MthListNotesParameters perPage(Long perPage)

page

public MthListNotesParameters page(Long page)