Package com.ringcentral.paths.restapi.account.extension.favorite

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.favorite.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent)

Method Summary

Modifier and Type	Method	Description
FavoriteContactList	get()	Returns the list of favorite contacts of the current extension.
String	path()
String	path(Boolean withParameter)
FavoriteContactList	put(FavoriteCollection favoriteCollection)	Updates the list of favorite contacts of the current extension.

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

Constructor Details

Index

public Index(Index parent)

Method Details

path

public String path()

path

public String path(Boolean withParameter)

get

public FavoriteContactList get()
                        throws RestException,
IOException

Returns the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite Rate Limit Group: Light App Permission: ReadContacts User Permission: ReadPersonalContacts

Throws:

RestException

IOException

put

public FavoriteContactList put(FavoriteCollection favoriteCollection)
                        throws RestException,
IOException

Updates the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).**Please note**: Currently personal address book size is limited to 10 000 contacts.

HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/favorite Rate Limit Group: Medium App Permission: Contacts User Permission: EditPersonalContacts

Throws:

RestException

IOException