Class actuate.RequestOptions

Contains attributes that describe a repository on a given iHub volume.
Member of: actuate.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.RequestOptions(Optional) Constructs attributes that describe a repository on a given iHub volume.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	REPOSITORY_ENCYCLOPEDIA Enterprise repository.
<static> <constant>	REPOSITORY_STANDALONE Workgroup repository.

Method Summary
Method Attributes	Method Name and Description
	getIServerUrl() Returns the iHub URL.
	getLocale() Returns the locale string or null if none has been set.
	getRepositoryType() Returns the repository type.
	getRESTAuthToken() Returns the current REST API authentication token.
	getVolume() Returns the volume.
	getVolumeProfile() Returns the volumeProfile.
	setCustomParameters(parameters) Sets custom URL parameters.
	setIServerUrl(iServerUrl) Sets the iHub URL.
	setLocale(locale) Sets the locale string.
	setRepositoryType(repositoryType) Sets the repository type.
	setRESTAuthToken(restAuthToken) Sets the authentication token to use when running JSAPI commands from a REST API application.
	setVolume(volume) Sets the volume.
	setVolumeProfile(volumeProfile) Sets the volume profile.

Class Detail

actuate.RequestOptions(Optional)

Constructs attributes that describe a repository on a given iHub volume. The attributes iServerUrl and volume are only used when the repository type is ENCYCLOPEDIA. If the repository type is STANDALONE, they are ignored.

Parameters:
{actuate.RequestOptions} Optional: requestOptions from which to copy the values.

Field Detail

<static> <constant> {String} REPOSITORY_ENCYCLOPEDIA

Enterprise repository.

<static> <constant> {String} REPOSITORY_STANDALONE

Workgroup repository.

Method Detail

{String} getIServerUrl()

Returns the iHub URL. This value is used only for the REPOSITORY_ENCYCLOPEDIA repository type.

Returns:: {String} IServer URL

{String} getLocale()

Returns the locale string or null if none has been set.

Returns:: {String} locale string

{String} getRepositoryType()

Returns the repository type.

Returns:: {String} repository type

{String} getRESTAuthToken()

Returns the current REST API authentication token. setRESTAuthToken( ) sets the token to the value retrieved from the REST API login resource.
To retrieve the REST API authentication token for the RequestOptions object reqOpts, use code similar to the following:

var restAuthToken = reqOpts.getRESTAuthToken( );
if (restAuthToken == null){
  alert("REST API authentication token is not available");
}

Returns:: {String} The value set by setRESTAuthToken( ) or null if not set.

{String} getVolume()

Returns the volume. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Returns:: {String} volume

{String} getVolumeProfile()

Returns the volumeProfile.

Returns:: {String} volumeProfile

setCustomParameters(parameters)

Sets custom URL parameters.

Parameters:
{Map} parameters: map of custom URL parameters (map of string to string)

setIServerUrl(iServerUrl)

Sets the iHub URL. For example, http://myserver.mycompany.com:8000 This value is used only for the REPOSITORY_ENCYCLOPEDIA repository type.

Parameters:
{String} iServerUrl

setLocale(locale)

Sets the locale string.

Parameters:
{String} locale: string or null for default

setRepositoryType(repositoryType)

Sets the repository type.

Parameters:
{String} repositoryType

setRESTAuthToken(restAuthToken)

Sets the authentication token to use when running JSAPI commands from a REST API application.
This example sets the REST API authentication token, using the value, authId, provided by the REST API login resource and initializes the JSAPI:

function acLoad( ) {
  actuate.load( "viewer" );
  var iportalUrl = 'http://mymachine:8700/iportal';
  var reqOps = new actuate.RequestOptions( );
  reqOps.setRepositoryType( actuate.RequestOptions.REPOSITORY_ENCYCLOPEDIA );
  reqOps.setIServerUrl( "http://mymachine:8000" );
  reqOps.setVolumeProfile( "Default Volume" );
  reqOps.setRESTAuthToken( authId );
  actuate.initialize( iportalUrl, reqOps, null, null, JSAPILoaded, JSAPINotLoaded );
}

Parameters:
{String} restAuthToken: The value provided by the REST API login resource.

setVolume(volume)

Sets the volume. This value is only used in for the REPOSITORY_ENCYCLOPEDIA repository type.

Parameters:
{String} volume

setVolumeProfile(volumeProfile)

Sets the volume profile.

Parameters:
{String} volumeProfile

Classes

Class actuate.RequestOptions