Keywords.getAvailable (Method)

Returns zero or more records listing the keywords matching the specified criteria.

Returns:

Keywords_GetAvailable_Result (rowlimitedquery)

Arguments:

Name	Type	Required	Description
subsiteIDOrURL	SubsiteIDorURL_EmptyString	Required	The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite.
excludeList	KeywordList_EmptyString	Optional. Defaults to an empty string.	A comma-delimited list of keywords that CommonSpot excludes from the results. If this is an empty string, no keywords are excluded.
searchOperator	SearchOperator_EmptyString	Optional. Defaults to an empty string.	A search operator or an empty string. Values for this argument can be 'Begins With', 'Contains', 'Ends With', or 'Equals'.
searchString	String	Optional. Defaults to an empty string.	The value for which CommonSpot searches.
subsiteScope	SubsiteScopeFilter	Optional. Defaults to '#Request.Constants.SUBSITE_SCOPE_CURRENT#'.	String containing the subsite's scope; for example, 'ALL', 'CURRENT', 'CURRENT_AND_ABOVE', and so on.
limit	QueryRowLimit	Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'.	An integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting.

Context:

License Requirements	Keywords
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

Code	Error Message
40012	If you specify a search string, you must also specify a search operator.

Notes:

None