public interface ProfileRetrofitApi
Class that will represent the API used to manage the profile request on the exxtractor
Since:
4/12/2021
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    getListenerProfile(String profile_leid, String secretKey, retrofit.Callback<Profile> response)
    Method that will retrieve a listener profile for the current venue, represented by json structure
    void
    getListenerProfilesMenu(retrofit.Callback<List<ListenerProfileInformation>> responseHandler)
    Method that will retrieve the menu with all the listener profiles for the current venue, represented by json structure
    void
    getProfile(retrofit.Callback<Profile> handler)
    Method that will retrieve the profile for the current venue, represented by json structure
    void
    updateProfile(String token, Profile profile, APIRetrofitCallback<retrofit.client.Response> handler)
    Method that will create or update the mobile app profile for the current venue, represented by json structure
  • Method Details

    • getProfile

      @GET("/exxtractor/api/v3/listener-profiles/default") void getProfile(retrofit.Callback<Profile> handler)
      Method that will retrieve the profile for the current venue, represented by json structure
      Parameters:
      handler - the handler to manage the request status
    • getListenerProfilesMenu

      @GET("/controller/api/v3/listener-profiles/menu/mobile_app") void getListenerProfilesMenu(retrofit.Callback<List<ListenerProfileInformation>> responseHandler) throws retrofit.RetrofitError
      Method that will retrieve the menu with all the listener profiles for the current venue, represented by json structure
      Throws:
      retrofit.RetrofitError
    • getListenerProfile

      @GET("/controller/api/v3/listener-profiles/mobile_app/{profile_leid}") void getListenerProfile(@Path("profile_leid") String profile_leid, @Header("Authorization") String secretKey, retrofit.Callback<Profile> response)
      Method that will retrieve a listener profile for the current venue, represented by json structure
      Parameters:
      secretKey - the secretKey to authenticate and get the listener profile
      response - the response that will retrieve the default listener profile for the current venue
    • updateProfile

      @POST("/controller/api/v3/listener-profiles/mobile_app") void updateProfile(@Header("x-access-tokens") String token, @Body Profile profile, APIRetrofitCallback<retrofit.client.Response> handler)
      Method that will create or update the mobile app profile for the current venue, represented by json structure
      Parameters:
      token - the token to authenticate and post the Profile Config
      profile - the mobile app profile object to update or create in the server
      handler - the handler to manage the request status