io.relayr.java.api

Interface PublishersApi

public interface PublishersApi

Method Summary

Modifier and Type	Method and Description
rx.Observable<Publisher>	createPublisher(Publisher publisher)
rx.Observable<java.lang.Void>	deletePublisher(java.lang.String publisherId)
rx.Observable<java.util.List<Publisher>>	getAllPublishers()
rx.Observable<Publisher>	getPublisher(java.lang.String publisherId)
rx.Observable<java.util.List<Publisher>>	getUserPublishers(java.lang.String userId)
rx.Observable<Publisher>	updatePublisher(Publisher publisher)

Method Detail

getAllPublishers

@GET(value="/publishers")
rx.Observable<java.util.List<Publisher>> getAllPublishers()

Returns:

list of all publishers Publisher

getUserPublishers

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

Parameters:

userId - - unique relayr userId

Returns:

list of all publishers Publisher for specified User id

getPublisher

@GET(value="/publishers/{id}")
rx.Observable<Publisher> getPublisher(@Path(value="id")
                                                                     java.lang.String publisherId)

Parameters:

publisherId - - unique publisherId

Returns:

Publisher entity for specified publisherId

updatePublisher

@PATCH(value="/publishers/{id}")
rx.Observable<Publisher> updatePublisher(@Body
                                                                          Publisher publisher)

Parameters:

publisher - - updated Publisher object

Returns:

Updated Publisher

deletePublisher

@DELETE(value="/publishers/{id}")
rx.Observable<java.lang.Void> deletePublisher(@Path(value="id")
                                                                                java.lang.String publisherId)

Parameters:

publisherId - - publisherId to delete

Returns:

empty Observable if deleted

createPublisher

@POST(value="/publishers")
rx.Observable<Publisher> createPublisher(@Body
                                                                    Publisher publisher)

Parameters:

publisher - - Publisher object to create

Returns:

created Publisher