Class Dictionaries

Hierarchy

TagoIOModule<GenericModuleParams>
- Dictionaries

Index

Constructors

Methods

create delete edit info languageDelete languageEdit languageInfo languageInfoBySlug list

Constructors

constructor

new Dictionaries(params): Dictionaries
Parameters
- params: GenericModuleParams
Returns Dictionaries
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

create

create(dictionaryObj): Promise<{
dictionary: string;
}>
Generate a new dictionary for the account.
Parameters
- dictionaryObj: DictionaryCreateInfo
  Object with data to create new dictionary.
Returns Promise<{
dictionary: string;
}>
- Defined in modules/Resources/Dictionaries.ts:56

delete

delete(dictionaryID): Promise<string>
Delete a dictionary from the account.
Parameters
- dictionaryID: string
  Dictionary ID.
Returns Promise<string>
- Defined in modules/Resources/Dictionaries.ts:87

edit

edit(dictionaryID, dictionaryObj): Promise<string>
Modify any property of a dictionary.
Parameters
- dictionaryID: string
  Dictionary ID.
- dictionaryObj: Partial<DictionaryCreateInfo>
  Dictionary Object data to be replaced.
Returns Promise<string>
- Defined in modules/Resources/Dictionaries.ts:72

info

info(dictionaryID): Promise<DictionaryInfo>
Get information about a dictionary.
Parameters
- dictionaryID: string
  Dictionary ID.
Returns Promise<DictionaryInfo>
- Defined in modules/Resources/Dictionaries.ts:103

languageDelete

languageDelete(dictionaryID, locale): Promise<string>
Delete a language from a dictionary.
Parameters
- dictionaryID: string
  Dictionary ID.
- locale: string
  Language locale string (e.g. en-US).
Returns Promise<string>
- Defined in modules/Resources/Dictionaries.ts:131

languageEdit

languageEdit(dictionaryID, locale, languageObj): Promise<string>
Parameters
- dictionaryID: string
- locale: string
- languageObj: LanguageEditData
Returns Promise<string>
- Defined in modules/Resources/Dictionaries.ts:113

languageInfo

languageInfo(dictionaryID, locale, queryObj?): Promise<LanguageData>
Get information about a dictionary by ID.
Parameters
- dictionaryID: string
  Dictionary ID.
- locale: string
  Language locale string (e.g. en-US).
- Optional queryObj: LanguageInfoQuery
  Language info query params.
Returns Promise<LanguageData>
- Defined in modules/Resources/Dictionaries.ts:149

languageInfoBySlug

languageInfoBySlug(slug, locale, queryObj?): Promise<LanguageData>
Get information about a dictionary querying by slug instead of the dictionary's ID.
Parameters
- slug: string
  Dictionary slug.
- locale: string
  Language locale string (e.g. en-US).
- Optional queryObj: LanguageInfoQuery
  Language info query params.
Returns Promise<LanguageData>
- Defined in modules/Resources/Dictionaries.ts:174

list

list(queryObj?): Promise<DictionaryInfo[]>
Retrieve a list with all dictionaries from an account.
Parameters
- Optional queryObj: DictionaryQuery
  Search query params.
Returns Promise<DictionaryInfo[]>
Default
```
queryObj: {
  page: 1,
  fields: ["id", "name", "slug", "languages"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
- Defined in modules/Resources/Dictionaries.ts:33