AppInstance メンバー
保護されたメンバーを含む
宣言されたメンバーを含む
Represents an App object installed to a specific Web site.
AppInstance 型は次のメンバーを公開します。
コンストラクター
名前 | 説明 | |
---|---|---|
AppInstance | Initializes a new instance of the AppInstance class using the current context and object path. |
Top
プロパティ
名前 | 説明 | |
---|---|---|
AppPrincipalId | Gets the encoded claim value for the app principal identifier associated with this app instance. | |
AppWebFullUrl | Gets the absolute URL of the site created during the installation of this app instance that is used to host SharePoint components. | |
Context | クライアントのオブジェクトに関連付けられているコンテキストを返します。 (ClientObject から継承されています。) | |
Id | Gets the unique identifier of the AppInstance object. | |
ImageFallbackUrl | ||
ImageUrl | ||
InError | Gets whether the app instance is in an error state. | |
ObjectData | 現在のクライアント オブジェクトのオブジェクトのデータを取得します。 (ClientObject から継承されています。) | |
ObjectVersion | 現在のクライアント オブジェクトのバージョンを示す文字列を取得します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
PackageFingerprint | ||
Path | クライアント オブジェクトの作成方法ClientRuntimeContextクラスのサーバー上でオブジェクトを再作成することができるようにを追跡します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
ProductId | ||
RemoteAppUrl | Gets the base URL of the remote system deployed during the installation of this app instance. | |
ServerObjectIsNull | サーバー オブジェクトを取得し、サーバー オブジェクトが null の場合は、null を返します。 (ClientObject から継承されています。) | |
SettingsPageUrl | Gets the settings page URL of the current app instance. | |
SiteId | Gets the SharePoint site containing the Web where this app instance is installed. | |
StartPage | Gets the start page of the app instance. | |
Status | Gets the lifecycle status of an app instance based on the constants defined by the AppInstanceStatus object. | |
Tag | したがって、または、クライアント オブジェクトに関連付けられているデータを設定します。 (ClientObject から継承されています。) | |
Title | Gets the title of the SharePoint app. | |
TypedObject | サーバーから返された正しい型の情報と、オブジェクトを取得します。 (ClientObject から継承されています。) | |
WebId | Gets the identifier of the web where this app is installed. |
Top
メソッド
名前 | 説明 | |
---|---|---|
CancelAllJobs | Cancels each currently running lifecycle job for an app instance. | |
CheckUninitializedProperty | のClientObjectの指定された値の種類のプロパティが初期化されているかどうかを確認します。 (ClientObject から継承されています。) | |
CustomFromJson | ユーザー設定のコードを使用するオブジェクトを作成するかどうかを示す論理値を返します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
FromJson | ユーザー設定のコードを使用するオブジェクトを作成するかどうかを示します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
GetAppIcon | ||
GetErrorDetails | Retrieves the details of an error the app instance has encountered. | |
GetPreviousAppVersion | Retrieves the version of the app that is being upgraded from during an upgrade. | |
InitNonPropertyFieldFromJson | サーバーからJavaScript Object Notation (JSON)データに基づいて、クライアント オブジェクトのプロパティ以外のフィールドを初期化します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
InitOnePropertyFromJson | Initializes one property of the client object based on JSON data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (ClientObject.InitOnePropertyFromJson(String, JsonReader) を上書きします。) | |
Install | Starts an install on this app instance. | |
IsObjectPropertyInstantiated | 指定された、クライアント オブジェクトのプロパティがインスタンスになっているかどうかを示します。 (ClientObject から継承されています。) | |
IsPropertyAvailable | 指定したスカラー プロパティの取得または設定されているかどうかを示す論理値を返します。 (ClientObject から継承されています。) | |
LoadExpandoFields | 派生クラスでオーバーライドされた場合は、クライアント オブジェクトに関連付けられている拡張されたプロパティを初期化します。 (ClientObject から継承されています。) | |
Recycle | Creates a job that sends the app instance to the recycle bin. | |
RefreshLoad | 派生クラスでオーバーライドされた場合は、クライアント オブジェクトに関連付けられているすべてのスカラー プロパティを再ロードします。 (ClientObject から継承されています。) | |
RemoveFromParentCollection | 親のクライアント オブジェクトのコレクションから現在のクライアント オブジェクトを削除します。 (ClientObject から継承されています。) | |
Restore | Creates a job that restores the app instance from the recycle bin to the installed state. | |
Retrieve() | オブジェクトに関連付けられているすべてのスカラー プロパティを取得します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
Retrieve([]) | オブジェクトに関連付けられている、指定したスカラー プロパティを取得します。このメンバーは内部使用のために予約済みです。ユーザーのコードから直接使用されるものではありません。 (ClientObject から継承されています。) | |
RetrieveAppDatabaseConnectionString | Retrieves the connection string for an app database. | |
RetryAllJobs | Restarts all jobs for this app instance if there are any. | |
ToString | (Object から継承されています。) | |
TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnection, Boolean) | Retrieves a connection to the app database. | |
TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnectionStringBuilder, SqlConnection, Boolean) | Retrieves a connection to the app database. | |
Uninstall | Removes app instances that are either initialized or installed. | |
UpdateClientObjectPropertyType | 正しい型に、サーバーから返されたタイプの情報を使用して、クライアント オブジェクト プロパティの値を更新します。 (ClientObject から継承されています。) | |
Upgrade | Uploads a version of an app, and then upgrades the app instance to that version. |
Top