com.mytaxi.apis.phrase.api.translation.PhraseTranslationAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phrase-java-client Show documentation

This projects contains of services to handle the translations from [PhraseApp API v2](http://docs.phraseapp.com/api/v2/). It's supposed to expose Phrase translations as POJO or as File within the java world.

There is a newer version: 1.0.6

Show newest version

package com.mytaxi.apis.phrase.api.translation;

import com.mytaxi.apis.phrase.domainobject.translation.PhraseTranslation;
import com.mytaxi.apis.phrase.exception.PhraseAppApiException;
import java.util.List;

/**
 * Downloads the translations from phraseApp as POJOs.
 *
 * @author m.winkelmann
 */
public interface PhraseTranslationAPI
{
    /**
     * Retrieves all translations for the given projectId and the localeId.
     *
     * @param projectId - id of the PhraseApp project
     * @param localeId  - id of the specific locale
     * @return list of retrieved PhraseTranslations
     * @throws PhraseAppApiException - if some error occured due the whole process
     */
    List listTranslations(String projectId, String localeId) throws PhraseAppApiException;
}