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

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.features.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
FeatureList	get()
FeatureList	get(ReadExtensionFeaturesParameters queryParams)	Returns a list of supported features and information on their availability for the current extension.
String	path()
String	path(Boolean withParameter)

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 FeatureList get(ReadExtensionFeaturesParameters queryParams)
                throws RestException,
IOException

Returns a list of supported features and information on their availability for the current extension. Specific feature(s) might be checked by providing `featureId` query parameter. Multiple values are supported in the format: `?featureId=Feature1&featureId=Feature2`. To get only available features in order to decrease response size, `availableOnly=true` query param might be specified. In case a feature is available for the current user, `"available": true` is returned in response for the record with the corresponding feature ID. Otherwise, additional attribute `reason` is returned with the appropriate code: - `ServicePlanLimitation` - a feature is not included in account service plan; - `AccountLimitation` - a feature is turned off for account; - `ExtensionTypeLimitation` - a feature is not applicable for extension type; - `ExtensionLimitation` - a feature is not available for extension, e.g., additional license required; - `InsufficientPermissions` - required permission not granted to the current user (not the one, who is specified in the URL, but the one who's access token is used); - `ConfigurationLimitation` - a feature is turned off for extension, e.g., by account administrator.

Also, some features may have additional parameters, e.g., limits, which are returned in `params` attribute as a name-value collection:

{ "id": "HUD", "available": true, "params": [ { "name": "limitMax", "value": "100" } ] }

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

Throws:

RestException

IOException

get

public FeatureList get()
                throws RestException,
IOException

Throws:

RestException

IOException