UserActivity 类

  • java.lang.Object
    • NativeBase
      • com.microsoft.connecteddevices.userdata.useractivities.UserActivity

public class UserActivity

此类表示单个用户活动实例。 用户活动由应用在执行期间创建,以通知系统用户工作流,该工作流可以在另一台设备上或在同一设备上另一时间继续。 它提供有关用户参与的任务的信息。

构造函数摘要

构造函数 说明
UserActivity(@NonNull String activityId)

使用指定 ID 创建活动。

方法摘要

修饰符和类型 方法和描述
UserActivitySession createSession()

创建此 UserActivity 将与之关联的用户活动会话。 关联的 UserActivitySession 指示用户当前正在参与该活动。

String getActivationUri()

获取此活动的主 URI。

String getActivityId()

获取此活动的唯一 ID。

String getAppDisplayName()

获取此活动的应用显示名称。

String getContentInfoJson()

获取此活动的基本内容信息。

String getContentType()

获取此活动的内容类型。

String getContentUri()

获取此活动的内容 URI。

String getFallbackUri()

获取此活动保留的回退 URI。

boolean getIsRoamable()

获取此活动是否漫游到其他终结点。

UserActivityState getState()

获取此活动的状态。

UserActivityVisualElements getVisualElements()

获取此活动的视觉元素。

AsyncOperation<Void> saveAsync()

发布用户活动。 在调用此方法之前,UserActivity 必须具有激活 URI 和具有设置显示文本的 VisualElements 成员。 每当应用修改 UserActivity (的属性以发布更新) 时,都应调用此方法。

void setActivationUri(@NonNull String activationUri)

激活此用户活动时要遵循的 URI。

void setContentInfoJson(@Nullable String contentInfoJson)

设置此活动的基本内容信息。 例如,如果活动正在读取 RSS 源,则内容可能包括文章的名称及其作者。

void setContentType(@Nullable String contentType)

设置 MIME (多用途 Internet 邮件扩展) 使用 setContentUri 存储的内容的类型。 例如,“text/plain”。

void setContentUri(@Nullable String contentUri)

设置此活动的内容 URI (图像的 URI,该 URI 将用于表示另一个设备上的活动) 。

void setFallbackUri(@Nullable String fallbackUri)

设置此活动的 Web 友好 URI,以便在主 URI 失败时使用。

void setIsRoamable(boolean roamable)

设置此活动是否漫游到其他终结点。

void setVisualElements(@NonNull UserActivityVisualElements visualElements)

设置此活动的可视元素 (可用于活动) 的“详细信息”磁贴的信息。

构造函数详细信息

UserActivity

public UserActivity(@NonNull String activityId)

使用指定 ID 创建活动。

Parameters:

activityId - 此活动的唯一 ID。

方法详细信息

createSession

public UserActivitySession createSession()

创建此 UserActivity 将与之关联的用户活动会话。 关联的 UserActivitySession 指示用户当前正在参与该活动。

Returns:

创建的 UserActivitySession**

getActivationUri

public String getActivationUri()

获取此活动的主 URI。

Returns:

主激活 URI 字符串。

getActivityId

public String getActivityId()

获取此活动的唯一 ID。

Returns:

ID 字符串。

getAppDisplayName

public String getAppDisplayName()

获取此活动的应用显示名称。

Returns:

应用显示名称。

getContentInfoJson

public String getContentInfoJson()

获取此活动的基本内容信息。

Returns:

内容信息 json 字符串。

getContentType

public String getContentType()

获取此活动的内容类型。

Returns:

内容类型 String。

getContentUri

public String getContentUri()

获取此活动的内容 URI。

Returns:

内容 URI 字符串。

getFallbackUri

public String getFallbackUri()

获取此活动保留的回退 URI。

Returns:

回退 URI 字符串。

getIsRoamable

public boolean getIsRoamable()

获取此活动是否漫游到其他终结点。

Returns:

此活动是否漫游到其他终结点的布尔值。

getState

public UserActivityState getState()

获取此活动的状态。

Returns:

描述状态的 UserActivityState 值。

getVisualElements

public UserActivityVisualElements getVisualElements()

获取此活动的视觉元素。

Returns:

包含视觉元素数据的 UserActivityVisualElements。

saveAsync

public AsyncOperation saveAsync()

发布用户活动。 在调用此方法之前,UserActivity 必须具有激活 URI 和具有设置显示文本的 VisualElements 成员。 每当应用修改 UserActivity (的属性以发布更新) 时,都应调用此方法。

Returns:

表示此操作的 AsyncOperation。

setActivationUri

public void setActivationUri(@NonNull String activationUri)

激活此用户活动时要遵循的 URI。

Parameters:

activationUri - 主激活 URI 字符串。

setContentInfoJson

public void setContentInfoJson(@Nullable String contentInfoJson)

设置此活动的基本内容信息。 例如,如果活动正在读取 RSS 源,则内容可能包括文章的名称及其作者。

Parameters:

contentInfoJson - 内容信息 json 字符串。

setContentType

public void setContentType(@Nullable String contentType)

设置 MIME (多用途 Internet 邮件扩展) 使用 setContentUri 存储的内容的类型。 例如,“text/plain”。

Parameters:

contentType - 内容类型 String。

setContentUri

public void setContentUri(@Nullable String contentUri)

设置此活动的内容 URI (图像的 URI,该 URI 将用于表示另一个设备上的活动) 。

Parameters:

contentUri - 要设置为内容 URI 的字符串。

setFallbackUri

public void setFallbackUri(@Nullable String fallbackUri)

设置此活动的 Web 友好 URI,以便在主 URI 失败时使用。

Parameters:

fallbackUri - 回退 URI 字符串。

setIsRoamable

public void setIsRoamable(boolean roamable)

设置此活动是否漫游到其他终结点。

Parameters:

roamable - 此活动是否漫游到其他终结点的布尔值。

setVisualElements

public void setVisualElements(@NonNull UserActivityVisualElements visualElements)

设置此活动的可视元素 (可用于活动) 的“详细信息”磁贴的信息。

Parameters:

visualElements - 包含视觉元素数据的 UserActivityVisualElements。

适用于