com.mytaxi.apis.phrase.api.localedownload.PhraseLocaleDownloadAPI 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.localedownload;

import com.mytaxi.apis.phrase.api.format.Format;

/**
 * Downloads the translations from phraseApp as file(byte[]).
 *
 * @author d.pohl
 * @author m.winkelmann
 */
public interface PhraseLocaleDownloadAPI
{
    /**
     * Downloads the translations for the specific projectId and localeId and saves this in the given fileformat.
     *
     * @param projectId
     * @param localeId
     * @param fileFormat
     * @return file as byte[]
     */
    byte[] downloadLocale(String projectId, String localeId, Format fileFormat);

    /**
     * Downloads the translations for the specific projectId and localeId and saves this in the given fileformat.
     *
     * @param projectId
     * @param localeId
     * @return file as byte[] in the default fileformat: .properties
     */
    byte[] downloadLocale(String projectId, String localeId);

}