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

Class Index

java.lang.Object

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

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	scaleSize

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String scaleSize)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes the user profile image.
byte[]	get()
byte[]	get(ReadScaledProfileImageParameters queryParams)	Returns the scaled profile image of an extension.
byte[]	list()	Returns a profile image of an extension.
String	path()
String	path(Boolean withParameter)
String	post(CreateUserProfileImageRequest createUserProfileImageRequest)	Uploads the extension profile image.
String	put(UpdateUserProfileImageRequest updateUserProfileImageRequest)	Updates the extension profile image.

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

scaleSize

public String scaleSize

Constructor Details

Index

public Index(Index parent,
 String scaleSize)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public byte[] list()
            throws RestException,
IOException

Returns a profile image of an extension.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image Rate Limit Group: Medium App Permission: ReadAccounts User Permission: ReadExtensions

Throws:

RestException

IOException

post

public String post(CreateUserProfileImageRequest createUserProfileImageRequest)
            throws RestException,
IOException

Uploads the extension profile image.

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image Rate Limit Group: Heavy App Permission: EditExtensions User Permission: EditUserInfo

Throws:

RestException

IOException

put

public String put(UpdateUserProfileImageRequest updateUserProfileImageRequest)
           throws RestException,
IOException

Updates the extension profile image.

HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image Rate Limit Group: Heavy App Permission: EditExtensions User Permission: EditUserInfo

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes the user profile image.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image Rate Limit Group: Medium App Permission: EditExtensions User Permission: EditUserInfo

Throws:

RestException

IOException

get

public byte[] get(ReadScaledProfileImageParameters queryParams)
           throws RestException,
IOException

Returns the scaled profile image of an extension.

**This API must be called via media API entry point, e.g. https://media.ringcentral.com**

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize} Rate Limit Group: Medium App Permission: ReadAccounts

Throws:

RestException

IOException

get

public byte[] get()
           throws RestException,
IOException

Throws:

RestException

IOException