com.adobe.cq.mobile.platform

Interface MobileResource

All Superinterfaces:

Adaptable, LabeledResource

public interface MobileResource
extends LabeledResource, Adaptable

Method Summary

Modifier and Type	Method and Description
boolean	addAppType(String type) Add the specified type id to this mobile resource.
Set<String>	getAppTypes() Returns the mobile app types that have been added to this Resource.
MobileResourceType	getMobileResourceType() Deprecated. This is deprecated because an app may have multiple types.
ValueMap	getProperties() Returns the mobile resource properties.
boolean	isA(String... types) Returns whether this mobile resource is of a specified app type.

Methods inherited from interface com.day.cq.commons.LabeledResource

getDescription, getName, getPath, getTitle

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Method Detail

getProperties

ValueMap getProperties()

Returns the mobile resource properties.

Returns:

The mobile resource properties as a ValueMap.

isA

boolean isA(String... types)

Returns whether this mobile resource is of a specified app type. A type id from MobileResourceConstants can be used.

Parameters:

types - The list of mobile resource type ids. See com.adobe.cq.mobile.platform.impl.MobileConstants for common app types.

Returns:

Whether this mobile resource is of a specified app type.

getAppTypes

Set<String> getAppTypes()

Returns the mobile app types that have been added to this Resource. A value of null will be returned when this resource has no type.

Returns:

The mobile types this resource has.

getMobileResourceType

MobileResourceType getMobileResourceType()

Deprecated. This is deprecated because an app may have multiple types.

Return the MobileResourceType that is associated with this MobileResource.

Returns:

the MobileResourceType, or null if the Resource does not support a MobileResourceType.

See Also:

MobileResourceType

addAppType

boolean addAppType(String type)

Add the specified type id to this mobile resource. A type id from MobileResourceConstants can be used or any custom defined type id can be added as well.

Parameters:

type - See com.adobe.cq.mobile.platform.impl.MobileConstants for common app types.

Returns:

Whether the addition of the type was successful.