Package com.devcycle.sdk.server.common.api

Interface IDVCApi

public interface IDVCApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<ProjectConfig>	getConfig(java.lang.String sdkToken, java.lang.String etag)	Get DevCycle project Config
retrofit2.Call<java.util.Map<java.lang.String,Feature>>	getFeatures(User user, java.lang.Boolean enableEdgeDB)	Get all features by key for user data
retrofit2.Call<Variable>	getVariableByKey(User user, java.lang.String key, java.lang.Boolean enableEdgeDB)	Get variable by key for user data
retrofit2.Call<java.util.Map<java.lang.String,Variable>>	getVariables(User user, java.lang.Boolean enableEdgeDB)	Get all variables by key for user data
retrofit2.Call<DVCResponse>	publishEvents(EventsBatch eventsBatch)	Post events to DevCycle for user
retrofit2.Call<DVCResponse>	track(UserAndEvents userAndEvents, java.lang.Boolean enableEdgeDB)	Post events to DevCycle for user

Method Detail

getFeatures

@Headers("Content-Type:application/json")
@POST("v1/features")
retrofit2.Call<java.util.Map<java.lang.String,Feature>> getFeatures(@Body
                                                                          User user,
                                                                          @Query("enableEdgeDB")
                                                                          java.lang.Boolean enableEdgeDB)

Get all features by key for user data

Parameters:

user - (required)

enableEdgeDB - (required)

Returns:

Call<Map<String, Feature>>

getVariableByKey

@Headers("Content-Type:application/json")
@POST("v1/variables/{key}")
retrofit2.Call<Variable> getVariableByKey(@Body
                                          User user,
                                          @Path("key")
                                          java.lang.String key,
                                          @Query("enableEdgeDB")
                                          java.lang.Boolean enableEdgeDB)

Get variable by key for user data

Parameters:

user - (required)

key - Variable key (required)

enableEdgeDB - (required)

Returns:

Call<Variable>

getVariables

@Headers("Content-Type:application/json")
@POST("v1/variables")
retrofit2.Call<java.util.Map<java.lang.String,Variable>> getVariables(@Body
                                                                            User user,
                                                                            @Query("enableEdgeDB")
                                                                            java.lang.Boolean enableEdgeDB)

Get all variables by key for user data

Parameters:

user - (required)

enableEdgeDB - (required)

Returns:

Call<Map<String, Variable>>

track

@Headers("Content-Type:application/json")
@POST("v1/track")
retrofit2.Call<DVCResponse> track(@Body
                                  UserAndEvents userAndEvents,
                                  @Query("enableEdgeDB")
                                  java.lang.Boolean enableEdgeDB)

Post events to DevCycle for user

Parameters:

userAndEvents - (required)

enableEdgeDB - (required)

Returns:

Call<DVCResponse>

getConfig

@Headers("Content-Type:application/json")
@GET("config/v1/server/{sdkToken}.json")
retrofit2.Call<ProjectConfig> getConfig(@Path("sdkToken")
                                        java.lang.String sdkToken,
                                        @Header("If-None-Match")
                                        java.lang.String etag)

Get DevCycle project Config

Parameters:

sdkToken - (required)

etag - (nullable)

Returns:

Call<ProjectConfig>

publishEvents

@Headers("Content-Type:application/json")
@POST("v1/events/batch")
retrofit2.Call<DVCResponse> publishEvents(@Body
                                          EventsBatch eventsBatch)

Post events to DevCycle for user

Parameters:

eventsBatch - (required)

Returns:

Call<DVCResponse>