org.mythtv.services.api.frontend.impl
Class FrontendTemplate

java.lang.Object
  org.mythtv.services.api.AbstractOperations
      org.mythtv.services.api.frontend.impl.FrontendTemplate

All Implemented Interfaces:

FrontendOperations

public class FrontendTemplate
extends AbstractOperations
implements FrontendOperations

Author:

Daniel Frey

Field Summary

Fields inherited from class org.mythtv.services.api.AbstractOperations

formatter

Constructor Summary

FrontendTemplate(org.springframework.web.client.RestOperations restOperations, String apiUrlBase)

Method Summary

protected URI	buildUri(String path, org.springframework.util.MultiValueMap<String,String> parameters)
org.springframework.http.ResponseEntity<FrontendActionList>	getActionList(String frontedApiUrlBase, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<FrontendStatus>	getStatus(String frontedApiUrlBase, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<Bool>	playRecording(String frontedApiUrlBase, int channelId, org.joda.time.DateTime startTime) - GET
org.springframework.http.ResponseEntity<Bool>	playVideo(String frontedApiUrlBase, String id, boolean useBookmark)
org.springframework.http.ResponseEntity<Bool>	sendAction(String frontedApiUrlBase, String action, String file, int width, int height) - GET
org.springframework.http.ResponseEntity<Bool>	sendMessage(String frontedApiUrlBase, String message) - GET

Methods inherited from class org.mythtv.services.api.AbstractOperations

buildUri, buildUri, convertUtcAndFormat, getApiUrlBase, getRequestEntity, handleResponseEtag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrontendTemplate

public FrontendTemplate(org.springframework.web.client.RestOperations restOperations,
                        String apiUrlBase)

Method Detail

getStatus

public org.springframework.http.ResponseEntity<FrontendStatus> getStatus(String frontedApiUrlBase,
                                                                         ETagInfo etag)
                                                                  throws MythServiceApiRuntimeException

Description copied from interface: FrontendOperations

- GET

Specified by:

getStatus in interface FrontendOperations

Returns:

Throws:

MythServiceApiRuntimeException

sendMessage

public org.springframework.http.ResponseEntity<Bool> sendMessage(String frontedApiUrlBase,
                                                                 String message)
                                                          throws MythServiceApiRuntimeException

Description copied from interface: FrontendOperations

- GET

Specified by:

sendMessage in interface FrontendOperations

Returns:

Throws:

MythServiceApiRuntimeException

sendAction

public org.springframework.http.ResponseEntity<Bool> sendAction(String frontedApiUrlBase,
                                                                String action,
                                                                String file,
                                                                int width,
                                                                int height)
                                                         throws MythServiceApiRuntimeException

Description copied from interface: FrontendOperations

- GET

Specified by:

sendAction in interface FrontendOperations

Returns:

Throws:

MythServiceApiRuntimeException

getActionList

public org.springframework.http.ResponseEntity<FrontendActionList> getActionList(String frontedApiUrlBase,
                                                                                 ETagInfo etag)
                                                                          throws MythServiceApiRuntimeException

Description copied from interface: FrontendOperations

- GET

Specified by:

getActionList in interface FrontendOperations

Returns:

Throws:

MythServiceApiRuntimeException

playRecording

public org.springframework.http.ResponseEntity<Bool> playRecording(String frontedApiUrlBase,
                                                                   int channelId,
                                                                   org.joda.time.DateTime startTime)

Description copied from interface: FrontendOperations

- GET

Specified by:

playRecording in interface FrontendOperations

channelId - - (Required) The database channel id for the recording

startTime - - (Required) The recording start time for the item. This should be in MySQL ISO format, eg: 2011-08-29 18:59:00. You can replace the space with %20 or T.

Returns:

playVideo

public org.springframework.http.ResponseEntity<Bool> playVideo(String frontedApiUrlBase,
                                                               String id,
                                                               boolean useBookmark)

Specified by:

playVideo in interface FrontendOperations

id - - (Required) The database id for the video file

useBookmark - - (Optional) Pass 1 to resume playback at a bookmark

Returns:

buildUri

protected URI buildUri(String path,
                       org.springframework.util.MultiValueMap<String,String> parameters)

Overrides:

buildUri in class AbstractOperations

Returns: