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.

页首

属性

	名称	说明
	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	Returns the context that is associated with the client object. （从 ClientObject 继承。）
	Id	Gets the unique identifier of the AppInstance object.
	ImageFallbackUrl
	ImageUrl
	InError	Gets whether the app instance is in an error state.
	ObjectData	Gets the object data for the current client object. （从 ClientObject 继承。）
	ObjectVersion	Gets a string that indicates the version of the current client object. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 ClientObject 继承。）
	PackageFingerprint
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 ClientObject 继承。）
	ProductId
	RemoteAppUrl	Gets the base URL of the remote system deployed during the installation of this app instance.
	ServerObjectIsNull	Gets the server object and returns null if the server object is 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	Gets or sets data that is associated with the client object. （从 ClientObject 继承。）
	Title	Gets the title of the SharePoint app.
	TypedObject	Gets the object with the correct type information returned from the server. （从 ClientObject 继承。）
	WebId	Gets the identifier of the web where this app is installed.

页首

方法

	名称	说明
	CancelAllJobs	Cancels each currently running lifecycle job for an app instance.
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. （从 ClientObject 继承。）
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 ClientObject 继承。）
	FromJson	Indicates whether custom code was used to populate an object. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 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	Initializes a non-property field of the client object based on JavaScript 对象表示法 (JSON) data from the server. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 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	Indicates whether the specified property of the client object is instantiated. （从 ClientObject 继承。）
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. （从 ClientObject 继承。）
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. （从 ClientObject 继承。）
	Recycle	Creates a job that sends the app instance to the recycle bin.
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. （从 ClientObject 继承。）
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. （从 ClientObject 继承。）
	Restore	Creates a job that restores the app instance from the recycle bin to the installed state.
	Retrieve()	Retrieves all scalar properties associated with the object. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 ClientObject 继承。）
	Retrieve([])	Retrieves the specified scalar properties associated with the object. 此成员仅供内部使用，不能直接在您的代码中使用。 （从 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	Updates the client object property's value to have correct type by using the type information returned from the server. （从 ClientObject 继承。）
	Upgrade	Uploads a version of an app, and then upgrades the app instance to that version.

页首

另请参阅

引用

AppInstance 类

Microsoft.SharePoint.Client 命名空间