SystemOptionsServices.RemoveDictionary Method

SystemOptionsServicesRemoveDictionary Method

Ingeniux CMS Web Services API

Removes a Spell check dictionary dictionary for a specific locale

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<DictionaryEntry> RemoveDictionary(
	RemoveDictionaryInput data
)

Public Function RemoveDictionary ( 
	data As RemoveDictionaryInput
) As XHRServiceResponseGeneric(Of DictionaryEntry)

public:
virtual XHRServiceResponseGeneric<DictionaryEntry^>^ RemoveDictionary(
	RemoveDictionaryInput^ data
) sealed

abstract RemoveDictionary : 
        data : RemoveDictionaryInput -> XHRServiceResponseGeneric<DictionaryEntry> 
override RemoveDictionary : 
        data : RemoveDictionaryInput -> XHRServiceResponseGeneric<DictionaryEntry>

Parameters

data

Type: RemoveDictionaryInput

Object containing the locale name for the dictionary to be removed

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "data": "fr-ca"
    }
}

Return Value

Type: XHRServiceResponseGenericDictionaryEntry

Object containing the dictionary and affix files that were deleted for the given locale. The file paths are relative to "xml" folder

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "afffixFile": "custom/SpellCheckDictionaries/fr_ca.aff",
        "dictionaryFile": "custom/SpellCheckDictionaries/fr_ca.dic"
    }
}

Reference

SystemOptionsServices Class

IngeniuxCMService Namespace