com.abiquo.api.resources.FrameResource Class Reference

This class represents a FrameResource, and allows to display photos on the photo frame. More...

Inherits ResourceInstance.

List of all members.

Public Member Functions
	FrameResource ()
	Creates a new FrameResource with the default values.
	FrameResource (ResourceInstance resourceInstance)
	Creates a new FrameResource based on a generic ResourceInstance.
Job	addToList (String url)
	Creates a new Job which once executed, adds a photo the current playlist.
Job	displayPhoto (String url)
	Creates a new Job which once executed, display the argument photo in the frame.
Static Public Member Functions
static FrameResource	cast (ResourceInstance resourceInstance)
	Converts a generic ResourceInstance into a new one of type FrameResource.
Static Public Attributes
static final String	ID = "Frame"
	String containing the identifier for this resource.

---

Detailed Description

This class represents a FrameResource, and allows to display photos on the photo frame.

Note:

It is needed to configure fake DNS to fool the frame. Please refer to documentation at http://dev.abiquo.com/

---

Constructor & Destructor Documentation

com.abiquo.api.resources.FrameResource.FrameResource

(

ResourceInstance

resourceInstance

)

Creates a new FrameResource based on a generic ResourceInstance.

Parameters:

resourceInstance

The generic ResourceInstance

---

Member Function Documentation

static FrameResource com.abiquo.api.resources.FrameResource.cast

(

ResourceInstance

resourceInstance

)

[static]

Converts a generic ResourceInstance into a new one of type FrameResource.

Parameters:

resourceInstance

The generic ResourceInstance

Returns:

The resultant FrameResource

Job com.abiquo.api.resources.FrameResource.addToList

(

String

url

)

Creates a new Job which once executed, adds a photo the current playlist.

Parameters:

url

The URL where the photo is located

Returns:

The Job to perform the demand

Job com.abiquo.api.resources.FrameResource.displayPhoto

(

String

url

)

Creates a new Job which once executed, display the argument photo in the frame.

Parameters:

url

The URL where the photo is located

Returns:

The Job to perform the demand

---

Member Data Documentation

final String com.abiquo.api.resources.FrameResource.ID = "Frame" [static]

String containing the identifier for this resource.

Note:

To avoid misspellings when provision a resource, you should use this constant ID instead of a manually typed string.

---

The documentation for this class was generated from the following file:

• src/com/abiquo/api/resources/FrameResource.java