Class Dictionaries

Description

Creates a new dictionary in your application.

See

https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language Using Dictionaries (Multi-Language)

Example

If receive an error "Authorization Denied", check policy Dictionary / Create in Access Management.

const result = await Resources.dictionaries.create({
  name: "My Dictionary",
  slug: "DICT",
});
console.log(result.dictionary); // dictionary-id-123
Copy

Description

Deletes a dictionary from your application.

See

https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language Using Dictionaries (Multi-Language)

Example

If receive an error "Authorization Denied", check policy Dictionary / Delete in Access Management.

const result = await Resources.dictionaries.delete("dictionary-id-123");
console.log(result); // Successfully Removed
Copy

Description

Modifies an existing dictionary's properties.

See

https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language Using Dictionaries (Multi-Language)

Example

If receive an error "Authorization Denied", check policy Dictionary / Edit in Access Management.

const result = await Resources.dictionaries.edit("dictionary-id-123", {
  name: "Updated Dictionary",
});
console.log(result); // Successfully Updated
Copy

Description

Retrieves detailed information about a specific dictionary.

See

https://help.tago.io/portal/en/kb/articles/487-dictionaries Dictionaries

Example

If receive an error "Authorization Denied", check policy Dictionary / Access in Access Management.

const result = await Resources.dictionaries.info("dictionary-id-123");
console.log(result); // { id: 'dictionary-id-123', name: 'My Dictionary', slug: 'DICT', languages: ['en-US'], ... }
Copy

Description

Removes a language from a dictionary.

See

https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language Using Dictionaries (Multi-Language)

Example

If receive an error "Authorization Denied", check policy Dictionary / Edit in Access Management.

const result = await Resources.dictionaries.languageDelete("dictionary-id-123", "en-US");
console.log(result);
Copy

Description

Edits a language's content in a dictionary.

See

https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language Using Dictionaries (Multi-Language)

Example

const resources = new Resources({ token: "YOUR-PROFILE-TOKEN" });
const result = await resources.dictionaries.languageEdit("dictionary-id-123", "en-US", {
  dictionary: { HELLO: "Hello" },
  active: true
});
console.log(result); // Dictionary language Successfully Updated
Copy

Description

Retrieves language-specific content from a dictionary by ID.

See

https://help.tago.io/portal/en/kb/articles/487-dictionaries Dictionaries

Example

If receive an error "Authorization Denied", check policy Dictionary / Access in Access Management.

const result = await Resources.dictionaries.languageInfo("dictionary-id-123", "en-US", {
  fallback: true
});
console.log(result); // { ACCEPT: 'Accept', ACCEPTED: 'Accepted', ...}
Copy

Description

Retrieves language-specific content from a dictionary by its slug.

See

https://help.tago.io/portal/en/kb/articles/487-dictionaries Dictionaries

Example

If receive an error "Authorization Denied", check policy Dictionary / Access in Access Management.

const result = await Resources.dictionaries.languageInfoBySlug("SLUG", "en-US", {
  fallback: true
});
console.log(result);
Copy

Description

Lists all dictionaries from your application with pagination support.

See

https://help.tago.io/portal/en/kb/articles/487-dictionaries Dictionaries

Example

If receive an error "Authorization Denied", check policy Dictionary / Access in Access Management.

const result = await Resources.dictionaries.list({
  page: 1,
  fields: ["id", "name", "slug"],
  amount: 10,
  orderBy: ["name", "asc"]
});
console.log(result); // [ { id: 'dictionary-id-123', name: 'My Dictionary', slug: 'DICT' } ]
Copy