Package com.ringcentral.paths.teammessaging.v1.conversations

Class Index

java.lang.Object

com.ringcentral.paths.teammessaging.v1.conversations.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	chatId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String chatId)

Method Summary

Modifier and Type	Method	Description
TMConversationInfo	get()	Returns information about the specified conversation, including the list of conversation participants.
TMConversationList	list()
TMConversationList	list(ListGlipConversationsNewParameters queryParams)	Returns the list of conversations where the user is a member.
String	path()
String	path(Boolean withParameter)
TMConversationInfo	post(CreateConversationRequest createConversationRequest)	Creates a new conversation or opens the existing one.

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

chatId

public String chatId

Constructor Details

Index

public Index(Index parent,
 String chatId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public TMConversationList list(ListGlipConversationsNewParameters queryParams)
                        throws RestException,
IOException

Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a conversation in ascending order. Conversation is a chat of the *Group* type. HTTP Method: get Endpoint: /team-messaging/v1/conversations Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

list

public TMConversationList list()
                        throws RestException,
IOException

Throws:

RestException

IOException

post

public TMConversationInfo post(CreateConversationRequest createConversationRequest)
                        throws RestException,
IOException

Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation (group), it creates a whole new conversation. HTTP Method: post Endpoint: /team-messaging/v1/conversations Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

get

public TMConversationInfo get()
                       throws RestException,
IOException

Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation, it creates a whole new conversation. HTTP Method: get Endpoint: /team-messaging/v1/conversations/{chatId} Rate Limit Group: Light App Permission: TeamMessaging

Throws:

RestException

IOException