Package com.ringcentral.paths.teammessaging.v1.chats

Class Index

java.lang.Object

com.ringcentral.paths.teammessaging.v1.chats.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
Index	adaptiveCards()
Index	favorite()
TMChatInfo	get()	Returns information about a chat by ID.
TMChatList	list()
TMChatList	list(ListGlipChatsNewParameters queryParams)	Returns the list of chats where the user is a member and also public teams that can be joined.
Index	notes()
String	path()
String	path(Boolean withParameter)
Index	posts()
Index	posts(String postId)
Index	tasks()
Index	unfavorite()

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 TMChatList list(ListGlipChatsNewParameters queryParams)
                throws RestException,
IOException

Returns the list of chats where the user is a member and also public teams that can be joined.

All records in response are sorted by creation time of a chat in ascending order.

**Chat types**

There are multiple types of chats, including:

* **Personal** - each user is given a dedicated "personal chat" in which they are the only member. * **Direct** - a chat between two individuals. * **Group** - a chat between three or more named individuals. A "group" chat has no name. * **Team** - a chat related to a specific topic. Members can come and go freely from this chat type. * **Everyone** - a special chat containing every individual in a company.

HTTP Method: get Endpoint: /team-messaging/v1/chats Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

list

public TMChatList list()
                throws RestException,
IOException

Throws:

RestException

IOException

get

public TMChatInfo get()
               throws RestException,
IOException

Returns information about a chat by ID.

**Note** 'Chat' is a general name for all types of threads including *Personal* (user's own me-chat), *Direct* (one on one chat), *Group* (chat of 3-15 participants without specific name), *Team* (chat of 2 and more participants, with a specific name), *Everyone* (company chat including all employees, with a specific name)."

HTTP Method: get Endpoint: /team-messaging/v1/chats/{chatId} Rate Limit Group: Light App Permission: TeamMessaging

Throws:

RestException

IOException

posts

public Index posts()

posts

public Index posts(String postId)

tasks

public Index tasks()

notes

public Index notes()

favorite

public Index favorite()

unfavorite

public Index unfavorite()

adaptiveCards

public Index adaptiveCards()