UserActivity クラス

パッケージ:

com.microsoft.connecteddevices.userdata.useractivities

• 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) **setContentUri** で格納されるコンテンツの MIME (多目的インターネット メール拡張機能) の種類を設定します。 たとえば、"text/plain" などです。
void	setContentUri(@Nullable String contentUri) このアクティビティのコンテンツ URI (別のデバイスでのアクティビティを表すために使用されるイメージの URI) を設定します。
void	setFallbackUri(@Nullable String fallbackUri) プライマリ URI が失敗した場合に使用する、このアクティビティの Web フレンドリ URI を設定します。
void	setIsRoamable(boolean roamable) このアクティビティを他のエンドポイントにローミングするかどうかを設定します。
void	setVisualElements(@NonNull UserActivityVisualElements visualElements) このアクティビティのビジュアル要素 (アクティビティの [詳細] タイルに使用できる情報) を設定します。

コンストラクターの詳細

UserActivity

public UserActivity(@NonNull String activityId)

指定した ID を持つアクティビティを作成します。

パラメーター:

activityId - このアクティビティの一意の ID。

メソッドの詳細

createSession

public UserActivitySession createSession()

この UserActivity が関連付けられるユーザー アクティビティ セッションを作成します。 関連付けられている **UserActivitySession** は、ユーザーが現在アクティビティに参加していることを示します。

戻り値:

作成された **UserActivitySession**

getActivationUri

public String getActivationUri()

このアクティビティのプライマリ URI を取得します。

戻り値:

プライマリ アクティブ化 URI 文字列。

getActivityId

public String getActivityId()

このアクティビティの一意の ID を取得します。

戻り値:

ID 文字列。

getAppDisplayName

public String getAppDisplayName()

このアクティビティのアプリの表示名を取得します。

戻り値:

アプリの表示名。

getContentInfoJson

public String getContentInfoJson()

このアクティビティの基本的なコンテンツ情報を取得します。

戻り値:

コンテンツ情報の json 文字列。

getContentType

public String getContentType()

このアクティビティのコンテンツ タイプを取得します。

戻り値:

コンテンツ タイプ文字列。

getContentUri

public String getContentUri()

このアクティビティのコンテンツ URI を取得します。

戻り値:

コンテンツ URI 文字列。

getFallbackUri

public String getFallbackUri()

このアクティビティによって保持されているフォールバック URI を取得します。

戻り値:

フォールバック URI 文字列。

getIsRoamable

public boolean getIsRoamable()

このアクティビティが他のエンドポイントにローミングされているかどうかを取得します。

戻り値:

このアクティビティが他のエンドポイントにローミングされるかどうかを示すブール値。

getState

public UserActivityState getState()

このアクティビティの状態を取得します。

戻り値:

状態を記述する **UserActivityState** 値。

getVisualElements

public UserActivityVisualElements getVisualElements()

このアクティビティのビジュアル要素を取得します。

戻り値:

ビジュアル要素データを格納している **UserActivityVisualElements** です。

saveAsync

public AsyncOperation saveAsync()

ユーザー アクティビティを発行します。 UserActivity には、このメソッドを呼び出す前に、アクティブ化 URI と VisualElements メンバーに表示テキストが設定されている必要があります。 このメソッドは、アプリが (更新プログラムを発行するために) UserActivity のプロパティを変更するたびに呼び出す必要があります。

戻り値:

この操作を表す **AsyncOperation** です。

setActivationUri

public void setActivationUri(@NonNull String activationUri)

このユーザー アクティビティがアクティブになったときに従う URI。

パラメーター:

activationUri - プライマリ アクティブ化 URI 文字列。

setContentInfoJson

public void setContentInfoJson(@Nullable String contentInfoJson)

このアクティビティの基本的なコンテンツ情報を設定します。 たとえば、アクティビティが RSS フィードを読み取っていた場合、コンテンツには記事の名前とその作成者が含まれている可能性があります。

パラメーター:

contentInfoJson - コンテンツ情報の json 文字列。

setContentType

public void setContentType(@Nullable String contentType)

**setContentUri** で格納されるコンテンツの MIME (多目的インターネット メール拡張機能) の種類を設定します。 たとえば、"text/plain" などです。

パラメーター:

contentType - コンテンツ タイプ文字列。

setContentUri

public void setContentUri(@Nullable String contentUri)

このアクティビティのコンテンツ URI (別のデバイスでのアクティビティを表すために使用されるイメージの URI) を設定します。

パラメーター:

contentUri - コンテンツ URI として設定する文字列。

setFallbackUri

public void setFallbackUri(@Nullable String fallbackUri)

プライマリ URI が失敗した場合に使用する、このアクティビティの Web フレンドリ URI を設定します。

パラメーター:

fallbackUri - フォールバック URI 文字列。

setIsRoamable

public void setIsRoamable(boolean roamable)

このアクティビティを他のエンドポイントにローミングするかどうかを設定します。

パラメーター:

roamable - このアクティビティが他のエンドポイントにローミングされるかどうかを示すブール値。

setVisualElements

public void setVisualElements(@NonNull UserActivityVisualElements visualElements)

このアクティビティのビジュアル要素 (アクティビティの [詳細] タイルに使用できる情報) を設定します。

パラメーター:

visualElements - ビジュアル要素データを格納している **UserActivityVisualElements** です。