Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeys

export
interface

IKeys

description

Keys are core item elements of the project. Each phrase that is used in your app or website must be identified by a key and have values that represent translations to various languages. For example key index.welcome would have values of Welcome in English and Benvenuto in Italian. Keys can be assigned to one or multiple platforms. Once a key is assigned to a platform, it would be included in the export for file formats related to this platform.

Hierarchy

  • IKeys

Implemented by

Index

Methods

Methods

create

  • create(projectId: string, body: object): Promise<object>
  • description

    Creates one or more keys in the project. Requires Manage keys admin right. We recommend sending payload in chunks of up to 500 keys per request.

    memberof

    IKeys

    Parameters

    • projectId: string
    • body: object

    Returns Promise<object>

    }

delete

  • delete(projectId: string, keyId: number): Promise<object>
  • description

    Deletes a key from the project. Requires Manage keys admin right.

    memberof

    IKeys

    Parameters

    • projectId: string
    • keyId: number

    Returns Promise<object>

    }

deleteMany

  • deleteMany(projectId: string, body: object): Promise<object>
  • description

    Deletes multiple keys from the project. Requires Manage keys admin right.

    memberof

    IKeys

    Parameters

    • projectId: string
    • body: object

    Returns Promise<object>

    }

get

  • get(projectId: string, keyId: number): Promise<object>
  • description

    Retrieves a Key object.

    memberof

    IKeys

    Parameters

    • projectId: string
    • keyId: number

    Returns Promise<object>

    }

list

  • list(projectId: string, query?: IKeyQuery): Promise<object>
  • description

    Lists all keys in the project.

    memberof

    IKeys

    Parameters

    • projectId: string
    • Optional query: IKeyQuery

    Returns Promise<object>

    }

update

  • update(projectId: string, keyId: number, body: object): Promise<object>
  • description

    Updates the properties of a key and it’s associated objects. Requires Manage keys admin right.

    memberof

    IKeys

    Parameters

    • projectId: string
    • keyId: number
    • body: object

    Returns Promise<object>

    }

updateMany

  • updateMany(projectId: string, body: object): Promise<object>
  • description

    Updates the properties of a key and it’s associated objects. Requires Manage keys admin right.

    memberof

    IKeys

    Parameters

    • projectId: string
    • body: object

    Returns Promise<object>

    }

Generated using TypeDoc