travel.izi.api.service.FeaturedService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-api-extended Show documentation

Java wrapper around the izi.TRAVEL API using Retrofit. Remote services are grouped into local service objects which can be centrally managed by a IZITravel instance. It will act as a factory for all of the services and will automatically initialize them with your credentials and API key.

There is a newer version: 1.6.0

Show newest version

/*
 * Copyright (C) 2015 IZITEQ B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package travel.izi.api.service;

import retrofit.client.Response;
import retrofit.http.GET;
import retrofit.http.Query;
import travel.izi.api.IZITravelCallback;
import travel.izi.api.model.entity.FeaturedObject;

import java.util.List;

/**
 * Endpoints for Featured Content.
 */
@SuppressWarnings("unused")
public interface FeaturedService {

    /**
     * Provides current featured content for izi.TRAVEL Applications (mobile clients):
     * promoted or most popular published tours and museums.
     * 
     * The end-point returns only published content in order defined by a featured content publisher
     * (position field reflects the ordering as well). The maximum number of returned objects is 10.
     * 

     * If there is no set defined for the first language or there is no published content for the language,
     * the end-point will try to return featured content set for next language, and so forth.
     * If there are no featured content for the set of passed languages, the end-point will try
     * to return set for `en` language.
     * 
     *
     * @param languages Array of preferable content languages.
     * @return Featured content or throw HTTP error 404 if no appropriate featured content are published.
     */
    @GET("/featured/mobile")
    List getFeaturedContent(
            @Query("languages") String[] languages
    );

    /**
     * Asynchronous version of {@link #getFeaturedContent(String[])}.
     */
    @GET("/featured/mobile")
    void getFeaturedContent(
            @Query("languages") String[] languages,
            IZITravelCallback> callback
    );

    @GET("/featured/mobile")
    Response getFeaturedContentResponse(
            @Query("languages") String[] languages
    );

}