io.relayr.java.api

Interface ProjectsApi

public interface ProjectsApi

Method Summary

Modifier and Type	Method and Description
rx.Observable<ExtendedApp>	createApp(ExtendedApp app)
rx.Observable<java.lang.Void>	deleteApp(java.lang.String appId)
rx.Observable<java.lang.Void>	deleteUserApp(java.lang.String userId, java.lang.String appId) Deletes ExtendedApp defined by appId owned by User defined by userId
rx.Observable<java.util.List<App>>	getAllApps()
rx.Observable<ExtendedApp>	getApp(java.lang.String appId)
rx.Observable<App>	getAppInfo()
rx.Observable<java.util.List<App>>	getPublisherApps(java.lang.String publisherId) For more information about Publisher check PublishersApi
rx.Observable<java.util.List<ExtendedApp>>	getPublisherExtendedApps(java.lang.String publisherId) For more information about Publisher check PublishersApi
rx.Observable<ExtendedApp>	getUserApp(java.lang.String userId, java.lang.String appId)
rx.Observable<java.util.List<ExtendedApp>>	getUserApps(java.lang.String userId)
rx.Observable<ExtendedApp>	updateApp(java.lang.String appId)
rx.Observable<ExtendedApp>	updateUserApp(java.lang.String userId, java.lang.String appId, ExtendedApp app)

Method Detail

getAppInfo

@GET(value="/oauth2/app-info")
rx.Observable<App> getAppInfo()

Returns:

information about the App initiating the request.

getAllApps

@GET(value="/apps")
rx.Observable<java.util.List<App>> getAllApps()

Returns:

list of all App registered on relayr's platform

createApp

@POST(value="/apps")
rx.Observable<ExtendedApp> createApp(@Body
                                                          ExtendedApp app)

Returns:

created ExtendedApp

updateApp

@PATCH(value="/apps/{id}")
rx.Observable<ExtendedApp> updateApp(@Path(value="id")
                                                                java.lang.String appId)

Returns:

updated ExtendedApp

deleteApp

@DELETE(value="/apps/{id}")
rx.Observable<java.lang.Void> deleteApp(@Path(value="id")
                                                                    java.lang.String appId)

Returns:

empty Observable

getApp

@GET(value="/apps/{id}")
rx.Observable<ExtendedApp> getApp(@Path(value="id")
                                                           java.lang.String appId)

Parameters:

appId - - owned by user

Returns:

ExtendedApp defined by appId

getPublisherApps

@GET(value="/publishers/{id}/apps")
rx.Observable<java.util.List<App>> getPublisherApps(@Path(value="id")
                                                                                        java.lang.String publisherId)

For more information about Publisher check PublishersApi

Parameters:

publisherId - - check PublishersApi.getUserPublishers(String)

Returns:

list of all App owned by Publisher.

getPublisherExtendedApps

@GET(value="/publishers/{id}/apps/extended")
rx.Observable<java.util.List<ExtendedApp>> getPublisherExtendedApps(@Path(value="id")
                                                                                                                 java.lang.String publisherId)

For more information about Publisher check PublishersApi

Parameters:

publisherId - - check PublishersApi.getUserPublishers(String)

Returns:

list of all ExtendedApp owned by Publisher.

getUserApps

@GET(value="/users/{id}/apps")
rx.Observable<java.util.List<ExtendedApp>> getUserApps(@Path(value="id")
                                                                                      java.lang.String userId)

Parameters:

userId -

Returns:

list of all ExtendedApp owned by User defined with userId.

updateUserApp

@POST(value="/users/{id}/apps/{appId}")
rx.Observable<ExtendedApp> updateUserApp(@Path(value="id")
                                                                                 java.lang.String userId,
                                                                                 @Path(value="appId")
                                                                                 java.lang.String appId,
                                                                                 @Body
                                                                                 ExtendedApp app)

Parameters:

userId -

appId -

app -

Returns:

updated ExtendedApp defined by appId owned by User defined by userId

getUserApp

@GET(value="/users/{id}/apps/{appId}")
rx.Observable<ExtendedApp> getUserApp(@Path(value="id")
                                                                             java.lang.String userId,
                                                                             @Path(value="appId")
                                                                             java.lang.String appId)

Parameters:

userId -

appId -

Returns:

ExtendedApp defined by appId owned by User defined by userId

deleteUserApp

@DELETE(value="/users/{id}/apps/{appId}")
rx.Observable<java.lang.Void> deleteUserApp(@Path(value="id")
                                                                                      java.lang.String userId,
                                                                                      @Path(value="appId")
                                                                                      java.lang.String appId)

Deletes ExtendedApp defined by appId owned by User defined by userId

Parameters:

userId -

appId -

Returns:

empty Observable