Windows SharePoint Services Provider API
This section provides the details of the application programming interface (API) for the Microsoft Windows SharePoint Services Provider included with the Microsoft Provisioning System (MPS) in the .
Overview
The procedures in Windows SharePoint Provider namespace help the Service Provider to integrate Windows SharePoint Services with the other services provisioned by MPS.
The Windows SharePoint Services Provider will provide functionality through MPS that will enable day to day operations in Windows SharePoint Services after the Server has been initially configured.
Important
Windows SharePoint Provider namespace occasionally demands that Extensible Markup Language (XML) elements be in exactly the order shown in the samples, and may produce unpredictable failures due to out-of-order elements.
Important
The SharePoint Provider namespace fails untrusted requests that do not have associated credentials. The provider requires that the sendCredentials parameter be set to true when the provider and the client are on separate servers.
Public Methods
Public Method | Description |
---|---|
Adds a cross-site group to Windows SharePoint Services. Fails if the group already exists. Rollback deletes the group. |
|
Adds a cross-site group to the specified role (site group). This method implements rollback. |
|
Adds one or more user accounts to the specified cross-site group. This call implements rollback. |
|
Adds one or more user accounts to the specified site group. This call implements rollback. |
|
Creates and enables a Microsoft SharePoint site on the specified server. |
|
Removes a Microsoft SharePoint site of the type create with CreateSite above. |
|
Returns information about the files and folders within a folder on a SharePoint site. |
|
Returns the titles and URLs of all sites within the current site collection. |
|
Returns information about the collection of users for the current site. |
|
Returns the URLs for all attachments to a specified item in a SharePoint list. |
|
Returns information about one or more specified cross-site groups in the current site collection. |
|
Returns information about the collection of cross-site groups assigned to the specified site group. |
|
Returns information about the collection of cross-site groups for the current site collection. |
|
Returns information about the collection of cross-site groups of which the specified user is a member. |
|
Returns information about the collection of cross-site groups for the current site. |
|
Returns a list of the SharePoint sites that exist under the specified virtual server. |
|
Returns metadata from the specified SharePoint list. |
|
Returns information about all the lists in the current SharePoint site. |
|
Returns the collection of list template definitions for the current site. |
|
Returns the collection of permissions for a site or list. |
|
Returns information about the specified collection of site groups for the current site. |
|
Returns information about the collection of site groups of which the specified cross-site group is a member. |
|
Returns information about the collection of site groups of which the specified user is a member. |
|
Returns information about the collection of site groups for the current site. |
|
Returns site metadata, information about the subsites in the current site collection, and information about the cross-site groups on the site and about the users who are members of each group. |
|
Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL. |
|
Returns information about the collection of site definitions and site templates on the virtual server. |
|
Returns information about a collection of one or more users based on the specified user names. |
|
Returns one or more user names based on the specified e-mail address. |
|
Returns information about the collection of users in the specified site group. |
|
Removes the specified users from the current site collection. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead. |
|
Removes the specified user from the current site. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead. |
|
Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site. |
|
Returns properties of a collection of sites (for example, name, description, and theme). |
|
Performs a query against the specified SharePoint list. |
|
Refreshes the configuration cache for the virtual server. |
|
Removes the specified cross-site group from the current site collection. |
|
Removes a cross-site group from the specified site group. This method implements rollback. |
|
Removes the specified site group from the current site. Rollback is not supported. |
|
Removes the users with the specified user names from the cross-site group. This call implements rollback. |
|
Removes the users with the specified user names from the specified site group. This call implements rollback. |
|
Removes the specified users from the current site collection. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead. |
|
Removes the specified user from the current site. This call does not implement rollback. Use RemoveUserFromGroup or RemoveUserFromRole instead. |
|
Adds, modifies, or removes permissions to the list for the specified collection of existing users, site groups, and/or cross-site groups. |
|
Modifies site-level permissions for the specified collection of existing site groups. |
|
Updates information for the specified cross-site group. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback. |
|
Updates information for the specified site group. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback. |
|
Updates information for the specified user. The underlying Windows SharePoint Services API does not provide a mechanism for updating any subset of these parameters, so all of them must be supplied. This method supports rollback. |
|
Returns the URL of the parent site for the specified page URL. |
Applies To
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0
Windows-based Hosting version 4.5
Windows-based Hosting version 4.0
Windows-based Hosting version 3.5
Windows-based Hosting for Applications version 1.0