public abstract class RqlApiClient extends SecureApiClient
Constructor and Description |
---|
RqlApiClient(SecureApiClientConfiguration configuration)
Constructs a new
RqlContentApiClient and initializes
it with the SecureApiClientConfiguration object. |
Modifier and Type | Method and Description |
---|---|
java.util.List<CustomSiteSettingInfo> |
getCustomSiteSettings(java.lang.String names)
Retrieves the values of custom site settings.
|
java.lang.String |
getSiteConfiguration()
Gets the XML document describing the site configuration.
|
void |
setCustomSiteSetting(java.lang.String name,
java.lang.String value,
java.lang.String description)
Sets a value and a description of a custom site setting.
|
void |
setCustomSiteSettings(java.util.List<CustomSiteSettingInfo> customSiteSettings)
Allows to set multiple custom site settings.
|
authenticate, getTicketExpirationDate
public RqlApiClient(SecureApiClientConfiguration configuration)
RqlContentApiClient
and initializes
it with the SecureApiClientConfiguration
object.configuration
- A configuration object for the API client.public java.util.List<CustomSiteSettingInfo> getCustomSiteSettings(java.lang.String names) throws javax.xml.soap.SOAPException
names
- A comma-separated list of setting names.CustomSiteSettingInfo
objects representing the custom setting.javax.xml.soap.SOAPException
public java.lang.String getSiteConfiguration() throws javax.xml.soap.SOAPException
javax.xml.soap.SOAPException
public void setCustomSiteSetting(java.lang.String name, java.lang.String value, java.lang.String description) throws javax.xml.soap.SOAPException
name
- A name of the custom site setting.value
- The value of the setting.description
- The description of the setting.javax.xml.soap.SOAPException
public void setCustomSiteSettings(java.util.List<CustomSiteSettingInfo> customSiteSettings) throws javax.xml.soap.SOAPException
customSiteSettings
- A list of CustomSiteSettingInfo
objects.javax.xml.soap.SOAPException