Package com.ringcentral.paths.teammessaging.v1.notes

Class Index

java.lang.Object

com.ringcentral.paths.teammessaging.v1.notes.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	noteId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String noteId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes the specified note.
TMNoteWithBodyInfo	get()	Returns the specified note(s).
Index	lock()
TMNoteInfo	patch(TMCreateNoteRequest tMCreateNoteRequest)
TMNoteInfo	patch(TMCreateNoteRequest tMCreateNoteRequest, PatchNoteNewParameters queryParams)	Edits a note.
String	path()
String	path(Boolean withParameter)
Index	publish()
Index	unlock()

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

noteId

public String noteId

Constructor Details

Index

public Index(Index parent,
 String noteId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

get

public TMNoteWithBodyInfo get()
                       throws RestException,
IOException

Returns the specified note(s). It is possible to fetch up to 50 notes per request. HTTP Method: get Endpoint: /team-messaging/v1/notes/{noteId} Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes the specified note. HTTP Method: delete Endpoint: /team-messaging/v1/notes/{noteId} Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

patch

public TMNoteInfo patch(TMCreateNoteRequest tMCreateNoteRequest,
 PatchNoteNewParameters queryParams)
                 throws RestException,
IOException

Edits a note. Notes can be edited by any user if posted to a chat. the user belongs to. HTTP Method: patch Endpoint: /team-messaging/v1/notes/{noteId} Rate Limit Group: Medium App Permission: TeamMessaging

Throws:

RestException

IOException

patch

public TMNoteInfo patch(TMCreateNoteRequest tMCreateNoteRequest)
                 throws RestException,
IOException

Throws:

RestException

IOException

lock

public Index lock()

unlock

public Index unlock()

publish

public Index publish()