public final class ContentRecommendation
extends Object
java.lang.Object | |
↳ | android.support.app.recommendation.ContentRecommendation |
ContentRecommendation对象封装了单个内容推荐项目的所有应用程序提供的数据。
Nested classes |
|
---|---|
class |
ContentRecommendation.Builder |
@interface |
ContentRecommendation.ContentMaturity
|
@interface |
ContentRecommendation.ContentPricing
|
@interface |
ContentRecommendation.ContentStatus
|
@interface |
ContentRecommendation.ContentType
|
class |
ContentRecommendation.IntentData 用于封装数据对象被用来构建 |
@interface |
ContentRecommendation.IntentType
|
Public methods |
|
---|---|
boolean |
equals(Object other) 指示其他某个对象是否“等于”这一个。 |
String |
getBackgroundImageUri() 返回可用于检索此建议的背景图像的内容URI。 |
int |
getBadgeImageResourceId() 返回推荐标识图标的资源ID。 |
int |
getColor() 向用户显示此内容推荐时,返回用于用户界面的重音颜色值。 |
Bitmap |
getContentImage() 返回包含推荐图像的位图。 |
ContentRecommendation.IntentData |
getContentIntent() 返回用户点击建议时将发布的Intent的数据。 |
String[] |
getContentTypes() 返回包含描述内容的内容类型标签的数组。 |
ContentRecommendation.IntentData |
getDismissIntent() 由于用户操作,返回建议从主屏幕退出时将发出的Intent数据。 |
String[] |
getGenres() 返回包含描述内容的流派的数组。 |
String |
getGroup() 返回此建议的字符串组标识标记。 |
String |
getIdTag() 返回唯一标识此建议的字符串ID标记。 |
String |
getMaturityRating() 返回内容的成熟度等级。 |
Notification |
getNotificationObject(Context context) 返回一个包含此对象封装的内容推荐数据的 |
String |
getPricingType() 获取内容的定价类型。 |
String |
getPricingValue() 获取内容的价格值(如果适用)。 |
String |
getPrimaryContentType() 返回建议的主要内容类型标记;如果未指定内容类型,则返回null。 |
int |
getProgressMax() 返回此建议的进度数据的最大值。 |
int |
getProgressValue() 返回此建议的进度金额。 |
long |
getRunningTime() 返回内容的运行时间。 |
String |
getSortKey() 返回此建议的字符串排序关键字。 |
String |
getSourceName() 返回此建议的源应用程序名称。 |
int |
getStatus() 返回内容的可用性状态值。 |
String |
getText() 返回此建议的描述文本。 |
String |
getTitle() 返回此建议的内容标题。 |
boolean |
hasProgressInfo() 指示此建议是否包含有效的进度信息。 |
int |
hashCode() 返回对象的哈希码值。 |
boolean |
isAutoDismiss() 指示是否应自动解除此建议。 |
void |
setAutoDismiss(boolean autoDismiss) 设置标志,指示是否应自动解除此建议。 |
void |
setGroup(String groupTag) 为此建议设置字符串组ID标记。 |
void |
setProgress(int max, int progress) 设置本建议所指内容的进度信息。 |
void |
setSortKey(String sortKey) 为此建议设置字符串排序键。 |
void |
setStatus(int status) 设置内容的可用性状态值。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
String CONTENT_MATURITY_ALL
与 setMaturityRating(String)
一起使用的值,表示通知所引用的内容适用于所有受众。
常量值:“android.contentMaturity.all”
String CONTENT_MATURITY_HIGH
与 setMaturityRating(String)
一起使用的值,用于表明通知所引用的内容适合高成熟度及以上的受众群体。
常量值:“android.contentMaturity.high”
String CONTENT_MATURITY_LOW
与 setMaturityRating(String)
一起使用的值,用于表明通知所引用的内容适用于低成熟度及以上的受众群体。
常量值:“android.contentMaturity.low”
String CONTENT_MATURITY_MEDIUM
与 setMaturityRating(String)
一起使用的值,用于表明通知所引用的内容适合中等及以上的受众群体。
常量值:“android.contentMaturity.medium”
String CONTENT_PRICING_FREE
要与 setPricingInformation(String, String)
一起使用的值,表示通知项目引用的内容可以自由使用。
常量值:“android.contentPrice.free”
String CONTENT_PRICING_PREORDER
与 setPricingInformation(String, String)
一起使用的值,用于指示通知项目引用的内容当前可用作预购订单,并且提供的价格值为该项目的购买价格。
常量值:“android.contentPrice.preorder”
String CONTENT_PRICING_PURCHASE
与 setPricingInformation(String, String)
一起使用的值,用于指示通知项目引用的内容可供购买,并且提供的价格值为该项目的购买价格。
常量值:“android.contentPrice.purchase”
String CONTENT_PRICING_RENTAL
与 setPricingInformation(String, String)
一起使用的值,表示通知项目引用的内容可用作租赁,并且所提供的价格值为该项目的租赁价格。
常量值:“android.contentPrice.rental”
String CONTENT_PRICING_SUBSCRIPTION
与 setPricingInformation(String, String)
一起使用的值,用于指示通知项目引用的内容作为基于订阅的服务的一部分提供,并且提供的价格值为服务的订购价格。
常量值:“android.contentPrice.subscription”
int CONTENT_STATUS_AVAILABLE
与 setStatus(int)
一起使用的值表示通知引用的内容可用,但需要首先购买,租用,订阅或下载才能使用。
常量值:2(0x00000002)
int CONTENT_STATUS_PENDING
与 setStatus(int)
一起使用的值,用于指示通知引用的内容处于待处理状态,等待下载或购买操作完成后才能使用。
常数值:1(0x00000001)
int CONTENT_STATUS_READY
与 setStatus(int)
一起使用的值,用于指示通知引用的内容可用并可立即使用。
常量值:0(0x00000000)
int CONTENT_STATUS_UNAVAILABLE
要与setStatus(int)
一起使用的值,表示通知引用的内容不可用。 这可能是某个地区无法使用的内容,或者与正在使用的设备不兼容。
常量值:3(0x00000003)
String CONTENT_TYPE_APP
要与 setContentTypes(String[])
一起使用的值,以指示通知项目引用的内容是应用程序。
常量值:“android.contentType.app”
String CONTENT_TYPE_BOOK
与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是书籍。
常量值:“android.contentType.book”
String CONTENT_TYPE_COMIC
要与 setContentTypes(String[])
一起使用的值,以指示通知项目引用的内容是漫画书。
常量值:“android.contentType.comic”
String CONTENT_TYPE_GAME
与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是游戏。
常量值:“android.contentType.game”
String CONTENT_TYPE_MAGAZINE
要与 setContentTypes(String[])
一起使用的值,表示通知项目引用的内容是杂志。
常量值:“android.contentType.magazine”
String CONTENT_TYPE_MOVIE
与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是电影。
常量值:“android.contentType.movie”
String CONTENT_TYPE_MUSIC
要与 setContentTypes(String[])
一起使用的值,表示通知项目引用的内容是歌曲或专辑。
常量值:“android.contentType.music”
String CONTENT_TYPE_NEWS
要与 setContentTypes(String[])
一起使用的值,表示通知项目引用的内容是新闻项目。
常量值:“android.contentType.news”
String CONTENT_TYPE_PODCAST
与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是播客。
常量值:“android.contentType.podcast”
String CONTENT_TYPE_RADIO
要与 setContentTypes(String[])
一起使用的值,以指示通知项目引用的内容是无线电台。
常量值:“android.contentType.radio”
String CONTENT_TYPE_SERIAL
要与setContentTypes(String[])
一起使用的值,表示通知项目引用的内容是串行的。 它可以指整个节目,单个季节或系列,或单个情节。
常量值:“android.contentType.serial”
String CONTENT_TYPE_SPORTS
用于与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是运动内容。
常量值:“android.contentType.sports”
String CONTENT_TYPE_TRAILER
要与 setContentTypes(String[])
一起使用的值,表示通知项目引用的内容是一个预告片。
常量值:“android.contentType.trailer”
String CONTENT_TYPE_VIDEO
要与 setContentTypes(String[])
一起使用的值,以指示通知项目引用的内容是视频剪辑。
常量值:“android.contentType.video”
String CONTENT_TYPE_WEBSITE
与 setContentTypes(String[])
一起使用的值,用于指示通知项目引用的内容是网站。
常量值:“android.contentType.website”
int INTENT_TYPE_ACTIVITY
与 setContentIntentData(int, Intent, int, Bundle)
和 setDismissIntentData(int, Intent, int, Bundle)
配合使用的值,表示在向HomeScreen发布建议时应创建活动的 PendingIntent
。
常数值:1(0x00000001)
int INTENT_TYPE_BROADCAST
值与使用 setContentIntentData(int, Intent, int, Bundle)
和 setDismissIntentData(int, Intent, int, Bundle)
以表示 PendingIntent
发布的建议,主屏幕时广播应创建。
常量值:2(0x00000002)
int INTENT_TYPE_SERVICE
与 setContentIntentData(int, Intent, int, Bundle)
和 setDismissIntentData(int, Intent, int, Bundle)
一起使用的值,表示在向HomeScreen发布建议时应创建服务的 PendingIntent
。
常量值:3(0x00000003)
boolean equals (Object other)
指示其他某个对象是否“等于”这一个。
equals
方法在非空对象引用上实现等价关系:
x
, x.equals(x)
should return true
. x
and y
, x.equals(y)
should return true
if and only if y.equals(x)
returns true
. x
, y
, and z
, if x.equals(y)
returns true
and y.equals(z)
returns true
, then x.equals(z)
should return true
. x
and y
, multiple invocations of x.equals(y)
consistently return true
or consistently return false
, provided no information used in equals
comparisons on the objects is modified. x
, x.equals(null)
should return false
. 类equals
方法Object
实现对象上最可能的等价关系; 也就是说,对于任何非空参考值x
和y
,当且仅当x
和y
引用同一对象( x == y
的值为true
)时,此方法返回true
。
请注意,无论何时重写此方法,通常都必须重写 hashCode
方法,以维护 hashCode
方法的常规协定,该方法声明相等对象必须具有相同的哈希码。
Parameters | |
---|---|
other |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj argument; false otherwise. |
String getBackgroundImageUri ()
返回可用于检索此建议的背景图像的内容URI。
Returns | |
---|---|
String |
A Content URI pointing to the recommendation background image. |
int getBadgeImageResourceId ()
返回推荐标识图标的资源ID。
资源ID代表源应用程序包中的图标资源。
Returns | |
---|---|
int |
An integer id for the badge icon resource. |
int getColor ()
向用户显示此内容推荐时,返回用于用户界面的重音颜色值。
Returns | |
---|---|
int |
An integer value representing the accent color for this recommendation. |
Bitmap getContentImage ()
返回包含推荐图像的位图。
Returns | |
---|---|
Bitmap |
A Bitmap containing the recommendation image. |
ContentRecommendation.IntentData getContentIntent ()
返回用户点击建议时将发布的Intent的数据。
Returns | |
---|---|
ContentRecommendation.IntentData |
An IntentData object, containing the data for the Intent that gets issued when the recommendation is clicked on. |
String[] getContentTypes ()
返回包含描述内容的内容类型标签的数组。 第一个标签条目被认为是内容的主要类型,并用于内容排名目的。
Returns | |
---|---|
String[] |
An array of predefined type tags (see the CONTENT_TYPE_* constants) that describe the recommended content. |
ContentRecommendation.IntentData getDismissIntent ()
由于用户操作,返回建议从主屏幕退出时将发出的Intent数据。
Returns | |
---|---|
ContentRecommendation.IntentData |
An IntentData object, containing the data for the Intent that gets issued when the recommendation is dismissed from the Home Screen. |
String[] getGenres ()
返回包含描述内容的流派的数组。 流派是开放式结束字符串标记。
Returns | |
---|---|
String[] |
An array of genre tags that describe the recommended content. |
String getGroup ()
返回此建议的字符串组标识标记。
Returns | |
---|---|
String |
A String containing the group ID tag for this recommendation. |
String getIdTag ()
返回唯一标识此建议的字符串ID标记。
Returns | |
---|---|
String |
The String Id tag for this recommendation. |
String getMaturityRating ()
返回内容的成熟度等级。
Returns | |
---|---|
String |
returns a predefined tag indicating the maturity level rating for the content (see the CONTENT_MATURITY_* constants). |
Notification getNotificationObject (Context context)
返回 Notification
对象,其包含此对象,它可用于发布经由建议封装内容推荐数据 NotificationManager
。
Parameters | |
---|---|
context |
Context : A Context that will be used to construct the Notification object which will carry the recommendation data. |
Returns | |
---|---|
Notification |
A Notification containing the stored recommendation data. |
String getPricingType ()
获取内容的定价类型。
Returns | |
---|---|
String |
A predefined tag indicating the pricing type for the content (see the CONTENT_PRICING_* constants). |
String getPricingValue ()
获取内容的价格值(如果适用)。 该值将以字符串的形式提供,其中包含当前语言环境适当货币的价格。
Returns | |
---|---|
String |
A string containing a representation of the content price in the current locale and currency. |
String getPrimaryContentType ()
返回建议的主要内容类型标记;如果未指定内容类型,则返回null。
Returns | |
---|---|
String |
A predefined type tag (see the CONTENT_TYPE_* constants) indicating the primary content type for the recommendation. |
int getProgressMax ()
返回此建议的进度数据的最大值。
Returns | |
---|---|
int |
An integer representing the maximum progress value. |
int getProgressValue ()
返回此建议的进度金额。
Returns | |
---|---|
int |
An integer representing the recommendation progress amount. |
long getRunningTime ()
返回内容的运行时间。
Returns | |
---|---|
long |
The run length, in seconds, of the content associated with the notification. |
String getSortKey ()
返回此建议的字符串排序关键字。
Returns | |
---|---|
String |
A String containing the sort key for this recommendation. |
String getSourceName ()
返回此建议的源应用程序名称。
Returns | |
---|---|
String |
A String containing the recommendation source name. |
int getStatus ()
返回内容的可用性状态值。 此状态表示内容是否已准备好在设备上使用,或者用户是否必须先购买,租用,订阅或下载内容。
Returns | |
---|---|
int |
The status value for the content, or -1 is a valid status has not been specified (see the CONTENT_STATUS_* constants for the valid status values). |
String getText ()
返回此建议的描述文本。
Returns | |
---|---|
String |
A String containing the recommendation description text. |
String getTitle ()
返回此建议的内容标题。
Returns | |
---|---|
String |
A String containing the recommendation content title. |
boolean hasProgressInfo ()
指示此建议是否包含有效的进度信息。
Returns | |
---|---|
boolean |
true if the recommendation contains valid progress data, false otherwise. |
int hashCode ()
返回对象的哈希码值。 此方法支持散列表的好处,例如由HashMap
提供的HashMap
。
hashCode
的总合同是:
hashCode
method must consistently return the same integer, provided no information used in equals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. equals(Object)
method, then calling the hashCode
method on each of the two objects must produce the same integer result. equals(java.lang.Object)
method, then calling the hashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. 尽可能合理实用,由类Object
定义的hashCode方法确实为不同的对象返回不同的整数。 (这通常通过将对象的内部地址转换为整数来实现,但Java TM编程语言不需要此实现技术。)
Returns | |
---|---|
int |
a hash code value for this object. |
boolean isAutoDismiss ()
指示是否应自动解除此建议。
当用户点击主屏幕时,自动关闭通知会自动删除。
Returns | |
---|---|
boolean |
true if the recommendation is marked for auto dismissal, or false otherwise. |
void setAutoDismiss (boolean autoDismiss)
设置标志,指示是否应自动解除此建议。
当用户点击主屏幕时,自动关闭通知会自动删除。
Parameters | |
---|---|
autoDismiss |
boolean : A boolean indicating if the recommendation should be auto dismissed or not. |
void setGroup (String groupTag)
为此建议设置字符串组ID标记。
同一组中的建议一起按主屏幕排列,并且组内的排序顺序受到尊重。 如果应用程序有不同的推荐来源,比如YouTube的“趋势”,“订阅”和“新音乐”类别,用户可以对其中一组的推荐更感兴趣,那么这会非常有用。
Parameters | |
---|---|
groupTag |
String : A String containing the group ID tag for this recommendation. |
void setProgress (int max, int progress)
设置本建议所指内容的进度信息。
Parameters | |
---|---|
max |
int : The maximum value for the progress of this content. |
progress |
int : The progress amount for this content. Must be in the range (0 - max). |
void setSortKey (String sortKey)
为此建议设置字符串排序键。
排序键必须是介于0.0和1.0之间的浮点数的字符串表示形式,用于表示指定组内的单个建议的相对重要性(和排序顺序)。 这些建议将按照给定组内的重要性降序排列。
Parameters | |
---|---|
sortKey |
String : A String containing the sort key for this recommendation. |
void setStatus (int status)
设置内容的可用性状态值。 此状态表示内容是否已准备好在设备上使用,或者用户是否必须先购买,租用,订阅或下载内容。
Parameters | |
---|---|
status |
int : The status value for the content. (see the CONTENT_STATUS_* for the valid status values). |