water.bindings.proxies.retrofit

Interface sessions

public interface sessions

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<InitIDV3>	endSession(java.lang.String session_key)
retrofit2.Call<InitIDV3>	endSession(java.lang.String session_key, java.lang.String _exclude_fields) Close the Rapids session.
retrofit2.Call<InitIDV3>	startSession()
retrofit2.Call<InitIDV3>	startSession(java.lang.String session_key, java.lang.String _exclude_fields) Start a new Rapids session, and return the session id.

Method Detail

startSession

@FormUrlEncoded
@POST(value="/4/sessions")
retrofit2.Call<InitIDV3> startSession(@Field(value="session_key")
                                                        java.lang.String session_key,
                                                        @Field(value="_exclude_fields")
                                                        java.lang.String _exclude_fields)

Start a new Rapids session, and return the session id.

Parameters:

session_key - Session ID

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

startSession

@FormUrlEncoded
@POST(value="/4/sessions")
retrofit2.Call<InitIDV3> startSession()

endSession

@DELETE(value="/4/sessions/{session_key}")
retrofit2.Call<InitIDV3> endSession(@Path(value="session_key")
                                         java.lang.String session_key,
                                         @Field(value="_exclude_fields")
                                         java.lang.String _exclude_fields)

Close the Rapids session.

Parameters:

session_key - Session ID

_exclude_fields - Comma-separated list of JSON field paths to exclude from the result, used like: "/3/Frames?_exclude_fields=frames/frame_id/URL,__meta"

endSession

@DELETE(value="/4/sessions/{session_key}")
retrofit2.Call<InitIDV3> endSession(@Path(value="session_key")
                                         java.lang.String session_key)