Keywords.setPermanent (Method)

Sets the state of a keyword so that it is either permanent or non-permanent. CommonSpot automatically deletes non-permanent keywords when the last association to it is removed. In contrast, it never deletes permanent keywords.

Returns:

Void

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.
keywordList KeywordList_Existing Required A comma-delimited list of keywords. These keywords must exist.
isPermanent Boolean Required Boolean flag which when set to true changes the keyword's state to permanent.

Context:

License Requirements Keywords
Permission Requirements site:ManageKeywords
Deny Context None
Require Context AuthoringEnabled
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the site level, calls to this method will be logged
Customization This method may be customized at the site level

Error Codes:

None

Notes:

None